meshlib.mrmeshpy.ObjectLinesHolder Class Reference

Inheritance diagram for meshlib.mrmeshpy.ObjectLinesHolder:

Public Member Functions
None	__init__ (self)
None	applyScale (self, float scaleFactor)
Object	clone (self)
std_vector_ViewportMask	getAllVisualizeProperties (self)
float	getLineWidth (self)
UndirectedEdgeColors	getLinesColorMap (self)
float	getPointSize (self)
ViewportMask	getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
bool	hasModel (self)
bool	hasVisualRepresentation (self)
int	heapBytes (self)
int	numComponents (self)
Polyline3	polyline (self)
None	setDirtyFlags (self, int mask, bool invalidateCaches=True)
None	setLineWidth (self, float width)
None	setLinesColorMap (self, UndirectedEdgeColors linesColorMap)
None	setPointSize (self, float size)
Object	shallowClone (self)
bool	supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
float	totalLength (self)
str	typeName (self)
None	updateLinesColorMap (self, UndirectedEdgeColors updated)
Public Member Functions inherited from meshlib.mrmeshpy.VisualObject
None	copyColors (self, VisualObject src, VertMap thisToSrc, FaceMap thisToSrcFaces='MR::FaceMap{}')
float	getAmbientStrength (self)
Color	getBackColor (self, ViewportId viewportId='MR::ViewportId{}')
ViewportProperty_Color	getBackColorsForAllViewports (self)
Box3f	getBoundingBox (self)
str	getClassName (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_std_string	getInfoLines (self)
std_vector_PositionedText	getLabels (self)
Color	getLabelsColor (self, ViewportId viewportId='MR::ViewportId{}')
ViewportProperty_Color	getLabelsColorsForAllViewports (self)
bool	getRedrawFlag (self, ViewportMask viewportMask)
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 ()
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::ObjectLinesHolder
Aliases:  ChangeLinesColorMapAction.Obj

an object that stores a lines
\\ingroup DataModelGroup

Constructor & Destructor Documentation

__init__()

None meshlib.mrmeshpy.ObjectLinesHolder.__init__

(

self

)

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectGcode, and meshlib.mrmeshpy.ObjectLines.

Member Function Documentation

applyScale()

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

scale object size (all point positions)

Reimplemented from meshlib.mrmeshpy.Object.

clone()

Object meshlib.mrmeshpy.ObjectLinesHolder.clone

(

self

)

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

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectGcode, and meshlib.mrmeshpy.ObjectLines.

getAllVisualizeProperties()

std_vector_ViewportMask meshlib.mrmeshpy.ObjectLinesHolder.getAllVisualizeProperties

(

self

)

get all visualize properties masks

Reimplemented from meshlib.mrmeshpy.VisualObject.

getLinesColorMap()

UndirectedEdgeColors meshlib.mrmeshpy.ObjectLinesHolder.getLinesColorMap

(

self

)

getLineWidth()

float meshlib.mrmeshpy.ObjectLinesHolder.getLineWidth

(

self

)

getPointSize()

float meshlib.mrmeshpy.ObjectLinesHolder.getPointSize

(

self

)

getVisualizePropertyMask()

ViewportMask meshlib.mrmeshpy.ObjectLinesHolder.getVisualizePropertyMask	(		self,
		AnyVisualizeMaskEnum	type )

returns mask of viewports where given property is set

Reimplemented from meshlib.mrmeshpy.VisualObject.

getWorldBox()

Box3f meshlib.mrmeshpy.ObjectLinesHolder.getWorldBox ( * args, ** kwargs )

static

returns cached bounding box of this point object in world coordinates;
if you need bounding box in local coordinates please call getBoundingBox()

Reimplemented from meshlib.mrmeshpy.VisualObject.

hasModel()

bool meshlib.mrmeshpy.ObjectLinesHolder.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.Object.

hasVisualRepresentation()

bool meshlib.mrmeshpy.ObjectLinesHolder.hasVisualRepresentation

(

self

)

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

Reimplemented from meshlib.mrmeshpy.Object.

heapBytes()

int meshlib.mrmeshpy.ObjectLinesHolder.heapBytes

(

self

)

returns the amount of memory this object occupies on heap

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectGcode.

numComponents()

int meshlib.mrmeshpy.ObjectLinesHolder.numComponents

(

self

)

returns cached information about the number of components in the polyline

polyline()

Polyline3 meshlib.mrmeshpy.ObjectLinesHolder.polyline

(

self

)

setDirtyFlags()

None meshlib.mrmeshpy.ObjectLinesHolder.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 meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectGcode, and meshlib.mrmeshpy.ObjectLines.

setLinesColorMap()

None meshlib.mrmeshpy.ObjectLinesHolder.setLinesColorMap	(		self,
		UndirectedEdgeColors	linesColorMap )

setLineWidth()

None meshlib.mrmeshpy.ObjectLinesHolder.setLineWidth	(		self,
		float	width )

setPointSize()

None meshlib.mrmeshpy.ObjectLinesHolder.setPointSize	(		self,
		float	size )

shallowClone()

Object meshlib.mrmeshpy.ObjectLinesHolder.shallowClone

(

self

)

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

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectGcode, and meshlib.mrmeshpy.ObjectLines.

supportsVisualizeProperty()

bool meshlib.mrmeshpy.ObjectLinesHolder.supportsVisualizeProperty	(		self,
		AnyVisualizeMaskEnum	type )

Returns true if this class supports the property `type`. Otherwise passing it to the functions below is illegal.

Reimplemented from meshlib.mrmeshpy.VisualObject.

totalLength()

float meshlib.mrmeshpy.ObjectLinesHolder.totalLength

(

self

)

return cached total length

TypeName()

str meshlib.mrmeshpy.ObjectLinesHolder.TypeName ( )

static

return name of subtype for serialization purposes

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectGcode, and meshlib.mrmeshpy.ObjectLines.

typeName()

str meshlib.mrmeshpy.ObjectLinesHolder.typeName

(

self

)

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectGcode, and meshlib.mrmeshpy.ObjectLines.

updateLinesColorMap()

None meshlib.mrmeshpy.ObjectLinesHolder.updateLinesColorMap	(		self,
		UndirectedEdgeColors	updated )

---

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

• mrmeshpy.pyi