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

Public Member Functions

 __init__ (self, *args, **kwargs)
str className (self)
str classNameInPlural (self)
Object clone (self)
std_vector_ViewportMask getAllVisualizeProperties (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)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
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 supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
str typeName (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 ()
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::VisualObject
Aliases:  ChangeColoringType.Obj, ChangeObjectColorAction.Obj, ChangeVisualizePropertyAction.Obj, std_shared_ptr_VisualObject

Visual Object

Constructor & Destructor Documentation

◆ __init__()

mrmeshpy.ConstVisualObject.__init__ ( self,
* args,
** kwargs )
__init__(self: meshlib.mrmeshpy.ConstVisualObject) -> None

Member Function Documentation

◆ className()

◆ classNameInPlural()

◆ clone()

◆ getAllVisualizeProperties()

◆ getAmbientStrength()

float mrmeshpy.ConstVisualObject.getAmbientStrength ( self)
returns intensity of non-directional light

◆ getBackColor()

ConstColor mrmeshpy.ConstVisualObject.getBackColor ( self,
ConstViewportId viewportId = ... )
returns backward color of object in given viewport

◆ getBackColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstVisualObject.getBackColorsForAllViewports ( self)
returns backward color of object in all viewports

◆ getBoundingBox()

Box3f mrmeshpy.ConstVisualObject.getBoundingBox ( self)
returns cached bounding box of this object in local coordinates

◆ getColoringType()

ColoringType mrmeshpy.ConstVisualObject.getColoringType ( self)
returns the current coloring mode of the object

◆ getDirtyFlags()

int mrmeshpy.ConstVisualObject.getDirtyFlags ( self)
returns current dirty flags for the object

◆ getFrontColor()

ConstColor mrmeshpy.ConstVisualObject.getFrontColor ( self,
bool selected = True,
ConstViewportId viewportId = ... )
returns color of object when it is selected/not-selected (depending on argument) in given viewport

◆ getFrontColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstVisualObject.getFrontColorsForAllViewports ( self,
bool selected = True )
returns color of object when it is selected/not-selected (depending on argument) in all viewports

◆ getGlobalAlpha()

int mrmeshpy.ConstVisualObject.getGlobalAlpha ( self,
ConstViewportId viewportId = ... )
returns global transparency alpha of object in given viewport

◆ getGlobalAlphaForAllViewports()

ConstViewportProperty_unsigned_char mrmeshpy.ConstVisualObject.getGlobalAlphaForAllViewports ( self)
returns global transparency alpha of object in all viewports

◆ getInfoLines()

◆ getRedrawFlag()

bool mrmeshpy.ConstVisualObject.getRedrawFlag ( self,
ConstViewportMask viewportMask )
returns true if the object must be redrawn (due to dirty flags) in one of specified viewports

Reimplemented from mrmeshpy.ConstObject.

Reimplemented in mrmeshpy.ConstObjectMeshHolder.

◆ getShininess()

float mrmeshpy.ConstVisualObject.getShininess ( self)
returns the current shininess visual value

◆ getSpecularStrength()

float mrmeshpy.ConstVisualObject.getSpecularStrength ( self)
returns intensity of reflections

◆ getVisualizeProperty()

bool mrmeshpy.ConstVisualObject.getVisualizeProperty ( self,
ConstAnyVisualizeMaskEnum type,
ConstViewportMask viewportMask )
returns true if the property is set at least in one viewport specified by the mask

◆ getVisualizePropertyMask()

◆ getWorldBox()

Box3f mrmeshpy.ConstVisualObject.getWorldBox ( * args,
** kwargs )
static
returns bounding box of this object in given viewport in world coordinates,
to get world bounding box of the object with all child objects, please call Object::getWorldTreeBox method

Reimplemented from mrmeshpy.ConstObject.

Reimplemented in mrmeshpy.ConstObjectLabel, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMeshHolder, and mrmeshpy.ConstObjectPointsHolder.

◆ globalClippedByPlane()

bool mrmeshpy.ConstVisualObject.globalClippedByPlane ( self,
ConstViewportMask viewportMask = 'MR::ViewportMask::any()' )
returns true if this object or any of its parents is clipped by plane in any of given viewports

◆ globalClippedByPlaneMask()

ViewportMask mrmeshpy.ConstVisualObject.globalClippedByPlaneMask ( self)
returns all viewports where this object or any of its parents is clipped by plane

◆ heapBytes()

int mrmeshpy.ConstVisualObject.heapBytes ( self)

◆ isPickable()

bool mrmeshpy.ConstVisualObject.isPickable ( self,
ConstViewportMask viewportMask = 'MR::ViewportMask::any()' )
whether the object can be picked (by mouse) in any of given viewports

◆ render()

bool mrmeshpy.ConstVisualObject.render ( * args,
** kwargs )
static
draws this object for visualization
Returns true if something was drawn.

◆ renderForPicker()

None mrmeshpy.ConstVisualObject.renderForPicker ( * args,
** kwargs )
static
draws this object for picking

◆ renderUi()

None mrmeshpy.ConstVisualObject.renderUi ( self,
ConstUiRenderParams params )
draws this object for 2d UI

◆ resetDirty()

None mrmeshpy.ConstVisualObject.resetDirty ( self)
resets all dirty flags (except for cache flags that will be reset automatically on cache update)

◆ resetDirtyExceptMask()

None mrmeshpy.ConstVisualObject.resetDirtyExceptMask ( self,
int mask )
reset dirty flags without some specific bits (useful for lazy normals update)

◆ shallowClone()

◆ showName()

bool mrmeshpy.ConstVisualObject.showName ( self)
returns whether object name is shown in any viewport

Reimplemented in mrmeshpy.VisualObject, and mrmeshpy.VisualObject.

◆ StaticClassName()

◆ StaticClassNameInPlural()

◆ StaticTypeName()

◆ supportsVisualizeProperty()

◆ typeName()

◆ useDefaultScenePropertiesOnDeserialization()

bool mrmeshpy.ConstVisualObject.useDefaultScenePropertiesOnDeserialization ( self)
whether the scene-related properties should get their values from SceneColors and SceneSettings instances
rather than from the input data on deserialization

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