meshlib.mrmeshpy.ObjectDistanceMap Class Reference

Inheritance diagram for meshlib.mrmeshpy.ObjectDistanceMap:

Public Member Functions
None	__init__ (self)
None	applyScale (self, float scaleFactor)
Mesh	calculateMesh (self, func_bool_from_float cb='MR::ProgressCallback{}')
Object	clone (self)
DistanceMap	extractDistanceMap (self)
str	getClassName (self)
DistanceMap	getDistanceMap (self)
std_vector_std_string	getInfoLines (self)
AffineXf3f	getToWorldParameters (self)
bool	hasModel (self)
int	heapBytes (self)
bool	setDistanceMap (self, DistanceMap dmap, AffineXf3f dmap2local, bool needUpdateMesh=True, func_bool_from_float cb='MR::ProgressCallback{}')
Object	shallowClone (self)
str	typeName (self)
None	updateMesh (self, Mesh mesh)
Public Member Functions inherited from meshlib.mrmeshpy.ObjectMeshHolder
None	addTexture (self, MeshTexture texture)
float	avgEdgeLen (self)
None	clearAncillaryTexture (self)
None	copyColors (self, VisualObject src, VertMap thisToSrc, FaceMap thisToSrcFaces='MR::FaceMap{}')
None	copyTextureAndColors (self, ObjectMeshHolder src, VertMap thisToSrc, FaceMap thisToSrcFaces='MR::FaceMap{}')
UndirectedEdgeBitSet	creases (self)
bool	flatShading (self)
std_vector_ViewportMask	getAllVisualizeProperties (self)
MeshTexture	getAncillaryTexture (self)
VertUVCoords	getAncillaryUVCoords (self)
Color	getBordersColor (self, ViewportId id='MR::ViewportId{}')
ViewportProperty_Color	getBordersColorsForAllViewports (self)
float	getEdgeWidth (self)
Color	getEdgesColor (self, ViewportId id='MR::ViewportId{}')
ViewportProperty_Color	getEdgesColorsForAllViewports (self)
FaceColors	getFacesColorMap (self)
int	getNeededNormalsRenderDirtyValue (self, ViewportMask viewportMask)
float	getPointSize (self)
Color	getPointsColor (self, ViewportId id='MR::ViewportId{}')
bool	getRedrawFlag (self, ViewportMask viewportMask)
UndirectedEdgeBitSet	getSelectedEdges (self)
Color	getSelectedEdgesColor (self, ViewportId id='MR::ViewportId{}')
ViewportProperty_Color	getSelectedEdgesColorsForAllViewports (self)
FaceBitSet	getSelectedFaces (self)
Color	getSelectedFacesColor (self, ViewportId id='MR::ViewportId{}')
ViewportProperty_Color	getSelectedFacesColorsForAllViewports (self)
MeshTexture	getTexture (self)
TexturePerFace	getTexturePerFace (self)
Vector_MeshTexture_TextureId	getTextures (self)
VertUVCoords	getUVCoords (self)
ViewportMask	getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
bool	hasAncillaryTexture (self)
bool	hasVisualRepresentation (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	resetDirtyExeptMask (self, int mask)
str	saveMeshFormat (self)
None	selectEdges (self, UndirectedEdgeBitSet newSelection)
None	selectFaces (self, FaceBitSet newSelection)
float	selectedArea (self)
None	setAncillaryTexture (self, MeshTexture texture)
None	setAncillaryUVCoords (self, VertUVCoords uvCoordinates)
None	setBordersColor (self, Color color, ViewportId id='MR::ViewportId{}')
None	setBordersColorsForAllViewports (self, ViewportProperty_Color val)
None	setCreases (self, UndirectedEdgeBitSet creases)
None	setDirtyFlags (self, int mask, bool invalidateCaches=True)
None	setEdgeWidth (self, float edgeWidth)
None	setEdgesColor (self, Color color, ViewportId id='MR::ViewportId{}')
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='MR::ViewportId{}')
None	setSaveMeshFormat (self, str newFormat)
None	setSelectedEdgesColor (self, Color color, ViewportId id='MR::ViewportId{}')
None	setSelectedEdgesColorsForAllViewports (self, ViewportProperty_Color val)
None	setSelectedFacesColor (self, Color color, ViewportId id='MR::ViewportId{}')
None	setSelectedFacesColorsForAllViewports (self, ViewportProperty_Color val)
None	setTexture (self, MeshTexture texture)
None	setTexturePerFace (self, TexturePerFace texturePerFace)
None	setTextures (self, Vector_MeshTexture_TextureId texture)
None	setUVCoords (self, VertUVCoords uvCoordinates)
bool	supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
float	totalArea (self)
None	updateAncillaryUVCoords (self, VertUVCoords updated)
None	updateFacesColorMap (self, FaceColors updated)
None	updateTexture (self, MeshTexture updated)
None	updateTexturePerFace (self, TexturePerFace texturePerFace)
None	updateTextures (self, Vector_MeshTexture_TextureId updated)
None	updateUVCoords (self, VertUVCoords updated)
float	volume (self)
Public Member Functions inherited from meshlib.mrmeshpy.VisualObject
float	getAmbientStrength (self)
Color	getBackColor (self, ViewportId viewportId='MR::ViewportId{}')
ViewportProperty_Color	getBackColorsForAllViewports (self)
Box3f	getBoundingBox (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_PositionedText	getLabels (self)
Color	getLabelsColor (self, ViewportId viewportId='MR::ViewportId{}')
ViewportProperty_Color	getLabelsColorsForAllViewports (self)
float	getShininess (self)
float	getSpecularStrength (self)
VertColors	getVertsColorMap (self)
bool	getVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
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	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)
None	showLabels (self, bool on)
bool	showLabels (self)
None	showName (self, bool on)
bool	showName (self)
None	toggleVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
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)
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	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)
None	resetXf (self, ViewportId id='MR::ViewportId{}')
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	setXf (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)

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

Additional Inherited Members
Static Protected Member Functions inherited from meshlib.mrmeshpy.ObjectChildrenHolder
ObjectChildrenHolder	_Equal (*args, **kwargs)
ObjectChildrenHolder	_Equal (*args, **kwargs)

Detailed Description

Generated from:  MR::ObjectDistanceMap

This class stores information about distance map object
\\ingroup DataModelGroup

Constructor & Destructor Documentation

__init__()

None meshlib.mrmeshpy.ObjectDistanceMap.__init__

(

self

)

Reimplemented from meshlib.mrmeshpy.ObjectMeshHolder.

Member Function Documentation

applyScale()

None meshlib.mrmeshpy.ObjectDistanceMap.applyScale	(		self,
		float	scaleFactor )

scale object size (all point positions)

Reimplemented from meshlib.mrmeshpy.ObjectMeshHolder.

calculateMesh()

Mesh meshlib.mrmeshpy.ObjectDistanceMap.calculateMesh	(		self,
		func_bool_from_float	cb = 'MR::ProgressCallback{}' )

creates a grid for this object

clone()

Object meshlib.mrmeshpy.ObjectDistanceMap.clone

(

self

)

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

Reimplemented from meshlib.mrmeshpy.ObjectMeshHolder.

extractDistanceMap()

DistanceMap meshlib.mrmeshpy.ObjectDistanceMap.extractDistanceMap

(

self

)

getClassName()

str meshlib.mrmeshpy.ObjectDistanceMap.getClassName

(

self

)

return human readable name of subclass

Reimplemented from meshlib.mrmeshpy.VisualObject.

getDistanceMap()

DistanceMap meshlib.mrmeshpy.ObjectDistanceMap.getDistanceMap

(

self

)

getInfoLines()

std_vector_std_string meshlib.mrmeshpy.ObjectDistanceMap.getInfoLines

(

self

)

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

Reimplemented from meshlib.mrmeshpy.VisualObject.

getToWorldParameters()

AffineXf3f meshlib.mrmeshpy.ObjectDistanceMap.getToWorldParameters

(

self

)

unlike the name, actually it is the transformation from distance map in local space

hasModel()

bool meshlib.mrmeshpy.ObjectDistanceMap.hasModel

(

self

)

does the object have any model available (but possibly empty),
e.g. ObjectMesh has valid mesh() or ObjectPoints has valid pointCloud()

Reimplemented from meshlib.mrmeshpy.ObjectMeshHolder.

heapBytes()

int meshlib.mrmeshpy.ObjectDistanceMap.heapBytes

(

self

)

returns the amount of memory this object occupies on heap

Reimplemented from meshlib.mrmeshpy.ObjectMeshHolder.

setDistanceMap()

bool meshlib.mrmeshpy.ObjectDistanceMap.setDistanceMap	(		self,
		DistanceMap	dmap,
		AffineXf3f	dmap2local,
		bool	needUpdateMesh = True,
		func_bool_from_float	cb = 'MR::ProgressCallback{}' )

rebuilds the mesh;
if it is executed in the rendering stream then you can set the needUpdateMesh = true
otherwise you should set the needUpdateMesh = false and call the function calculateMesh
and after finishing in the rendering stream, call the function updateMesh

shallowClone()

Object meshlib.mrmeshpy.ObjectDistanceMap.shallowClone

(

self

)

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

Reimplemented from meshlib.mrmeshpy.ObjectMeshHolder.

TypeName()

str meshlib.mrmeshpy.ObjectDistanceMap.TypeName ( )

static

return name of subtype for serialization purposes

Reimplemented from meshlib.mrmeshpy.ObjectMeshHolder.

typeName()

str meshlib.mrmeshpy.ObjectDistanceMap.typeName

(

self

)

Reimplemented from meshlib.mrmeshpy.ObjectMeshHolder.

updateMesh()

None meshlib.mrmeshpy.ObjectDistanceMap.updateMesh	(		self,
		Mesh	mesh )

updates the grid to the current one

---

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

• mrmeshpy.pyi