MeshLib Python Docs
Loading...
Searching...
No Matches
Inheritance diagram for mrmeshpy.ConstObjectPointsHolder:

Public Member Functions

 __init__ (self, *args, **kwargs)
Object clone (self)
std_vector_ViewportMask getAllVisualizeProperties (self)
int getMaxRenderingPoints (self)
float getPointSize (self)
int getRenderDiscretization (self)
ConstVertBitSet getSelectedPoints (self)
ConstVertBitSet getSelectedPointsOrAll (self)
ConstColor getSelectedVerticesColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getSelectedVerticesColorsForAllViewports (self)
ConstVertColors getVertsColorMap (self)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
bool hasModel (self)
bool hasVisualRepresentation (self)
int heapBytes (self)
int numRenderingValidPoints (self)
int numSelectedPoints (self)
int numValidPoints (self)
ConstPointCloud pointCloud (self)
PointCloudPart pointCloudPart (self)
ConstPointCloud pointCloudPtr (self)
str serializeFormat (self)
Object shallowClone (self)
bool supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
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)

Static Public Attributes

typing MaxRenderingPointsDefault = 1000000
typing MaxRenderingPointsUnlimited = 2147483647

Detailed Description

Generated from:  MR::ObjectPointsHolder

an object that stores a points

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ clone()

Object mrmeshpy.ConstObjectPointsHolder.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.ConstObjectPoints.

◆ getAllVisualizeProperties()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getMaxRenderingPoints()

int mrmeshpy.ConstObjectPointsHolder.getMaxRenderingPoints ( self)
returns maximal number of points that will be rendered
if actual count of valid points is greater then the points will be sampled

◆ getPointSize()

float mrmeshpy.ConstObjectPointsHolder.getPointSize ( self)
returns size of points on screen in pixels

◆ getRenderDiscretization()

int mrmeshpy.ConstObjectPointsHolder.getRenderDiscretization ( self)
returns rendering discretization
display each `renderDiscretization`-th point only,
starting from 0 index, total number is \\ref numRenderingValidPoints()
\\details defined by maximum rendered points number as:
\\ref numValidPoints() / \\ref getMaxRenderingPoints() (rounded up)
updated when setting `maxRenderingPoints` or changing the cloud (setting `DIRTY_FACE` flag)

◆ getSelectedPoints()

ConstVertBitSet mrmeshpy.ConstObjectPointsHolder.getSelectedPoints ( self)
gets current selected points

◆ getSelectedPointsOrAll()

ConstVertBitSet mrmeshpy.ConstObjectPointsHolder.getSelectedPointsOrAll ( self)
returns selected points if any, otherwise returns all valid points

◆ getSelectedVerticesColor()

ConstColor mrmeshpy.ConstObjectPointsHolder.getSelectedVerticesColor ( self,
ConstViewportId id = ... )
returns colors of selected vertices

◆ getSelectedVerticesColorsForAllViewports()

ConstViewportProperty_Color mrmeshpy.ConstObjectPointsHolder.getSelectedVerticesColorsForAllViewports ( self)

◆ getVertsColorMap()

ConstVertColors mrmeshpy.ConstObjectPointsHolder.getVertsColorMap ( self)
returns per-point colors of the object

◆ getVisualizePropertyMask()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getWorldBox()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ numRenderingValidPoints()

int mrmeshpy.ConstObjectPointsHolder.numRenderingValidPoints ( self)
returns count of valid points that will be rendered

◆ numSelectedPoints()

int mrmeshpy.ConstObjectPointsHolder.numSelectedPoints ( self)
returns cached information about the number of selected points

◆ numValidPoints()

int mrmeshpy.ConstObjectPointsHolder.numValidPoints ( self)
returns cached information about the number of valid points

◆ pointCloud()

ConstPointCloud mrmeshpy.ConstObjectPointsHolder.pointCloud ( self)
\\deprecated the cast inside is undefined behaviour, use pointCloudPtr() instead

◆ pointCloudPart()

PointCloudPart mrmeshpy.ConstObjectPointsHolder.pointCloudPart ( self)
\\return the pair ( point cloud, selected points ) if any point is selected or full point cloud otherwise

◆ pointCloudPtr()

ConstPointCloud mrmeshpy.ConstObjectPointsHolder.pointCloudPtr ( self)
returns the point cloud of this object, or nullptr if it is not set

◆ serializeFormat()

str mrmeshpy.ConstObjectPointsHolder.serializeFormat ( self)
returns overriden file extension used to serialize point cloud inside this object, nullptr means SceneSettings::get( SceneSettings::StringType::PointsSerializeFormat )

◆ shallowClone()

Object mrmeshpy.ConstObjectPointsHolder.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.ConstObjectPoints.

◆ StaticTypeName()

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

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectPoints.

◆ supportsVisualizeProperty()

bool mrmeshpy.ConstObjectPointsHolder.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.

◆ typeName()

str mrmeshpy.ConstObjectPointsHolder.typeName ( self)

Reimplemented from mrmeshpy.ConstVisualObject.

Reimplemented in mrmeshpy.ConstObjectPoints.

Member Data Documentation

◆ MaxRenderingPointsDefault

typing mrmeshpy.ConstObjectPointsHolder.MaxRenderingPointsDefault = 1000000
static

◆ MaxRenderingPointsUnlimited

typing mrmeshpy.ConstObjectPointsHolder.MaxRenderingPointsUnlimited = 2147483647
static

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