MeshLib Python Docs
Loading...
Searching...
No Matches
Inheritance diagram for mrmeshpy.ConstObject:

Public Member Functions

 __init__ (self, *args, **kwargs)
ConstVisualObject asType (self)
Const_std_vector_std_shared_ptr_Object_const children (self)
str className (self)
str classNameInPlural (self)
Object clone (self)
Object cloneTree (self)
ConstChildren constChildren (self)
ConstObject find (self, str name)
ConstObject findCommonAncestor (self, ConstObject other)
std_vector_std_string getInfoLines (self)
int getModelHash (self)
bool globalVisibility (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalVisibilityMask (self)
bool hasModel (self)
bool hasVisualRepresentation (self)
int heapBytes (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 shallowClone (self)
Object shallowCloneTree (self)
Const_std_set_std_string tags (self)
str typeName (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 ()
bool getRedrawFlag (*args, **kwargs)
Box3f getWorldBox (*args, **kwargs)
Box3f getWorldTreeBox (*args, **kwargs)

Detailed Description

Generated from:  MR::Object
Aliases:  ChangeObjectSelectedAction.Obj, ChangeObjectVisibilityAction.Obj, ObjectPtr, std_shared_ptr_Object

named object in the data model

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ asType()

ConstVisualObject mrmeshpy.ConstObject.asType ( self)

Reimplemented in mrmeshpy.Object, and mrmeshpy.Object.

◆ children()

Const_std_vector_std_shared_ptr_Object_const mrmeshpy.ConstObject.children ( self)
\\deprecated the cast inside is undefined behaviour, use constChildren() instead

Reimplemented in mrmeshpy.Object, and mrmeshpy.Object.

◆ className()

◆ classNameInPlural()

◆ clone()

◆ cloneTree()

Object mrmeshpy.ConstObject.cloneTree ( self)
clones all tree of this object (except ancillary and unrecognized children)

◆ constChildren()

ConstChildren mrmeshpy.ConstObject.constChildren ( self)
the same sub-objects without the ability to modify them; the returned view is
invalidated by anything that changes the children of this object

◆ find()

ConstObject mrmeshpy.ConstObject.find ( self,
str name )
finds a direct child by name

Reimplemented in mrmeshpy.Object, and mrmeshpy.Object.

◆ findCommonAncestor()

ConstObject mrmeshpy.ConstObject.findCommonAncestor ( self,
ConstObject other )

Reimplemented in mrmeshpy.Object, and mrmeshpy.Object.

◆ getInfoLines()

◆ getModelHash()

int mrmeshpy.ConstObject.getModelHash ( self)
return hash of model (or hash object pointer if object has no model)

Reimplemented in mrmeshpy.ConstObjectMeshHolder.

◆ getRedrawFlag()

bool mrmeshpy.ConstObject.getRedrawFlag ( * args,
** kwargs )
static
this method virtual because others data model types could have dirty flags or something

Reimplemented in mrmeshpy.ConstObjectMeshHolder, and mrmeshpy.ConstVisualObject.

◆ getWorldBox()

Box3f mrmeshpy.ConstObject.getWorldBox ( * args,
** kwargs )
static
returns bounding box of this object in world coordinates for default or specific viewport

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

◆ getWorldTreeBox()

Box3f mrmeshpy.ConstObject.getWorldTreeBox ( * args,
** kwargs )
static
returns bounding box of this object and all children visible in given (or default) viewport in world coordinates

◆ globalVisibility()

bool mrmeshpy.ConstObject.globalVisibility ( self,
ConstViewportMask viewportMask = 'MR::ViewportMask::any()' )
returns true if this object is visible together with all its parents in any of given viewports

◆ globalVisibilityMask()

ViewportMask mrmeshpy.ConstObject.globalVisibilityMask ( self)
returns all viewports where this object is visible together with all its parents

◆ hasModel()

bool mrmeshpy.ConstObject.hasModel ( self)
does the object have any model available (but possibly empty),
e.g. ObjectMesh has valid meshPtr() or ObjectPoints has valid pointCloudPtr()

Reimplemented in mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMeshHolder, mrmeshpy.ConstObjectPointsHolder, and mrmeshpy.ConstObjectVoxels.

◆ hasVisualRepresentation()

bool mrmeshpy.ConstObject.hasVisualRepresentation ( self)
does the object have any visual representation (visible points, triangles, edges, etc.), no considering child objects

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

◆ heapBytes()

◆ isAncestor()

bool mrmeshpy.ConstObject.isAncestor ( self,
ConstObject ancestor )
return true if given object is ancestor of this one, false otherwise

◆ isAncillary()

bool mrmeshpy.ConstObject.isAncillary ( self)

◆ isGlobalAncillary()

bool mrmeshpy.ConstObject.isGlobalAncillary ( self)
returns true if the object or any of its ancestors are ancillary

◆ isLocked()

bool mrmeshpy.ConstObject.isLocked ( self)
object properties lock for UI

◆ isParentLocked()

bool mrmeshpy.ConstObject.isParentLocked ( self)
If true, the scene tree GUI doesn't allow you to drag'n'drop this object into a different parent.
Defaults to false.

◆ isSelected()

bool mrmeshpy.ConstObject.isSelected ( self)

◆ isVisible()

bool mrmeshpy.ConstObject.isVisible ( self,
ConstViewportMask viewportMask = 'MR::ViewportMask::any()' )
checks whether the object is visible in any of the viewports specified by the mask (by default in any viewport)

◆ name()

str mrmeshpy.ConstObject.name ( self)

◆ parent()

ConstObject mrmeshpy.ConstObject.parent ( self)
returns parent object in the tree

Reimplemented in mrmeshpy.Object, and mrmeshpy.Object.

◆ resetRedrawFlag()

None mrmeshpy.ConstObject.resetRedrawFlag ( self)

◆ sameModels()

bool mrmeshpy.ConstObject.sameModels ( self,
ConstObject other )
return true if model of current object equals to model (the same) of other

Reimplemented in mrmeshpy.ConstObjectMeshHolder.

◆ shallowClone()

◆ shallowCloneTree()

Object mrmeshpy.ConstObject.shallowCloneTree ( self)
clones all tree of this object (except ancillary and unrecognied children)
clones only pointers to mesh, points or voxels

◆ StaticClassName()

◆ StaticClassNameInPlural()

◆ StaticTypeName()

◆ tags()

Const_std_set_std_string mrmeshpy.ConstObject.tags ( self)
provides read-only access to the tag storage
the storage is a set of unique strings

◆ typeName()

◆ visibilityMask()

ViewportMask mrmeshpy.ConstObject.visibilityMask ( self)
gets object visibility as bitmask of viewports

◆ worldXf()

AffineXf3f mrmeshpy.ConstObject.worldXf ( self,
ConstViewportId id = ...,
bool_output isDef = None )
this space to world space transformation for default or specific viewport
\\param isDef receives true if the object has default transformation in this viewport (same as worldXf() returns)

◆ xf()

ConstAffineXf3f mrmeshpy.ConstObject.xf ( self,
ConstViewportId id = ...,
bool_output isDef = None )
this space to parent space transformation (to world space if no parent) for default or given viewport
\\param isDef receives true if the object has default transformation in this viewport (same as xf() returns)

◆ xfsForAllViewports()

ConstViewportProperty_AffineXf3f mrmeshpy.ConstObject.xfsForAllViewports ( self)
returns xfs for all viewports, combined into a single object

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