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

Public Member Functions

 __init__ (self, *args, **kwargs)
float avgEdgeLen (self)
Object clone (self)
std_vector_ViewportMask getAllVisualizeProperties (self)
ConstVector4_unsigned_char getDashPattern (self, ConstViewportId vpId=..., bool_output isDef=None)
float getLineWidth (self)
ConstUndirectedEdgeColors getLinesColorMap (self)
float getPointSize (self)
ConstVertColors getVertsColorMap (self)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
bool hasModel (self)
bool hasVisualRepresentation (self)
int heapBytes (self)
int numComponents (self)
int numUndirectedEdges (self)
ConstPolyline3 polyline (self)
ConstPolyline3 polylinePtr (self)
Object shallowClone (self)
bool supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
float totalLength (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 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 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::ObjectLinesHolder
Aliases:  ChangeLinesColorMapAction.Obj, std_shared_ptr_ObjectLinesHolder

an object that stores a lines

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ avgEdgeLen()

float mrmeshpy.ConstObjectLinesHolder.avgEdgeLen ( self)
returns cached average edge length

◆ clone()

Object mrmeshpy.ConstObjectLinesHolder.clone ( self)
clones this object only, without its children,
making new object the owner of all copied resources

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectGcode, and mrmeshpy.ConstObjectLines.

◆ getAllVisualizeProperties()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getDashPattern()

ConstVector4_unsigned_char mrmeshpy.ConstObjectLinesHolder.getDashPattern ( self,
ConstViewportId vpId = ...,
bool_output isDef = None )

◆ getLinesColorMap()

ConstUndirectedEdgeColors mrmeshpy.ConstObjectLinesHolder.getLinesColorMap ( self)

◆ getLineWidth()

float mrmeshpy.ConstObjectLinesHolder.getLineWidth ( self)

◆ getPointSize()

float mrmeshpy.ConstObjectLinesHolder.getPointSize ( self)

◆ getVertsColorMap()

ConstVertColors mrmeshpy.ConstObjectLinesHolder.getVertsColorMap ( self)
returns per-vertex colors of the object

◆ getVisualizePropertyMask()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getWorldBox()

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

◆ hasModel()

bool mrmeshpy.ConstObjectLinesHolder.hasModel ( self)
does the object have any model available (but possibly empty),
e.g. ObjectMesh has valid meshPtr() or ObjectPoints has valid pointCloudPtr()

Reimplemented from mrmeshpy.ConstObject.

◆ hasVisualRepresentation()

bool mrmeshpy.ConstObjectLinesHolder.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.ConstObjectLinesHolder.heapBytes ( self)
returns the amount of memory this object occupies on heap

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectGcode.

◆ numComponents()

int mrmeshpy.ConstObjectLinesHolder.numComponents ( self)
returns cached information about the number of components in the polyline

◆ numUndirectedEdges()

int mrmeshpy.ConstObjectLinesHolder.numUndirectedEdges ( self)
returns cached information about the number of undirected edges in the polyline

◆ polyline()

ConstPolyline3 mrmeshpy.ConstObjectLinesHolder.polyline ( self)
\\deprecated the cast inside is undefined behaviour, use polylinePtr() instead

◆ polylinePtr()

ConstPolyline3 mrmeshpy.ConstObjectLinesHolder.polylinePtr ( self)
returns the polyline of this object, or nullptr if it is not set

◆ shallowClone()

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

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectGcode, and mrmeshpy.ConstObjectLines.

◆ StaticTypeName()

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

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectGcode, and mrmeshpy.ConstObjectLines.

◆ supportsVisualizeProperty()

bool mrmeshpy.ConstObjectLinesHolder.supportsVisualizeProperty ( self,
ConstAnyVisualizeMaskEnum type )
Returns true if this class supports the property `type`. Otherwise passing it to the functions below is illegal.

Reimplemented from mrmeshpy.ConstVisualObject.

◆ totalLength()

float mrmeshpy.ConstObjectLinesHolder.totalLength ( self)
return cached total length

◆ typeName()

str mrmeshpy.ConstObjectLinesHolder.typeName ( self)

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