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

Public Member Functions

 __init__ (self, *args, **kwargs)
str actualSerializeFormat (self)
float avgEdgeLen (self)
Object clone (self)
ConstUndirectedEdgeBitSet creases (self)
ConstObjectMeshData data (self)
bool flatShading (self)
std_vector_ViewportMask getAllVisualizeProperties (self)
ConstMeshTexture getAncillaryTexture (self)
ConstVertCoords2 getAncillaryUVCoords (self)
ConstColor getBordersColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getBordersColorsForAllViewports (self)
float getEdgeWidth (self)
ConstColor getEdgesColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getEdgesColorsForAllViewports (self)
ConstFaceColors getFacesColorMap (self)
int getModelHash (self)
float getPointSize (self)
ConstColor getPointsColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getPointsColorsForAllViewports (self)
bool getRedrawFlag (self, ConstViewportMask viewportMask)
ConstUndirectedEdgeBitSet getSelectedEdges (self)
ConstColor getSelectedEdgesColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getSelectedEdgesColorsForAllViewports (self)
ConstFaceBitSet getSelectedFaces (self)
ConstColor getSelectedFacesColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getSelectedFacesColorsForAllViewports (self)
ConstMeshTexture getTexture (self)
ConstTexturePerFace getTexturePerFace (self)
ConstVector_MeshTexture_TextureId getTextures (self)
ConstVertCoords2 getUVCoords (self)
ConstVertColors getVertsColorMap (self)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
bool hasAncillaryTexture (self)
bool hasModel (self)
bool hasVisualRepresentation (self)
int heapBytes (self)
bool isMeshClosed (self)
ConstMesh mesh (self)
MeshPart meshPart (self)
ConstMesh meshPtr (self)
int numComponents (self)
int numCreaseEdges (self)
int numHandles (self)
int numHoles (self)
int numSelectedEdges (self)
int numSelectedFaces (self)
int numUndirectedEdges (self)
bool sameModels (self, ConstObject other)
float selectedArea (self)
str serializeFormat (self)
Object shallowClone (self)
bool supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
float totalArea (self)
str typeName (self)
float volume (self)
Public Member Functions inherited from mrmeshpy.ConstVisualObject
 __init__ (self, *args, **kwargs)
str className (self)
str classNameInPlural (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)
float getShininess (self)
float getSpecularStrength (self)
bool getVisualizeProperty (self, ConstAnyVisualizeMaskEnum type, ConstViewportMask viewportMask)
bool globalClippedByPlane (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalClippedByPlaneMask (self)
bool isPickable (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
None renderUi (self, ConstUiRenderParams params)
None resetDirty (self)
None resetDirtyExceptMask (self, int mask)
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)
bool globalVisibility (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalVisibilityMask (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)
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 StaticTypeName ()
Box3f getWorldBox (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.ConstVisualObject
str StaticClassName ()
str StaticClassNameInPlural ()
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::ObjectMeshHolder
Aliases:  ChangeFacesColorMapAction.Obj, ChangeMeshTexturePerFaceAction.Obj, ChangeMeshUVCoordsAction.Obj, ChangeTextureAction.Obj, std_shared_ptr_ObjectMeshHolder

an object that stores a mesh

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ actualSerializeFormat()

str mrmeshpy.ConstObjectMeshHolder.actualSerializeFormat ( self)
returns overriden file extension used to serialize mesh inside this object if set, or SceneSettings::get( SceneSettings::StringType::MeshSerializeFormat ) otherwise; never returns nullptr

◆ avgEdgeLen()

float mrmeshpy.ConstObjectMeshHolder.avgEdgeLen ( self)
returns cached average edge length

◆ clone()

Object mrmeshpy.ConstObjectMeshHolder.clone ( self)
clones this object only, without its children,
making new object the owner of all copied resources

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectMesh, and mrmeshpy.ConstObjectVoxels.

◆ creases()

ConstUndirectedEdgeBitSet mrmeshpy.ConstObjectMeshHolder.creases ( self)
Edges on mesh, that will have sharp visualization even with smooth shading

◆ data()

ConstObjectMeshData mrmeshpy.ConstObjectMeshHolder.data ( self)
provides read-only access to whole ObjectMeshData

◆ flatShading()

bool mrmeshpy.ConstObjectMeshHolder.flatShading ( self)

◆ getAllVisualizeProperties()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getAncillaryTexture()

ConstMeshTexture mrmeshpy.ConstObjectMeshHolder.getAncillaryTexture ( self)
ancillary texture can be used to have custom features visualization without affecting real one

◆ getAncillaryUVCoords()

ConstVertCoords2 mrmeshpy.ConstObjectMeshHolder.getAncillaryUVCoords ( self)

◆ getBordersColor()

ConstColor mrmeshpy.ConstObjectMeshHolder.getBordersColor ( self,
ConstViewportId id = ... )

◆ getBordersColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstObjectMeshHolder.getBordersColorsForAllViewports ( self)

◆ getEdgesColor()

ConstColor mrmeshpy.ConstObjectMeshHolder.getEdgesColor ( self,
ConstViewportId id = ... )

◆ getEdgesColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstObjectMeshHolder.getEdgesColorsForAllViewports ( self)

◆ getEdgeWidth()

float mrmeshpy.ConstObjectMeshHolder.getEdgeWidth ( self)

◆ getFacesColorMap()

ConstFaceColors mrmeshpy.ConstObjectMeshHolder.getFacesColorMap ( self)

◆ getModelHash()

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

Reimplemented from mrmeshpy.ConstObject.

◆ getPointsColor()

ConstColor mrmeshpy.ConstObjectMeshHolder.getPointsColor ( self,
ConstViewportId id = ... )

◆ getPointsColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstObjectMeshHolder.getPointsColorsForAllViewports ( self)

◆ getPointSize()

float mrmeshpy.ConstObjectMeshHolder.getPointSize ( self)

◆ getRedrawFlag()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getSelectedEdges()

ConstUndirectedEdgeBitSet mrmeshpy.ConstObjectMeshHolder.getSelectedEdges ( self)

◆ getSelectedEdgesColor()

ConstColor mrmeshpy.ConstObjectMeshHolder.getSelectedEdgesColor ( self,
ConstViewportId id = ... )
returns colors of selected edges

◆ getSelectedEdgesColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstObjectMeshHolder.getSelectedEdgesColorsForAllViewports ( self)

◆ getSelectedFaces()

ConstFaceBitSet mrmeshpy.ConstObjectMeshHolder.getSelectedFaces ( self)

◆ getSelectedFacesColor()

ConstColor mrmeshpy.ConstObjectMeshHolder.getSelectedFacesColor ( self,
ConstViewportId id = ... )
returns colors of selected triangles

◆ getSelectedFacesColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstObjectMeshHolder.getSelectedFacesColorsForAllViewports ( self)

◆ getTexture()

ConstMeshTexture mrmeshpy.ConstObjectMeshHolder.getTexture ( self)
returns first texture in the vector. If there is no textures, returns empty texture

◆ getTexturePerFace()

ConstTexturePerFace mrmeshpy.ConstObjectMeshHolder.getTexturePerFace ( self)

◆ getTextures()

ConstVector_MeshTexture_TextureId mrmeshpy.ConstObjectMeshHolder.getTextures ( self)

◆ getUVCoords()

ConstVertCoords2 mrmeshpy.ConstObjectMeshHolder.getUVCoords ( self)

◆ getVertsColorMap()

ConstVertColors mrmeshpy.ConstObjectMeshHolder.getVertsColorMap ( self)
returns per-vertex colors of the object

◆ getVisualizePropertyMask()

ConstViewportMask mrmeshpy.ConstObjectMeshHolder.getVisualizePropertyMask ( self,
ConstAnyVisualizeMaskEnum type )
returns mask of viewports where given property is set

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getWorldBox()

Box3f mrmeshpy.ConstObjectMeshHolder.getWorldBox ( * args,
** kwargs )
static
returns cached bounding box of this mesh object in world coordinates;
if you need bounding box in local coordinates please call getBoundingBox()

Reimplemented from mrmeshpy.ConstVisualObject.

◆ hasAncillaryTexture()

bool mrmeshpy.ConstObjectMeshHolder.hasAncillaryTexture ( self)

◆ hasModel()

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

Reimplemented from mrmeshpy.ConstObject.

Reimplemented in mrmeshpy.ConstObjectDistanceMap, and mrmeshpy.ConstObjectVoxels.

◆ hasVisualRepresentation()

bool mrmeshpy.ConstObjectMeshHolder.hasVisualRepresentation ( self)
mesh object can be seen if the mesh has at least one edge

Reimplemented from mrmeshpy.ConstObject.

Reimplemented in mrmeshpy.ConstObjectVoxels.

◆ heapBytes()

int mrmeshpy.ConstObjectMeshHolder.heapBytes ( self)
returns the amount of memory this object occupies on heap

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectDistanceMap, and mrmeshpy.ConstObjectVoxels.

◆ isMeshClosed()

bool mrmeshpy.ConstObjectMeshHolder.isMeshClosed ( self)
returns cached information whether the mesh is closed

◆ mesh()

ConstMesh mrmeshpy.ConstObjectMeshHolder.mesh ( self)
\\deprecated the cast inside is undefined behaviour, use meshPtr() instead

◆ meshPart()

MeshPart mrmeshpy.ConstObjectMeshHolder.meshPart ( self)
\\return the pair ( mesh, selected triangles ) if any triangle is selected or whole mesh otherwise

◆ meshPtr()

ConstMesh mrmeshpy.ConstObjectMeshHolder.meshPtr ( self)
returns the mesh of this object, or nullptr if it is not set

◆ numComponents()

int mrmeshpy.ConstObjectMeshHolder.numComponents ( self)
returns cached information about the number of components in the mesh

◆ numCreaseEdges()

int mrmeshpy.ConstObjectMeshHolder.numCreaseEdges ( self)
returns cached information about the number of crease undirected edges in the mesh

◆ numHandles()

int mrmeshpy.ConstObjectMeshHolder.numHandles ( self)
returns cached information about the number of handles in the mesh

◆ numHoles()

int mrmeshpy.ConstObjectMeshHolder.numHoles ( self)
returns cached information about the number of holes in the mesh

◆ numSelectedEdges()

int mrmeshpy.ConstObjectMeshHolder.numSelectedEdges ( self)
returns cached information about the number of selected undirected edges in the mesh

◆ numSelectedFaces()

int mrmeshpy.ConstObjectMeshHolder.numSelectedFaces ( self)
returns cached information about the number of selected faces in the mesh

◆ numUndirectedEdges()

int mrmeshpy.ConstObjectMeshHolder.numUndirectedEdges ( self)
returns cached information about the number of undirected edges in the mesh

◆ sameModels()

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

Reimplemented from mrmeshpy.ConstObject.

◆ selectedArea()

float mrmeshpy.ConstObjectMeshHolder.selectedArea ( self)
returns cached area of selected triangles

◆ serializeFormat()

str mrmeshpy.ConstObjectMeshHolder.serializeFormat ( self)
returns overriden file extension used to serialize mesh inside this object, nullptr means SceneSettings::get( SceneSettings::StringType::MeshSerializeFormat )

Reimplemented in mrmeshpy.ConstObjectVoxels.

◆ shallowClone()

Object mrmeshpy.ConstObjectMeshHolder.shallowClone ( self)
clones this object only, without its children,
making new object to share resources with this object

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectMesh, and mrmeshpy.ConstObjectVoxels.

◆ StaticTypeName()

str mrmeshpy.ConstObjectMeshHolder.StaticTypeName ( )
static
return name of subtype for serialization purposes

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectMesh, and mrmeshpy.ConstObjectVoxels.

◆ supportsVisualizeProperty()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ totalArea()

float mrmeshpy.ConstObjectMeshHolder.totalArea ( self)
returns cached summed area of mesh triangles

◆ typeName()

str mrmeshpy.ConstObjectMeshHolder.typeName ( self)

◆ volume()

float mrmeshpy.ConstObjectMeshHolder.volume ( self)
returns cached volume of space surrounded by the mesh, which is valid only if mesh is closed

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