MeshLib Python Docs
Loading...
Searching...
No Matches
Public Member Functions | List of all members
meshlib.mrmeshpy.FeatureObject Class Reference
+ Inheritance diagram for meshlib.mrmeshpy.FeatureObject:

Public Member Functions

std_vector_FeatureObjectSharedProperty getAllSharedProperties (self)
 
std_vector_ViewportMask getAllVisualizeProperties (self)
 
Vector3f getBasePoint (self, ViewportId id='MR::ViewportId{}')
 
Color getDecorationsColor (self, bool selected, ViewportId viewportId='MR::ViewportId{}', bool_output isDef=None)
 
ViewportProperty_Color getDecorationsColorForAllViewports (self, bool selected)
 
float getLineWidth (self)
 
float getMainFeatureAlpha (self)
 
Vector3f getNormal (self, Vector3f point)
 
float getPointSize (self)
 
Matrix3f getRotationMatrix (self, ViewportId id='MR::ViewportId{}', bool_output isDef=None)
 
Matrix3f getScaleShearMatrix (self, ViewportId id='MR::ViewportId{}', bool_output isDef=None)
 
float getSubfeatureAlphaLines (self)
 
float getSubfeatureAlphaMesh (self)
 
float getSubfeatureAlphaPoints (self)
 
float getSubfeatureLineWidth (self)
 
float getSubfeaturePointSize (self)
 
ViewportMask getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
 
FeatureObjectProjectPointResult projectPoint (self, Vector3f point, ViewportId id='MR::ViewportId{}')
 
None resetXf (self, ViewportId id='MR::ViewportId{}')
 
None setDecorationsColor (self, Color color, bool selected, ViewportId viewportId='MR::ViewportId{}')
 
None setDecorationsColorForAllViewports (self, ViewportProperty_Color val, bool selected)
 
None setLineWidth (self, float lineWidth)
 
None setMainFeatureAlpha (self, float alpha)
 
None setPointSize (self, float pointSize)
 
None setSubfeatureAlphaLines (self, float alpha)
 
None setSubfeatureAlphaMesh (self, float alpha)
 
None setSubfeatureAlphaPoints (self, float alpha)
 
None setSubfeatureLineWidth (self, float lineWidth)
 
None setSubfeaturePointSize (self, float pointSize)
 
None setXf (self, AffineXf3f xf, ViewportId id='MR::ViewportId{}')
 
bool supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
 
- Public Member Functions inherited from meshlib.mrmeshpy.VisualObject
None __init__ (self)
 
Object clone (self)
 
None copyColors (self, VisualObject src, VertMap thisToSrc, FaceMap thisToSrcFaces='MR::FaceMap{}')
 
float getAmbientStrength (self)
 
Color getBackColor (self, ViewportId viewportId='MR::ViewportId{}')
 
ViewportProperty_Color getBackColorsForAllViewports (self)
 
Box3f getBoundingBox (self)
 
str getClassName (self)
 
ColoringType getColoringType (self)
 
int getDirtyFlags (self)
 
Color getFrontColor (self, bool selected=True, ViewportId viewportId='MR::ViewportId{}')
 
ViewportProperty_Color getFrontColorsForAllViewports (self, bool selected=True)
 
int getGlobalAlpha (self, ViewportId viewportId='MR::ViewportId{}')
 
ViewportProperty_unsigned_char getGlobalAlphaForAllViewports (self)
 
std_vector_std_string getInfoLines (self)
 
std_vector_PositionedText getLabels (self)
 
Color getLabelsColor (self, ViewportId viewportId='MR::ViewportId{}')
 
ViewportProperty_Color getLabelsColorsForAllViewports (self)
 
bool getRedrawFlag (self, ViewportMask viewportMask)
 
float getShininess (self)
 
float getSpecularStrength (self)
 
VertColors getVertsColorMap (self)
 
bool getVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
 
int heapBytes (self)
 
bool isPickable (self, ViewportMask viewportMask='ViewportMask::any()')
 
None renderUi (self, UiRenderParams params)
 
None resetDirty (self)
 
None setAllVisualizeProperties (self, std_vector_ViewportMask properties)
 
None setAmbientStrength (self, float ambientStrength)
 
None setBackColor (self, Color color, ViewportId viewportId='MR::ViewportId{}')
 
None setBackColorsForAllViewports (self, ViewportProperty_Color val)
 
None setColoringType (self, ColoringType coloringType)
 
None setDirtyFlags (self, int mask, bool invalidateCaches=True)
 
None setFrontColor (self, Color color, bool selected, ViewportId viewportId='MR::ViewportId{}')
 
None setFrontColorsForAllViewports (self, ViewportProperty_Color val, bool selected=True)
 
None setGlobalAlpha (self, int alpha, ViewportId viewportId='MR::ViewportId{}')
 
None setGlobalAlphaForAllViewports (self, ViewportProperty_unsigned_char val)
 
None setLabels (self, std_vector_PositionedText labels)
 
None setLabelsColor (self, Color color, ViewportId viewportId='MR::ViewportId{}')
 
None setLabelsColorsForAllViewports (self, ViewportProperty_Color val)
 
None setPickable (self, bool on, ViewportMask viewportMask='ViewportMask::all()')
 
None setShininess (self, float shininess)
 
None setSpecularStrength (self, float specularStrength)
 
None setUseDefaultScenePropertiesOnDeserialization (self, bool useDefaultScenePropertiesOnDeserialization)
 
None setVertsColorMap (self, VertColors vertsColorMap)
 
None setVisualizeProperty (self, bool value, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
 
None setVisualizePropertyMask (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
 
Object shallowClone (self)
 
None showLabels (self, bool on)
 
bool showLabels (self)
 
None showName (self, bool on)
 
bool showName (self)
 
None toggleVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
 
str typeName (self)
 
None updateVertsColorMap (self, VertColors vertsColorMap)
 
bool useDefaultScenePropertiesOnDeserialization (self)
 
- Public Member Functions inherited from meshlib.mrmeshpy.Object
bool addChild (self, Object child, bool recognizedChild=True)
 
bool addChildBefore (self, Object newChild, Object existingChild)
 
None applyScale (self, float scaleFactor)
 
VisualObject asType_VisualObject (self)
 
VisualObject asType_VisualObject (self)
 
std_vector_std_shared_ptr_Object children (self)
 
std_vector_std_shared_ptr_Object_const children (self)
 
Object cloneTree (self)
 
bool detachFromParent (self)
 
Object find (self, str name)
 
Object find (self, str name)
 
Object findCommonAncestor (self, Object other)
 
Object findCommonAncestor (self, Object other)
 
bool globalVisibility (self, ViewportMask viewportMask='ViewportMask::any()')
 
ViewportMask globalVisibilityMask (self)
 
bool hasModel (self)
 
bool hasVisualRepresentation (self)
 
bool isAncestor (self, Object ancestor)
 
bool isAncillary (self)
 
bool isLocked (self)
 
bool isParentLocked (self)
 
bool isSelected (self)
 
bool isVisible (self, ViewportMask viewportMask='ViewportMask::any()')
 
str name (self)
 
Object parent (self)
 
Object parent (self)
 
None removeAllChildren (self)
 
bool removeChild (self, Object child)
 
bool removeChild (self, Object child)
 
None resetRedrawFlag (self)
 
bool select (self, bool on)
 
None setAncillary (self, bool ancillary)
 
None setGlobalVisibility (self, bool on, ViewportMask viewportMask='ViewportMask::any()')
 
None setLocked (self, bool on)
 
None setName (self, str name)
 
None setParentLocked (self, bool lock)
 
None setVisibilityMask (self, ViewportMask viewportMask)
 
None setVisible (self, bool on, ViewportMask viewportMask='ViewportMask::all()')
 
None setWorldXf (self, AffineXf3f xf, ViewportId id='MR::ViewportId{}')
 
None setXfsForAllViewports (self, ViewportProperty_AffineXf3f xf)
 
Object shallowCloneTree (self)
 
None sortChildren (self)
 
None swap (self, Object other)
 
ViewportMask visibilityMask (self)
 
AffineXf3f worldXf (self, ViewportId id='MR::ViewportId{}', bool_output isDef=None)
 
AffineXf3f xf (self, ViewportId id='MR::ViewportId{}', bool_output isDef=None)
 
ViewportProperty_AffineXf3f xfsForAllViewports (self)
 
- Public Member Functions inherited from meshlib.mrmeshpy.ObjectChildrenHolder
Object getSharedPtr (self)
 

Additional Inherited Members

- Static Public Member Functions inherited from meshlib.mrmeshpy.VisualObject
str TypeName ()
 
Box3f getWorldBox (*args, **kwargs)
 
bool render (*args, **kwargs)
 
None renderForPicker (*args, **kwargs)
 
- Static Public Member Functions inherited from meshlib.mrmeshpy.Object
Box3f getWorldTreeBox (*args, **kwargs)
 
- Static Protected Member Functions inherited from meshlib.mrmeshpy.ObjectChildrenHolder
ObjectChildrenHolder _Equal (*args, **kwargs)
 
ObjectChildrenHolder _Equal (*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

◆ getAllSharedProperties()

std_vector_FeatureObjectSharedProperty meshlib.mrmeshpy.FeatureObject.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 meshlib.mrmeshpy.CircleObject, meshlib.mrmeshpy.ConeObject, meshlib.mrmeshpy.CylinderObject, meshlib.mrmeshpy.LineObject, meshlib.mrmeshpy.PlaneObject, meshlib.mrmeshpy.PointObject, and meshlib.mrmeshpy.SphereObject.

◆ getAllVisualizeProperties()

std_vector_ViewportMask meshlib.mrmeshpy.FeatureObject.getAllVisualizeProperties ( self) 
get all visualize properties masks

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter, meshlib.mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_angle_DimensionsVisualizePropertyType_length, and meshlib.mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_length.

◆ getBasePoint()

Vector3f meshlib.mrmeshpy.FeatureObject.getBasePoint ( self,
ViewportId id = 'MR::ViewportId{}' ) 
Returns point considered as base for the feature

Reimplemented in meshlib.mrmeshpy.ConeObject, meshlib.mrmeshpy.CylinderObject, meshlib.mrmeshpy.LineObject, and meshlib.mrmeshpy.PlaneObject.

◆ getDecorationsColor()

Color meshlib.mrmeshpy.FeatureObject.getDecorationsColor ( self,
bool selected,
ViewportId viewportId = 'MR::ViewportId{}',
bool_output isDef = None ) 
This color is used for subfeatures.
`isDef` receives false if matrix is overridden for this specific viewport.

◆ getDecorationsColorForAllViewports()

ViewportProperty_Color meshlib.mrmeshpy.FeatureObject.getDecorationsColorForAllViewports ( self,
bool selected )

◆ getLineWidth()

float meshlib.mrmeshpy.FeatureObject.getLineWidth ( self)

◆ getMainFeatureAlpha()

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

◆ getNormal()

Vector3f meshlib.mrmeshpy.FeatureObject.getNormal ( self,
Vector3f point )

Reimplemented in meshlib.mrmeshpy.CircleObject, and meshlib.mrmeshpy.PlaneObject.

◆ getPointSize()

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

◆ getRotationMatrix()

Matrix3f meshlib.mrmeshpy.FeatureObject.getRotationMatrix ( self,
ViewportId id = 'MR::ViewportId{}',
bool_output isDef = None ) 
The cached orthonormalized rotation matrix.
`isDef` receives false if matrix is overridden for this specific viewport.

◆ getScaleShearMatrix()

Matrix3f meshlib.mrmeshpy.FeatureObject.getScaleShearMatrix ( self,
ViewportId id = 'MR::ViewportId{}',
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 meshlib.mrmeshpy.FeatureObject.getSubfeatureAlphaLines ( self)

◆ getSubfeatureAlphaMesh()

float meshlib.mrmeshpy.FeatureObject.getSubfeatureAlphaMesh ( self)

◆ getSubfeatureAlphaPoints()

float meshlib.mrmeshpy.FeatureObject.getSubfeatureAlphaPoints ( self)

◆ getSubfeatureLineWidth()

float meshlib.mrmeshpy.FeatureObject.getSubfeatureLineWidth ( self)

◆ getSubfeaturePointSize()

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

◆ getVisualizePropertyMask()

ViewportMask meshlib.mrmeshpy.FeatureObject.getVisualizePropertyMask ( self,
AnyVisualizeMaskEnum type ) 
returns mask of viewports where given property is set

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter, meshlib.mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_angle_DimensionsVisualizePropertyType_length, and meshlib.mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_length.

◆ projectPoint()

FeatureObjectProjectPointResult meshlib.mrmeshpy.FeatureObject.projectPoint ( self,
Vector3f point,
ViewportId id = 'MR::ViewportId{}' ) 
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 meshlib.mrmeshpy.CircleObject, meshlib.mrmeshpy.ConeObject, meshlib.mrmeshpy.CylinderObject, meshlib.mrmeshpy.LineObject, meshlib.mrmeshpy.PlaneObject, meshlib.mrmeshpy.PointObject, and meshlib.mrmeshpy.SphereObject.

◆ resetXf()

None meshlib.mrmeshpy.FeatureObject.resetXf ( self,
ViewportId id = 'MR::ViewportId{}' ) 
forgets specific transform in given viewport (or forgets all specific transforms for {} input)

Reimplemented from meshlib.mrmeshpy.Object.

◆ setDecorationsColor()

None meshlib.mrmeshpy.FeatureObject.setDecorationsColor ( self,
Color color,
bool selected,
ViewportId viewportId = 'MR::ViewportId{}' )

◆ setDecorationsColorForAllViewports()

None meshlib.mrmeshpy.FeatureObject.setDecorationsColorForAllViewports ( self,
ViewportProperty_Color val,
bool selected )

◆ setLineWidth()

None meshlib.mrmeshpy.FeatureObject.setLineWidth ( self,
float lineWidth )

◆ setMainFeatureAlpha()

None meshlib.mrmeshpy.FeatureObject.setMainFeatureAlpha ( self,
float alpha )

◆ setPointSize()

None meshlib.mrmeshpy.FeatureObject.setPointSize ( self,
float pointSize )

◆ setSubfeatureAlphaLines()

None meshlib.mrmeshpy.FeatureObject.setSubfeatureAlphaLines ( self,
float alpha )

◆ setSubfeatureAlphaMesh()

None meshlib.mrmeshpy.FeatureObject.setSubfeatureAlphaMesh ( self,
float alpha )

◆ setSubfeatureAlphaPoints()

None meshlib.mrmeshpy.FeatureObject.setSubfeatureAlphaPoints ( self,
float alpha )

◆ setSubfeatureLineWidth()

None meshlib.mrmeshpy.FeatureObject.setSubfeatureLineWidth ( self,
float lineWidth )

◆ setSubfeaturePointSize()

None meshlib.mrmeshpy.FeatureObject.setSubfeaturePointSize ( self,
float pointSize )

◆ setXf()

None meshlib.mrmeshpy.FeatureObject.setXf ( self,
AffineXf3f xf,
ViewportId id = 'MR::ViewportId{}' )

Reimplemented from meshlib.mrmeshpy.Object.

◆ supportsVisualizeProperty()

bool meshlib.mrmeshpy.FeatureObject.supportsVisualizeProperty ( self,
AnyVisualizeMaskEnum type ) 
Returns true if this class supports the property `type`. Otherwise passing it to the functions below is illegal.

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter, meshlib.mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_angle_DimensionsVisualizePropertyType_length, and meshlib.mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_length.

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