MeshLib Python Docs
Loading...
Searching...
No Matches
mrmeshpy.ConstFeatureObject Class Reference
Inheritance diagram for mrmeshpy.ConstFeatureObject:

Public Member Functions

str className (self)
str classNameInPlural (self)
Const_std_vector_FeatureObjectSharedProperty getAllSharedProperties (self)
std_vector_ViewportMask getAllVisualizeProperties (self)
Vector3f getBasePoint (self, ConstViewportId id=...)
ConstColor getDecorationsColor (self, bool selected, ConstViewportId viewportId=..., bool_output isDef=None)
ConstViewportProperty_Color getDecorationsColorForAllViewports (self, bool selected)
float getLineWidth (self)
float getMainFeatureAlpha (self)
Vector3f getNormal (self, ConstVector3f point)
float getPointSize (self)
Matrix3f getRotationMatrix (self, ConstViewportId id=..., bool_output isDef=None)
Matrix3f getScaleShearMatrix (self, ConstViewportId id=..., bool_output isDef=None)
float getSubfeatureAlphaLines (self)
float getSubfeatureAlphaMesh (self)
float getSubfeatureAlphaPoints (self)
float getSubfeatureLineWidth (self)
float getSubfeaturePointSize (self)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
FeatureObjectProjectPointResult projectPoint (self, ConstVector3f point, ConstViewportId id=...)
bool supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
str typeName (self)
Public Member Functions inherited from mrmeshpy.ConstVisualObject
 __init__ (self, *args, **kwargs)
Object clone (self)
float getAmbientStrength (self)
ConstColor getBackColor (self, ConstViewportId viewportId=...)
ConstViewportProperty_Color getBackColorsForAllViewports (self)
Box3f getBoundingBox (self)
ColoringType getColoringType (self)
int getDirtyFlags (self)
ConstColor getFrontColor (self, bool selected=True, ConstViewportId viewportId=...)
ConstViewportProperty_Color getFrontColorsForAllViewports (self, bool selected=True)
int getGlobalAlpha (self, ConstViewportId viewportId=...)
ConstViewportProperty_unsigned_char getGlobalAlphaForAllViewports (self)
std_vector_std_string getInfoLines (self)
bool getRedrawFlag (self, ConstViewportMask viewportMask)
float getShininess (self)
float getSpecularStrength (self)
bool getVisualizeProperty (self, ConstAnyVisualizeMaskEnum type, ConstViewportMask viewportMask)
bool globalClippedByPlane (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalClippedByPlaneMask (self)
int heapBytes (self)
bool isPickable (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
None renderUi (self, ConstUiRenderParams params)
None resetDirty (self)
None resetDirtyExceptMask (self, int mask)
Object shallowClone (self)
bool showName (self)
bool useDefaultScenePropertiesOnDeserialization (self)
Public Member Functions inherited from mrmeshpy.ConstObject
 __init__ (self, *args, **kwargs)
ConstVisualObject asType (self)
Const_std_vector_std_shared_ptr_Object_const children (self)
Object cloneTree (self)
ConstChildren constChildren (self)
ConstObject find (self, str name)
ConstObject findCommonAncestor (self, ConstObject other)
int getModelHash (self)
bool globalVisibility (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalVisibilityMask (self)
bool hasModel (self)
bool hasVisualRepresentation (self)
bool isAncestor (self, ConstObject ancestor)
bool isAncillary (self)
bool isGlobalAncillary (self)
bool isLocked (self)
bool isParentLocked (self)
bool isSelected (self)
bool isVisible (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
str name (self)
ConstObject parent (self)
None resetRedrawFlag (self)
bool sameModels (self, ConstObject other)
Object shallowCloneTree (self)
Const_std_set_std_string tags (self)
ViewportMask visibilityMask (self)
AffineXf3f worldXf (self, ConstViewportId id=..., bool_output isDef=None)
ConstAffineXf3f xf (self, ConstViewportId id=..., bool_output isDef=None)
ConstViewportProperty_AffineXf3f xfsForAllViewports (self)
Public Member Functions inherited from mrmeshpy.ConstObjectChildrenHolder
 __init__ (self, *args, **kwargs)
Object getSharedPtr (self)

Static Public Member Functions

str StaticClassName ()
str StaticClassNameInPlural ()
str StaticTypeName ()
Static Public Member Functions inherited from mrmeshpy.ConstVisualObject
Box3f getWorldBox (*args, **kwargs)
bool render (*args, **kwargs)
None renderForPicker (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.ConstObject
Box3f getWorldTreeBox (*args, **kwargs)

Detailed Description

Generated from:  MR::FeatureObject

An interface class which allows feature objects to share setters and getters on their main properties, for convenient presentation in the UI

Member Function Documentation

◆ className()

◆ classNameInPlural()

◆ getAllSharedProperties()

Const_std_vector_FeatureObjectSharedProperty mrmeshpy.ConstFeatureObject.getAllSharedProperties ( self)
Create and generate list of bounded getters and setters for the main properties of feature object, together with prop. name for display and edit into UI.

Reimplemented in mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointObject, and mrmeshpy.ConstSphereObject.

◆ getAllVisualizeProperties()

◆ getBasePoint()

Vector3f mrmeshpy.ConstFeatureObject.getBasePoint ( self,
ConstViewportId id = ... )
Returns point considered as base for the feature

Reimplemented in mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstLineObject, and mrmeshpy.ConstPlaneObject.

◆ getDecorationsColor()

ConstColor mrmeshpy.ConstFeatureObject.getDecorationsColor ( self,
bool selected,
ConstViewportId viewportId = ...,
bool_output isDef = None )
This color is used for subfeatures.
`isDef` receives false if matrix is overridden for this specific viewport.

◆ getDecorationsColorForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstFeatureObject.getDecorationsColorForAllViewports ( self,
bool selected )

◆ getLineWidth()

float mrmeshpy.ConstFeatureObject.getLineWidth ( self)

◆ getMainFeatureAlpha()

float mrmeshpy.ConstFeatureObject.getMainFeatureAlpha ( self)
Per-component alpha multipliers. The global alpha is multiplied by thise.

◆ getNormal()

Vector3f mrmeshpy.ConstFeatureObject.getNormal ( self,
ConstVector3f point )

◆ getPointSize()

float mrmeshpy.ConstFeatureObject.getPointSize ( self)
Point size and line width, for primary rendering rather than subfeatures.

◆ getRotationMatrix()

Matrix3f mrmeshpy.ConstFeatureObject.getRotationMatrix ( self,
ConstViewportId id = ...,
bool_output isDef = None )
The cached orthonormalized rotation matrix.
`isDef` receives false if matrix is overridden for this specific viewport.

◆ getScaleShearMatrix()

Matrix3f mrmeshpy.ConstFeatureObject.getScaleShearMatrix ( self,
ConstViewportId id = ...,
bool_output isDef = None )
The cached scale and shear matrix. The main diagnoal stores the scale, and some other elements store the shearing.
`isDef` receives false if matrix is overridden for this specific viewport.

◆ getSubfeatureAlphaLines()

float mrmeshpy.ConstFeatureObject.getSubfeatureAlphaLines ( self)

◆ getSubfeatureAlphaMesh()

float mrmeshpy.ConstFeatureObject.getSubfeatureAlphaMesh ( self)

◆ getSubfeatureAlphaPoints()

float mrmeshpy.ConstFeatureObject.getSubfeatureAlphaPoints ( self)

◆ getSubfeatureLineWidth()

float mrmeshpy.ConstFeatureObject.getSubfeatureLineWidth ( self)

◆ getSubfeaturePointSize()

float mrmeshpy.ConstFeatureObject.getSubfeaturePointSize ( self)
Point size and line width, for subfeatures rather than primary rendering.

◆ getVisualizePropertyMask()

◆ projectPoint()

FeatureObjectProjectPointResult mrmeshpy.ConstFeatureObject.projectPoint ( self,
ConstVector3f point,
ConstViewportId id = ... )
Since a point on an abstract feature is difficult to uniquely parameterize,
the projection function simultaneously returns the normal to the surface at the projection point.

Reimplemented in mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointObject, and mrmeshpy.ConstSphereObject.

◆ StaticClassName()

str mrmeshpy.ConstFeatureObject.StaticClassName ( )
static

◆ StaticClassNameInPlural()

str mrmeshpy.ConstFeatureObject.StaticClassNameInPlural ( )
static

◆ StaticTypeName()

str mrmeshpy.ConstFeatureObject.StaticTypeName ( )
static

◆ supportsVisualizeProperty()

◆ typeName()


The documentation for this class was generated from the following file: