mrmeshpy.ObjectLabel Class Reference

Inheritance diagram for mrmeshpy.ObjectLabel:

Public Member Functions
None	__init__ (self)
None	applyScale (self, float scaleFactor)
None	buildMeshFromText (self)
Object	clone (self)
std_vector_ViewportMask	getAllVisualizeProperties (self)
float	getBackgroundPadding (self)
Color	getContourColor (self, ViewportId id='{}')
ViewportProperty_Color	getContourColorsForAllViewports (self)
float	getFontHeight (self)
pathlib.Path	getFontPath (self)
PositionedText	getLabel (self)
Color	getLeaderLineColor (self, ViewportId id='{}')
ViewportProperty_Color	getLeaderLineColorsForAllViewports (self)
float	getLeaderLineWidth (self)
Vector2f	getPivotPoint (self)
Vector2f	getPivotShift (self)
Color	getSourcePointColor (self, ViewportId id='{}')
ViewportProperty_Color	getSourcePointColorsForAllViewports (self)
float	getSourcePointSize (self)
ViewportMask	getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
bool	hasVisualRepresentation (self)
int	heapBytes (self)
Mesh	labelRepresentingMesh (self)
None	setBackgroundPadding (self, float padding)
None	setContourColor (self, Color color, ViewportId id='{}')
None	setContourColorsForAllViewports (self, ViewportProperty_Color val)
None	setFontHeight (self, float size)
None	setFontPath (self, os.PathLike|str|bytes pathToFont)
None	setLabel (self, PositionedText label)
None	setLeaderLineColor (self, Color color, ViewportId id='{}')
None	setLeaderLineColorsForAllViewports (self, ViewportProperty_Color val)
None	setLeaderLineWidth (self, float width)
None	setPivotPoint (self, Vector2f pivotPoint)
None	setSourcePointColor (self, Color color, ViewportId id='{}')
None	setSourcePointColorsForAllViewports (self, ViewportProperty_Color val)
None	setSourcePointSize (self, float size)
Object	shallowClone (self)
str	typeName (self)
Public Member Functions inherited from mrmeshpy.VisualObject
None	copyColors (self, VisualObject src, VertMap thisToSrc, FaceMap thisToSrcFaces='{}')
float	getAmbientStrength (self)
Color	getBackColor (self, ViewportId viewportId='{}')
ViewportProperty_Color	getBackColorsForAllViewports (self)
Box3f	getBoundingBox (self)
str	getClassName (self)
str	getClassNameInPlural (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)
std_vector_std_string	getInfoLines (self)
std_vector_PositionedText	getLabels (self)
Color	getLabelsColor (self, ViewportId 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='{}')
None	setBackColorsForAllViewports (self, ViewportProperty_Color val)
None	setColoringType (self, ColoringType coloringType)
None	setDirtyFlags (self, int mask, bool invalidateCaches=True)
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	setLabels (self, std_vector_PositionedText labels)
None	setLabelsColor (self, Color color, ViewportId 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)
bool	supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
None	toggleVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
None	updateVertsColorMap (self, VertColors vertsColorMap)
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)
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	hasModel (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='{}')
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)
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	TypeName ()
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 Protected Member Functions
	_pybind11_conduit_v1_ (*args, **kwargs)
Static Protected Member Functions inherited from mrmeshpy.ObjectChildrenHolder
ObjectChildrenHolder	_Equal (*args, **kwargs)
ObjectChildrenHolder	_Equal (*args, **kwargs)

Detailed Description

Generated from:  MR::ObjectLabel

This object type renders label in scene
\\details default pivot point = (0, 0)
\\ingroup DataModelGroup

Constructor & Destructor Documentation

__init__()

None mrmeshpy.ObjectLabel.__init__

(

self

)

Reimplemented from mrmeshpy.VisualObject.

Member Function Documentation

_pybind11_conduit_v1_()

mrmeshpy.ObjectLabel._pybind11_conduit_v1_ ( * args, ** kwargs )

staticprotected

Reimplemented from mrmeshpy.VisualObject.

applyScale()

None mrmeshpy.ObjectLabel.applyScale	(		self,
		float	scaleFactor )

scale object size (all point positions)

Reimplemented from mrmeshpy.Object.

buildMeshFromText()

None mrmeshpy.ObjectLabel.buildMeshFromText

(

self

)

Loads font, and converts the symbols of text into mesh;
since this operation is time consuming, one can call this method in parallel for several ObjectLabels before rendering

clone()

Object mrmeshpy.ObjectLabel.clone

(

self

)

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

Reimplemented from mrmeshpy.VisualObject.

getAllVisualizeProperties()

std_vector_ViewportMask mrmeshpy.ObjectLabel.getAllVisualizeProperties

(

self

)

get all visualize properties masks

Reimplemented from mrmeshpy.VisualObject.

getBackgroundPadding()

float mrmeshpy.ObjectLabel.getBackgroundPadding

(

self

)

returns background padding in pixels

getContourColor()

Color mrmeshpy.ObjectLabel.getContourColor	(		self,
		ViewportId	id = '{}' )

return contour color

getContourColorsForAllViewports()

ViewportProperty_Color mrmeshpy.ObjectLabel.getContourColorsForAllViewports

(

self

)

getFontHeight()

float mrmeshpy.ObjectLabel.getFontHeight

(

self

)

returns size of label font on screen in pixels

getFontPath()

pathlib.Path mrmeshpy.ObjectLabel.getFontPath

(

self

)

getLabel()

PositionedText mrmeshpy.ObjectLabel.getLabel

(

self

)

getLeaderLineColor()

Color mrmeshpy.ObjectLabel.getLeaderLineColor	(		self,
		ViewportId	id = '{}' )

return color of leader line

getLeaderLineColorsForAllViewports()

ViewportProperty_Color mrmeshpy.ObjectLabel.getLeaderLineColorsForAllViewports

(

self

)

getLeaderLineWidth()

float mrmeshpy.ObjectLabel.getLeaderLineWidth

(

self

)

returns width of leader line in pixels

getPivotPoint()

Vector2f mrmeshpy.ObjectLabel.getPivotPoint

(

self

)

get pivot point

getPivotShift()

Vector2f mrmeshpy.ObjectLabel.getPivotShift

(

self

)

get pivot shift (pivot point * text diagonal)

getSourcePointColor()

Color mrmeshpy.ObjectLabel.getSourcePointColor	(		self,
		ViewportId	id = '{}' )

returns color of source point

getSourcePointColorsForAllViewports()

ViewportProperty_Color mrmeshpy.ObjectLabel.getSourcePointColorsForAllViewports

(

self

)

getSourcePointSize()

float mrmeshpy.ObjectLabel.getSourcePointSize

(

self

)

returns size of source point in pixels

getVisualizePropertyMask()

ViewportMask mrmeshpy.ObjectLabel.getVisualizePropertyMask	(		self,
		AnyVisualizeMaskEnum	type )

returns mask of viewports where given property is set

Reimplemented from mrmeshpy.VisualObject.

getWorldBox()

Box3f mrmeshpy.ObjectLabel.getWorldBox ( * args, ** kwargs )

static

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

Reimplemented from mrmeshpy.VisualObject.

hasVisualRepresentation()

bool mrmeshpy.ObjectLabel.hasVisualRepresentation

(

self

)

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

Reimplemented from mrmeshpy.Object.

heapBytes()

int mrmeshpy.ObjectLabel.heapBytes

(

self

)

returns the amount of memory this object occupies on heap

Reimplemented from mrmeshpy.VisualObject.

labelRepresentingMesh()

Mesh mrmeshpy.ObjectLabel.labelRepresentingMesh

(

self

)

returns mesh that represents current label
only used in Render object for binding, cleared after it

setBackgroundPadding()

None mrmeshpy.ObjectLabel.setBackgroundPadding	(		self,
		float	padding )

sets background padding in pixels

setContourColor()

None mrmeshpy.ObjectLabel.setContourColor	(		self,
		Color	color,
		ViewportId	id = '{}' )

sets contour color

setContourColorsForAllViewports()

None mrmeshpy.ObjectLabel.setContourColorsForAllViewports	(		self,
		ViewportProperty_Color	val )

setFontHeight()

None mrmeshpy.ObjectLabel.setFontHeight	(		self,
		float	size )

sets size of label font in pixels

setFontPath()

None mrmeshpy.ObjectLabel.setFontPath	(		self,
		os.PathLike | str | bytes	pathToFont )

sets path to font file

setLabel()

None mrmeshpy.ObjectLabel.setLabel	(		self,
		PositionedText	label )

sets text and position of label

setLeaderLineColor()

None mrmeshpy.ObjectLabel.setLeaderLineColor	(		self,
		Color	color,
		ViewportId	id = '{}' )

sets color of leader line

setLeaderLineColorsForAllViewports()

None mrmeshpy.ObjectLabel.setLeaderLineColorsForAllViewports	(		self,
		ViewportProperty_Color	val )

setLeaderLineWidth()

None mrmeshpy.ObjectLabel.setLeaderLineWidth	(		self,
		float	width )

sets width of leader line in pixels

setPivotPoint()

None mrmeshpy.ObjectLabel.setPivotPoint	(		self,
		Vector2f	pivotPoint )

set pivot point
\\param pivotPoint - text location parameter of  relative to text position point
[0, 0] - text position point is left-down corner of text
[1, 1] - text position point is right-up corner
can be outside range [0, 0] - [1, 1]

setSourcePointColor()

None mrmeshpy.ObjectLabel.setSourcePointColor	(		self,
		Color	color,
		ViewportId	id = '{}' )

sets color of source point

setSourcePointColorsForAllViewports()

None mrmeshpy.ObjectLabel.setSourcePointColorsForAllViewports	(		self,
		ViewportProperty_Color	val )

setSourcePointSize()

None mrmeshpy.ObjectLabel.setSourcePointSize	(		self,
		float	size )

sets size of source point in pixels

shallowClone()

Object mrmeshpy.ObjectLabel.shallowClone

(

self

)

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

Reimplemented from mrmeshpy.VisualObject.

TypeName()

str mrmeshpy.ObjectLabel.TypeName ( )

static

return name of subtype for serialization purposes

Reimplemented from mrmeshpy.VisualObject.

typeName()

str mrmeshpy.ObjectLabel.typeName

(

self

)

Reimplemented from mrmeshpy.VisualObject.

---

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

• mrmeshpy.pyi