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

Classes

class  ComparableProperty
class  ComparisonReferenceValue
class  ComparisonTolerance
class  ConstComparableProperty
class  ConstComparisonReferenceValue
class  ConstComparisonTolerance

Public Member Functions

bool comparisonToleranceIsAlwaysOnlyPositive (self, int i)
ObjectComparableWithReference.ComparableProperty computeComparableProperty (self, int i)
str getComparablePropertyName (self, int i)
ObjectComparableWithReference.ComparisonReferenceValue getComparisonReferenceValue (self, int i)
str getComparisonReferenceValueName (self, int i)
ObjectComparableWithReference.ComparisonTolerance getComparisonTolerence (self, int i)
int numComparableProperties (self)
int numComparisonReferenceValues (self)

Detailed Description

Generated from:  MR::ObjectComparableWithReference

A base class for a data-model object that is a feature/measurement that can be compared between two models.

Member Function Documentation

◆ comparisonToleranceIsAlwaysOnlyPositive()

bool mrmeshpy.ConstObjectComparableWithReference.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 in mrmeshpy.ConstPointMeasurementObject.

◆ computeComparableProperty()

ObjectComparableWithReference.ComparableProperty mrmeshpy.ConstObjectComparableWithReference.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 in mrmeshpy.ConstDistanceMeasurementObject, and mrmeshpy.ConstPointMeasurementObject.

◆ getComparablePropertyName()

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

Reimplemented in mrmeshpy.ConstDistanceMeasurementObject, and mrmeshpy.ConstPointMeasurementObject.

◆ getComparisonReferenceValue()

ObjectComparableWithReference.ComparisonReferenceValue mrmeshpy.ConstObjectComparableWithReference.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 in mrmeshpy.ConstDistanceMeasurementObject, and mrmeshpy.ConstPointMeasurementObject.

◆ getComparisonReferenceValueName()

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

Reimplemented in mrmeshpy.ConstDistanceMeasurementObject, and mrmeshpy.ConstPointMeasurementObject.

◆ getComparisonTolerence()

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

Reimplemented in mrmeshpy.ConstDistanceMeasurementObject, and mrmeshpy.ConstPointMeasurementObject.

◆ numComparableProperties()

int mrmeshpy.ConstObjectComparableWithReference.numComparableProperties ( self)
When comparing this object with a reference, how many different properties can we output?

Reimplemented in mrmeshpy.ConstDistanceMeasurementObject, and mrmeshpy.ConstPointMeasurementObject.

◆ numComparisonReferenceValues()

int mrmeshpy.ConstObjectComparableWithReference.numComparisonReferenceValues ( self)
The number and types of reference values can be entirely different compared to `numComparableProperties()`.

Reimplemented in mrmeshpy.ConstPointMeasurementObject.


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