mrmeshpy.ObjectMesh Class Reference

Inheritance diagram for mrmeshpy.ObjectMesh:

Public Member Functions
None	__init__ (self)
str	className (self)
str	classNameInPlural (self)
Object	clone (self)
std_vector_std_string	getInfoLines (self)
None	setDirtyFlags (self, int mask, bool invalidateCaches=True)
None	setMesh (self, Mesh mesh)
Object	shallowClone (self)
str	typeName (self)
Mesh	updateMesh (self, Mesh mesh)
Mesh	varMesh (self)
MeshIntersectionResult	worldRayIntersection (self, Line3f worldRay, FaceBitSet region=None)
Public Member Functions inherited from mrmeshpy.ObjectMeshHolder
str	actualSerializeFormat (self)
None	addTexture (self, MeshTexture texture)
None	applyScale (self, float scaleFactor)
float	avgEdgeLen (self)
None	clearAncillaryTexture (self)
None	copyColors (self, ObjectMeshHolder src, VertMap thisToSrc, FaceMap thisToSrcFaces='{}')
None	copyTextureAndColors (self, ObjectMeshHolder src, VertMap thisToSrc, FaceMap thisToSrcFaces='{}')
UndirectedEdgeBitSet	creases (self)
ObjectMeshData	data (self)
bool	flatShading (self)
std_vector_ViewportMask	getAllVisualizeProperties (self)
MeshTexture	getAncillaryTexture (self)
VertCoords2	getAncillaryUVCoords (self)
Color	getBordersColor (self, ViewportId id='{}')
ViewportProperty_Color	getBordersColorsForAllViewports (self)
float	getEdgeWidth (self)
Color	getEdgesColor (self, ViewportId id='{}')
ViewportProperty_Color	getEdgesColorsForAllViewports (self)
FaceColors	getFacesColorMap (self)
int	getNeededNormalsRenderDirtyValue (self, ViewportMask viewportMask)
float	getPointSize (self)
Color	getPointsColor (self, ViewportId id='{}')
bool	getRedrawFlag (self, ViewportMask viewportMask)
UndirectedEdgeBitSet	getSelectedEdges (self)
Color	getSelectedEdgesColor (self, ViewportId id='{}')
ViewportProperty_Color	getSelectedEdgesColorsForAllViewports (self)
FaceBitSet	getSelectedFaces (self)
Color	getSelectedFacesColor (self, ViewportId id='{}')
ViewportProperty_Color	getSelectedFacesColorsForAllViewports (self)
MeshTexture	getTexture (self)
TexturePerFace	getTexturePerFace (self)
Vector_MeshTexture_TextureId	getTextures (self)
VertCoords2	getUVCoords (self)
VertColors	getVertsColorMap (self)
ViewportMask	getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
bool	hasAncillaryTexture (self)
bool	hasModel (self)
bool	hasVisualRepresentation (self)
int	heapBytes (self)
bool	isMeshClosed (self)
Mesh	mesh (self)
MeshPart	meshPart (self)
int	numComponents (self)
int	numCreaseEdges (self)
int	numHandles (self)
int	numHoles (self)
int	numSelectedEdges (self)
int	numSelectedFaces (self)
int	numUndirectedEdges (self)
None	resetColors (self)
None	resetFrontColor (self)
None	selectEdges (self, UndirectedEdgeBitSet newSelection)
None	selectFaces (self, FaceBitSet newSelection)
float	selectedArea (self)
str	serializeFormat (self)
None	setAncillaryTexture (self, MeshTexture texture)
None	setAncillaryUVCoords (self, VertCoords2 uvCoordinates)
None	setBordersColor (self, Color color, ViewportId id='{}')
None	setBordersColorsForAllViewports (self, ViewportProperty_Color val)
None	setCreases (self, UndirectedEdgeBitSet creases)
None	setData (self, ObjectMeshData data)
None	setEdgeWidth (self, float edgeWidth)
None	setEdgesColor (self, Color color, ViewportId id='{}')
None	setEdgesColorsForAllViewports (self, ViewportProperty_Color val)
None	setFacesColorMap (self, FaceColors facesColorMap)
None	setFlatShading (self, bool on)
None	setPointSize (self, float size)
None	setPointsColor (self, Color color, ViewportId id='{}')
None	setSelectedEdgesColor (self, Color color, ViewportId id='{}')
None	setSelectedEdgesColorsForAllViewports (self, ViewportProperty_Color val)
None	setSelectedFacesColor (self, Color color, ViewportId id='{}')
None	setSelectedFacesColorsForAllViewports (self, ViewportProperty_Color val)
None	setSerializeFormat (self, str newFormat)
None	setTexturePerFace (self, TexturePerFace texturePerFace)
None	setTextures (self, Vector_MeshTexture_TextureId texture)
None	setUVCoords (self, VertCoords2 uvCoordinates)
None	setVertsColorMap (self, VertColors vertsColorMap)
bool	supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
float	totalArea (self)
None	updateAncillaryUVCoords (self, VertCoords2 updated)
None	updateData (self, ObjectMeshData data)
None	updateFacesColorMap (self, FaceColors updated)
None	updateTexturePerFace (self, TexturePerFace texturePerFace)
None	updateTextures (self, Vector_MeshTexture_TextureId updated)
None	updateUVCoords (self, VertCoords2 updated)
None	updateVertsColorMap (self, VertColors vertsColorMap)
float	volume (self)
Public Member Functions inherited from mrmeshpy.VisualObject
float	getAmbientStrength (self)
Color	getBackColor (self, ViewportId viewportId='{}')
ViewportProperty_Color	getBackColorsForAllViewports (self)
Box3f	getBoundingBox (self)
ColoringType	getColoringType (self)
int	getDirtyFlags (self)
Color	getFrontColor (self, bool selected=True, ViewportId viewportId='{}')
ViewportProperty_Color	getFrontColorsForAllViewports (self, bool selected=True)
int	getGlobalAlpha (self, ViewportId viewportId='{}')
ViewportProperty_unsigned_char	getGlobalAlphaForAllViewports (self)
float	getShininess (self)
float	getSpecularStrength (self)
bool	getVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
bool	globalClippedByPlane (self, ViewportMask viewportMask='ViewportMask::any()')
ViewportMask	globalClippedByPlaneMask (self)
bool	isPickable (self, ViewportMask viewportMask='ViewportMask::any()')
None	renderUi (self, UiRenderParams params)
None	resetDirty (self)
None	resetDirtyExceptMask (self, int mask)
None	setAllVisualizeProperties (self, std_vector_ViewportMask properties)
None	setAmbientStrength (self, float ambientStrength)
None	setBackColor (self, Color color, ViewportId viewportId='{}')
None	setBackColorsForAllViewports (self, ViewportProperty_Color val)
None	setColoringType (self, ColoringType coloringType)
None	setFrontColor (self, Color color, bool selected, ViewportId viewportId='{}')
None	setFrontColorsForAllViewports (self, ViewportProperty_Color val, bool selected=True)
None	setGlobalAlpha (self, int alpha, ViewportId viewportId='{}')
None	setGlobalAlphaForAllViewports (self, ViewportProperty_unsigned_char val)
None	setGlobalClippedByPlane (self, bool on, ViewportMask viewportMask='ViewportMask::all()')
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	setVisualizeProperty (self, bool value, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
None	setVisualizePropertyMask (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
None	showName (self, bool on)
bool	showName (self)
None	toggleVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
bool	useDefaultScenePropertiesOnDeserialization (self)
Public Member Functions inherited from mrmeshpy.Object
bool	addChild (self, Object child, bool recognizedChild=True)
bool	addChildBefore (self, Object newChild, Object existingChild)
bool	addTag (self, str tag)
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	isAncestor (self, Object ancestor)
bool	isAncillary (self)
bool	isGlobalAncillary (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)
bool	removeTag (self, str tag)
None	resetRedrawFlag (self)
None	resetXf (self, ViewportId id='{}')
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='{}')
None	setXf (self, AffineXf3f xf, ViewportId id='{}')
None	setXfsForAllViewports (self, ViewportProperty_AffineXf3f xf)
Object	shallowCloneTree (self)
None	sortChildren (self)
None	swap (self, Object other)
std_set_std_string	tags (self)
ViewportMask	visibilityMask (self)
AffineXf3f	worldXf (self, ViewportId id='{}', bool_output isDef=None)
AffineXf3f	xf (self, ViewportId id='{}', bool_output isDef=None)
ViewportProperty_AffineXf3f	xfsForAllViewports (self)
Public Member Functions inherited from mrmeshpy.ObjectChildrenHolder
Object	getSharedPtr (self)

Static Public Member Functions
str	ClassName ()
str	ClassNameInPlural ()
str	TypeName ()
	extractMesh (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.ObjectMeshHolder
Box3f	getWorldBox (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.VisualObject
bool	render (*args, **kwargs)
None	renderForPicker (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.Object
Box3f	getWorldTreeBox (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.ObjectChildrenHolder
ObjectChildrenHolder	operator (*args, **kwargs)
ObjectChildrenHolder	operator (*args, **kwargs)

Detailed Description

Generated from:  MR::ObjectMesh
Aliases:  ChangeMeshTopologyAction.Obj, ChangeMeshEdgeSelectionAction.Obj, ChangeMeshDataAction.Obj, ChangeMeshFaceSelectionAction.Obj, ChangeMeshAction.Obj, ChangeMeshCreasesAction.Obj, std_shared_ptr_ObjectMesh, ChangeMeshPointsAction.Obj

an object that stores a mesh

Constructor & Destructor Documentation

__init__()

None mrmeshpy.ObjectMesh.__init__

(

self

)

Reimplemented from mrmeshpy.ObjectMeshHolder.

Member Function Documentation

ClassName()

str mrmeshpy.ObjectMesh.ClassName ( )

static

return human readable name of subclass

Reimplemented from mrmeshpy.VisualObject.

className()

str mrmeshpy.ObjectMesh.className

(

self

)

Reimplemented from mrmeshpy.VisualObject.

ClassNameInPlural()

str mrmeshpy.ObjectMesh.ClassNameInPlural ( )

static

return human readable name of subclass in plural form

Reimplemented from mrmeshpy.VisualObject.

classNameInPlural()

str mrmeshpy.ObjectMesh.classNameInPlural

(

self

)

Reimplemented from mrmeshpy.VisualObject.

clone()

Object mrmeshpy.ObjectMesh.clone

(

self

)

clones this object only, without its children,
making new object the owner of all copied resources

Reimplemented from mrmeshpy.ObjectMeshHolder.

extractMesh()

mrmeshpy.ObjectMesh.extractMesh ( * args, ** kwargs )

static

mesh(self: meshlib.mrmeshpy.ObjectMeshHolder) -> meshlib.mrmeshpy.Mesh

getInfoLines()

std_vector_std_string mrmeshpy.ObjectMesh.getInfoLines

(

self

)

return several info lines that can better describe the object in the UI

Reimplemented from mrmeshpy.VisualObject.

setDirtyFlags()

None mrmeshpy.ObjectMesh.setDirtyFlags	(		self,
		int	mask,
		bool	invalidateCaches = True )

sets some dirty flags for the object (to force its visual update)
\\param mask is a union of DirtyFlags flags
\\param invalidateCaches whether to automatically invalidate model caches (pass false here if you manually update the caches)

Reimplemented from mrmeshpy.ObjectMeshHolder.

setMesh()

None mrmeshpy.ObjectMesh.setMesh	(		self,
		Mesh	mesh )

sets given mesh to this, resets selection and creases

shallowClone()

Object mrmeshpy.ObjectMesh.shallowClone

(

self

)

clones this object only, without its children,
making new object to share resources with this object

Reimplemented from mrmeshpy.ObjectMeshHolder.

TypeName()

str mrmeshpy.ObjectMesh.TypeName ( )

static

return name of subtype for serialization purposes

Reimplemented from mrmeshpy.ObjectMeshHolder.

typeName()

str mrmeshpy.ObjectMesh.typeName

(

self

)

Reimplemented from mrmeshpy.ObjectMeshHolder.

updateMesh()

Mesh mrmeshpy.ObjectMesh.updateMesh	(		self,
		Mesh	mesh )

sets given mesh to this, and returns back previous mesh of this;
does not touch selection or creases

varMesh()

Mesh mrmeshpy.ObjectMesh.varMesh

(

self

)

returns variable mesh, if const mesh is needed use `mesh()` instead

worldRayIntersection()

MeshIntersectionResult mrmeshpy.ObjectMesh.worldRayIntersection	(		self,
		Line3f	worldRay,
		FaceBitSet	region = None )

given ray in world coordinates, e.g. obtained from Viewport::unprojectPixelRay;
finds its intersection with the mesh of this object considering its transformation relative to the world;
it is inefficient to call this function for many rays, because it computes world-to-local xf every time

---

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

• mrmeshpy.pyi