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

Public Member Functions

 __init__ (self, *args, **kwargs)
None buildMeshFromText (self)
Object clone (self)
std_vector_ViewportMask getAllVisualizeProperties (self)
float getBackgroundPadding (self)
ConstColor getContourColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getContourColorsForAllViewports (self)
float getFontHeight (self)
pathlib.Path getFontPath (self)
ConstPositionedText getLabel (self)
ConstColor getLeaderLineColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getLeaderLineColorsForAllViewports (self)
float getLeaderLineWidth (self)
ConstVector2f getPivotPoint (self)
ConstVector2f getPivotShift (self)
ConstColor getSourcePointColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getSourcePointColorsForAllViewports (self)
float getSourcePointSize (self)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
bool hasVisualRepresentation (self)
int heapBytes (self)
Mesh labelRepresentingMesh (self)
Object shallowClone (self)
str typeName (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)
bool getRedrawFlag (self, ConstViewportMask viewportMask)
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 supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
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)
int getModelHash (self)
bool globalVisibility (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalVisibilityMask (self)
bool hasModel (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)
bool sameModels (self, ConstObject other)
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::ObjectLabel

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

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ buildMeshFromText()

None mrmeshpy.ConstObjectLabel.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.ConstObjectLabel.clone ( self)
clones this object only, without its children,
making new object the owner of all copied resources

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getAllVisualizeProperties()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getBackgroundPadding()

float mrmeshpy.ConstObjectLabel.getBackgroundPadding ( self)
returns background padding in pixels

◆ getContourColor()

ConstColor mrmeshpy.ConstObjectLabel.getContourColor ( self,
ConstViewportId id = ... )
return contour color

◆ getContourColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstObjectLabel.getContourColorsForAllViewports ( self)

◆ getFontHeight()

float mrmeshpy.ConstObjectLabel.getFontHeight ( self)
returns size of label font on screen in pixels

◆ getFontPath()

pathlib.Path mrmeshpy.ConstObjectLabel.getFontPath ( self)

◆ getLabel()

ConstPositionedText mrmeshpy.ConstObjectLabel.getLabel ( self)

◆ getLeaderLineColor()

ConstColor mrmeshpy.ConstObjectLabel.getLeaderLineColor ( self,
ConstViewportId id = ... )
return color of leader line

◆ getLeaderLineColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstObjectLabel.getLeaderLineColorsForAllViewports ( self)

◆ getLeaderLineWidth()

float mrmeshpy.ConstObjectLabel.getLeaderLineWidth ( self)
returns width of leader line in pixels

◆ getPivotPoint()

ConstVector2f mrmeshpy.ConstObjectLabel.getPivotPoint ( self)
get pivot point

◆ getPivotShift()

ConstVector2f mrmeshpy.ConstObjectLabel.getPivotShift ( self)
get pivot shift (pivot point * text diagonal)

◆ getSourcePointColor()

ConstColor mrmeshpy.ConstObjectLabel.getSourcePointColor ( self,
ConstViewportId id = ... )
returns color of source point

◆ getSourcePointColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstObjectLabel.getSourcePointColorsForAllViewports ( self)

◆ getSourcePointSize()

float mrmeshpy.ConstObjectLabel.getSourcePointSize ( self)
returns size of source point in pixels

◆ getVisualizePropertyMask()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getWorldBox()

Box3f mrmeshpy.ConstObjectLabel.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.ConstVisualObject.

◆ hasVisualRepresentation()

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

Reimplemented from mrmeshpy.ConstObject.

◆ heapBytes()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ labelRepresentingMesh()

Mesh mrmeshpy.ConstObjectLabel.labelRepresentingMesh ( self)
returns mesh that represents current label
only used in Render object for binding, cleared after it

◆ shallowClone()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticTypeName()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ typeName()

str mrmeshpy.ConstObjectLabel.typeName ( self)

Reimplemented from mrmeshpy.ConstVisualObject.


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