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

Public Member Functions

 __init__ (self, *args, **kwargs)
str className (self)
str classNameInPlural (self)
Object clone (self)
bool comparisonToleranceIsAlwaysOnlyPositive (self, int i)
ObjectComparableWithReference.ComparableProperty computeComparableProperty (self, int i)
std_vector_ViewportMask getAllVisualizeProperties (self)
str getComparablePropertyName (self, int i)
ObjectComparableWithReference.ComparisonReferenceValue getComparisonReferenceValue (self, int i)
str getComparisonReferenceValueName (self, int i)
ObjectComparableWithReference.ComparisonTolerance getComparisonTolerence (self, int i)
Vector3f getLocalPoint (self, ConstViewportId id=...)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
Vector3f getWorldPoint (self, ConstViewportId id=...)
int numComparableProperties (self)
int numComparisonReferenceValues (self)
Object shallowClone (self)
bool supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
str typeName (self)
Public Member Functions inherited from mrmeshpy.ConstMeasurementObject
 __init__ (self, *args, **kwargs)
Public Member Functions inherited from mrmeshpy.ConstVisualObject
 __init__ (self, *args, **kwargs)
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)
int heapBytes (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 hasModel (self)
bool hasVisualRepresentation (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 StaticClassName ()
str StaticClassNameInPlural ()
str StaticTypeName ()
Static Public Member Functions inherited from mrmeshpy.ConstVisualObject
Box3f getWorldBox (*args, **kwargs)
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::PointMeasurementObject

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ className()

str mrmeshpy.ConstPointMeasurementObject.className ( self)

Reimplemented from mrmeshpy.ConstVisualObject.

◆ classNameInPlural()

str mrmeshpy.ConstPointMeasurementObject.classNameInPlural ( self)

Reimplemented from mrmeshpy.ConstVisualObject.

◆ clone()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ comparisonToleranceIsAlwaysOnlyPositive()

bool mrmeshpy.ConstPointMeasurementObject.comparisonToleranceIsAlwaysOnlyPositive ( self,
int i )
If true, indicates that the getter will always return zero negative tolerance, and the setter will ignore the negative tolerance.
`i` goes up to `numComparableProperties()`, exclusive.

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ computeComparableProperty()

ObjectComparableWithReference.ComparableProperty mrmeshpy.ConstPointMeasurementObject.computeComparableProperty ( self,
int i )
Compute a value of a property.
Compare `value` and `referenceValue` using the tolerance.
This can return null if the value is impossible to compute, e.g. for some types if the reference isn't set (e.g. if
  we're computing the distance to a reference point).
`i` goes up to `numComparableProperties()`, exclusive.

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ getAllVisualizeProperties()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getComparablePropertyName()

str mrmeshpy.ConstPointMeasurementObject.getComparablePropertyName ( self,
int i )
`i` goes up to `numComparableProperties()`, exclusive.

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ getComparisonReferenceValue()

ObjectComparableWithReference.ComparisonReferenceValue mrmeshpy.ConstPointMeasurementObject.getComparisonReferenceValue ( self,
int i )
Returns the internal reference value.
If the value wasn't set yet (as indicated by `isSet == false`), you can still use the returned variant to get the expected type.
`i` goes up to `numComparisonReferenceValues()`, exclusive.

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ getComparisonReferenceValueName()

str mrmeshpy.ConstPointMeasurementObject.getComparisonReferenceValueName ( self,
int i )
`i` goes up to `numComparisonReferenceValues()`, exclusive.

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ getComparisonTolerence()

ObjectComparableWithReference.ComparisonTolerance mrmeshpy.ConstPointMeasurementObject.getComparisonTolerence ( self,
int i )
Returns the tolerance for a specific comparable property. Returns null if not set.
`i` goes up to `numComparableProperties()`, exclusive.

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ getLocalPoint()

Vector3f mrmeshpy.ConstPointMeasurementObject.getLocalPoint ( self,
ConstViewportId id = ... )
calculates point from xf

◆ getVisualizePropertyMask()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getWorldPoint()

Vector3f mrmeshpy.ConstPointMeasurementObject.getWorldPoint ( self,
ConstViewportId id = ... )

◆ numComparableProperties()

int mrmeshpy.ConstPointMeasurementObject.numComparableProperties ( self)
Implement `ObjectComparableWithReference`:

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ numComparisonReferenceValues()

int mrmeshpy.ConstPointMeasurementObject.numComparisonReferenceValues ( self)
This returns 2: the point, and the optional normal direction. The normal doesn't need to be normalized, its length doesn't affect calculations.
If the normal isn't specified, the Euclidean distance gets used.

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ shallowClone()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticClassName()

str mrmeshpy.ConstPointMeasurementObject.StaticClassName ( )
static
return human readable name of subclass

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticClassNameInPlural()

str mrmeshpy.ConstPointMeasurementObject.StaticClassNameInPlural ( )
static
return human readable name of subclass in plural form

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticTypeName()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ supportsVisualizeProperty()

bool mrmeshpy.ConstPointMeasurementObject.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.ConstPointMeasurementObject.typeName ( self)

Reimplemented from mrmeshpy.ConstVisualObject.


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