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

Classes

class  DistanceMode

Public Member Functions

 __init__ (self, *args, **kwargs)
str className (self)
str classNameInPlural (self)
Object clone (self)
ObjectComparableWithReference.ComparableProperty computeComparableProperty (self, int i)
float computeDistance (self)
str getComparablePropertyName (self, int i)
ObjectComparableWithReference.ComparisonReferenceValue getComparisonReferenceValue (self, int i)
str getComparisonReferenceValueName (self, int i)
ObjectComparableWithReference.ComparisonTolerance getComparisonTolerence (self, int i)
DistanceMeasurementObject.DistanceMode getDistanceMode (self)
std_vector_std_string getInfoLines (self)
Vector3f getLocalDelta (self)
Vector3f getLocalPoint (self)
Vector3f getWorldDelta (self)
Vector3f getWorldPoint (self)
bool isNegative (self)
int numComparableProperties (self)
Object shallowClone (self)
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)
std_vector_ViewportMask getAllVisualizeProperties (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)
bool getRedrawFlag (self, ConstViewportMask viewportMask)
float getShininess (self)
float getSpecularStrength (self)
bool getVisualizeProperty (self, ConstAnyVisualizeMaskEnum type, ConstViewportMask viewportMask)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
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 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 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)
Public Member Functions inherited from mrmeshpy.ConstObjectComparableWithReference
bool comparisonToleranceIsAlwaysOnlyPositive (self, int i)
int numComparisonReferenceValues (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::DistanceMeasurementObject

Represents a distance measurement.

Constructor & Destructor Documentation

◆ __init__()

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

The xf encodes the distance: the origin is one point, and (1,0,0) is another.

Member Function Documentation

◆ className()

str mrmeshpy.ConstDistanceMeasurementObject.className ( self)

Reimplemented from mrmeshpy.ConstVisualObject.

◆ classNameInPlural()

str mrmeshpy.ConstDistanceMeasurementObject.classNameInPlural ( self)

Reimplemented from mrmeshpy.ConstVisualObject.

◆ clone()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ computeComparableProperty()

ObjectComparableWithReference.ComparableProperty mrmeshpy.ConstDistanceMeasurementObject.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.

◆ computeDistance()

float mrmeshpy.ConstDistanceMeasurementObject.computeDistance ( self)
Computes the distance value. This is affected by `getDistanceMode()`.
In `euclidean`, this is `getWorldDelta().length() * (isNegative() ? -1 : 1)`.

◆ getComparablePropertyName()

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

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ getComparisonReferenceValue()

ObjectComparableWithReference.ComparisonReferenceValue mrmeshpy.ConstDistanceMeasurementObject.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.ConstDistanceMeasurementObject.getComparisonReferenceValueName ( self,
int i )
`i` goes up to `numComparisonReferenceValues()`, exclusive.

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ getComparisonTolerence()

ObjectComparableWithReference.ComparisonTolerance mrmeshpy.ConstDistanceMeasurementObject.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.

◆ getDistanceMode()

DistanceMeasurementObject.DistanceMode mrmeshpy.ConstDistanceMeasurementObject.getDistanceMode ( self)
Whether we should draw the individual X/Y/Z deltas in addition to the distance itself.

◆ getInfoLines()

std_vector_std_string mrmeshpy.ConstDistanceMeasurementObject.getInfoLines ( self)
return several info lines that can better describe the object in the UI

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getLocalDelta()

Vector3f mrmeshpy.ConstDistanceMeasurementObject.getLocalDelta ( self)

◆ getLocalPoint()

Vector3f mrmeshpy.ConstDistanceMeasurementObject.getLocalPoint ( self)
Get the starting point in local coordinates.

◆ getWorldDelta()

Vector3f mrmeshpy.ConstDistanceMeasurementObject.getWorldDelta ( self)
The delta from the starting point to the other point.

◆ getWorldPoint()

Vector3f mrmeshpy.ConstDistanceMeasurementObject.getWorldPoint ( self)
Get the starting point in world coordinates.

◆ isNegative()

bool mrmeshpy.ConstDistanceMeasurementObject.isNegative ( self)
Whether the distance should be displayed as a negative one.

◆ numComparableProperties()

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

Reimplemented from mrmeshpy.ConstObjectComparableWithReference.

◆ shallowClone()

Object mrmeshpy.ConstDistanceMeasurementObject.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.ConstDistanceMeasurementObject.StaticClassName ( )
static
return human readable name of subclass

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticClassNameInPlural()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticTypeName()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ typeName()

str mrmeshpy.ConstDistanceMeasurementObject.typeName ( self)

Reimplemented from mrmeshpy.ConstVisualObject.


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