MeshLib Python Docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
meshlib.mrmeshpy.ObjectPointsHolder Class Reference
+ Inheritance diagram for meshlib.mrmeshpy.ObjectPointsHolder:

Public Member Functions

None __init__ (self)
 
None applyScale (self, float scaleFactor)
 
Object clone (self)
 
std_vector_ViewportMask getAllVisualizeProperties (self)
 
int getMaxRenderingPoints (self)
 
float getPointSize (self)
 
int getRenderDiscretization (self)
 
VertBitSet getSelectedPoints (self)
 
VertBitSet getSelectedPointsOrAll (self)
 
Color getSelectedVerticesColor (self, ViewportId id='MR::ViewportId{}')
 
ViewportProperty_Color getSelectedVerticesColorsForAllViewports (self)
 
ViewportMask getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
 
bool hasModel (self)
 
bool hasVisualRepresentation (self)
 
int heapBytes (self)
 
int numRenderingValidPoints (self)
 
int numSelectedPoints (self)
 
int numValidPoints (self)
 
PointCloud pointCloud (self)
 
str savePointsFormat (self)
 
None selectPoints (self, VertBitSet newSelection)
 
None setDirtyFlags (self, int mask, bool invalidateCaches=True)
 
None setMaxRenderingPoints (self, int val)
 
None setPointSize (self, float size)
 
None setSavePointsFormat (self, str newFormat)
 
None setSelectedVerticesColor (self, Color color, ViewportId id='MR::ViewportId{}')
 
None setSelectedVerticesColorsForAllViewports (self, ViewportProperty_Color val)
 
Object shallowClone (self)
 
bool supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
 
str typeName (self)
 
None updateSelectedPoints (self, VertBitSet selection)
 
- 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)
 

Static Public Attributes

typing MaxRenderingPointsDefault = 1000000
 
typing MaxRenderingPointsUnlimited = 2147483647
 

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::ObjectPointsHolder

an object that stores a points
\\ingroup ModelHolderGroup

Constructor & Destructor Documentation

◆ __init__()

None meshlib.mrmeshpy.ObjectPointsHolder.__init__ ( self)

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectPoints, and meshlib.mrmeshpy.ObjectPoints.

Member Function Documentation

◆ applyScale()

None meshlib.mrmeshpy.ObjectPointsHolder.applyScale ( self,
float scaleFactor ) 
scale object size (all point positions)

Reimplemented from meshlib.mrmeshpy.Object.

◆ clone()

Object meshlib.mrmeshpy.ObjectPointsHolder.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.ObjectPoints.

◆ getAllVisualizeProperties()

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

Reimplemented from meshlib.mrmeshpy.VisualObject.

◆ getMaxRenderingPoints()

int meshlib.mrmeshpy.ObjectPointsHolder.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 meshlib.mrmeshpy.ObjectPointsHolder.getPointSize ( self) 
returns size of points on screen in pixels

◆ getRenderDiscretization()

int meshlib.mrmeshpy.ObjectPointsHolder.getRenderDiscretization ( self) 
returns rendering discretization
display each `renderDiscretization`-th point only,
starting from 0 index, total number is \\ref numRenderingValidPoints()
\\detail 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()

VertBitSet meshlib.mrmeshpy.ObjectPointsHolder.getSelectedPoints ( self) 
gets current selected points

◆ getSelectedPointsOrAll()

VertBitSet meshlib.mrmeshpy.ObjectPointsHolder.getSelectedPointsOrAll ( self) 
returns selected points if any, otherwise returns all valid points

◆ getSelectedVerticesColor()

Color meshlib.mrmeshpy.ObjectPointsHolder.getSelectedVerticesColor ( self,
ViewportId id = 'MR::ViewportId{}' ) 
returns colors of selected vertices

◆ getSelectedVerticesColorsForAllViewports()

ViewportProperty_Color meshlib.mrmeshpy.ObjectPointsHolder.getSelectedVerticesColorsForAllViewports ( self)

◆ getVisualizePropertyMask()

ViewportMask meshlib.mrmeshpy.ObjectPointsHolder.getVisualizePropertyMask ( self,
AnyVisualizeMaskEnum type ) 
returns mask of viewports where given property is set

Reimplemented from meshlib.mrmeshpy.VisualObject.

◆ getWorldBox()

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

Reimplemented from meshlib.mrmeshpy.VisualObject.

◆ numRenderingValidPoints()

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

◆ numSelectedPoints()

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

◆ numValidPoints()

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

◆ pointCloud()

PointCloud meshlib.mrmeshpy.ObjectPointsHolder.pointCloud ( self)

◆ savePointsFormat()

str meshlib.mrmeshpy.ObjectPointsHolder.savePointsFormat ( self) 
returns file extension used to serialize the points

◆ selectPoints()

None meshlib.mrmeshpy.ObjectPointsHolder.selectPoints ( self,
VertBitSet newSelection ) 
sets current selected points

◆ setDirtyFlags()

None meshlib.mrmeshpy.ObjectPointsHolder.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.ObjectPoints.

◆ setMaxRenderingPoints()

None meshlib.mrmeshpy.ObjectPointsHolder.setMaxRenderingPoints ( self,
int val ) 
sets maximal number of points that will be rendered
\\sa \\ref getRenderDiscretization, \\ref MaxRenderingPointsDefault, \\ref MaxRenderingPointsUnlimited

◆ setPointSize()

None meshlib.mrmeshpy.ObjectPointsHolder.setPointSize ( self,
float size ) 
sets size of points on screen in pixels

◆ setSavePointsFormat()

None meshlib.mrmeshpy.ObjectPointsHolder.setSavePointsFormat ( self,
str newFormat ) 
sets file extension used to serialize the points: must be not null and must start from '.'

◆ setSelectedVerticesColor()

None meshlib.mrmeshpy.ObjectPointsHolder.setSelectedVerticesColor ( self,
Color color,
ViewportId id = 'MR::ViewportId{}' ) 
sets colors of selected vertices

◆ setSelectedVerticesColorsForAllViewports()

None meshlib.mrmeshpy.ObjectPointsHolder.setSelectedVerticesColorsForAllViewports ( self,
ViewportProperty_Color val )

◆ shallowClone()

Object meshlib.mrmeshpy.ObjectPointsHolder.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.ObjectPoints.

◆ supportsVisualizeProperty()

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

◆ TypeName()

str meshlib.mrmeshpy.ObjectPointsHolder.TypeName ( )
static 
return name of subtype for serialization purposes

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectPoints.

◆ typeName()

str meshlib.mrmeshpy.ObjectPointsHolder.typeName ( self)

Reimplemented from meshlib.mrmeshpy.VisualObject.

Reimplemented in meshlib.mrmeshpy.ObjectPoints.

◆ updateSelectedPoints()

None meshlib.mrmeshpy.ObjectPointsHolder.updateSelectedPoints ( self,
VertBitSet selection ) 
swaps current selected points with the argument

Member Data Documentation

◆ MaxRenderingPointsDefault

typing meshlib.mrmeshpy.ObjectPointsHolder.MaxRenderingPointsDefault = 1000000
static

◆ MaxRenderingPointsUnlimited

typing meshlib.mrmeshpy.ObjectPointsHolder.MaxRenderingPointsUnlimited = 2147483647
static
The documentation for this class was generated from the following file: