mrmeshpy.ObjectComparableWithReference Class Reference

Inheritance diagram for mrmeshpy.ObjectComparableWithReference:

Classes
class	ComparableProperty
class	ComparisonReferenceValue
class	ComparisonTolerance

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)
None	setComparisonReferenceVal (self, int i, ObjectComparableWithReference.ComparisonReferenceValue value)
None	setComparisonReferenceValue (self, int i, std_optional_std_variant_float_Vector3_float value)
None	setComparisonTolerance (self, int i, std_optional_ObjectComparableWithReference_ComparisonTolerance newTolerance)

Static Public Member Functions
ObjectComparableWithReference	operator (*args, **kwargs)

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.ObjectComparableWithReference.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.PointMeasurementObject.

computeComparableProperty()

ObjectComparableWithReference.ComparableProperty mrmeshpy.ObjectComparableWithReference.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.DistanceMeasurementObject, and mrmeshpy.PointMeasurementObject.

getComparablePropertyName()

str mrmeshpy.ObjectComparableWithReference.getComparablePropertyName	(		self,
		int	i )

`i` goes up to `numComparableProperties()`, exclusive.

Reimplemented in mrmeshpy.DistanceMeasurementObject, and mrmeshpy.PointMeasurementObject.

getComparisonReferenceValue()

ObjectComparableWithReference.ComparisonReferenceValue mrmeshpy.ObjectComparableWithReference.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.DistanceMeasurementObject, and mrmeshpy.PointMeasurementObject.

getComparisonReferenceValueName()

str mrmeshpy.ObjectComparableWithReference.getComparisonReferenceValueName	(		self,
		int	i )

`i` goes up to `numComparisonReferenceValues()`, exclusive.

Reimplemented in mrmeshpy.DistanceMeasurementObject, and mrmeshpy.PointMeasurementObject.

getComparisonTolerence()

ObjectComparableWithReference.ComparisonTolerance mrmeshpy.ObjectComparableWithReference.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.DistanceMeasurementObject, and mrmeshpy.PointMeasurementObject.

numComparableProperties()

int mrmeshpy.ObjectComparableWithReference.numComparableProperties

(

self

)

When comparing this object with a reference, how many different properties can we output?

Reimplemented in mrmeshpy.DistanceMeasurementObject, and mrmeshpy.PointMeasurementObject.

numComparisonReferenceValues()

int mrmeshpy.ObjectComparableWithReference.numComparisonReferenceValues

(

self

)

The number and types of reference values can be entirely different compared to `numComparableProperties()`.

Reimplemented in mrmeshpy.PointMeasurementObject.

operator()

ObjectComparableWithReference mrmeshpy.ObjectComparableWithReference.operator ( * args, ** kwargs )

static

setComparisonReferenceVal()

None mrmeshpy.ObjectComparableWithReference.setComparisonReferenceVal	(		self,
		int	i,
		ObjectComparableWithReference.ComparisonReferenceValue	value )

setComparisonReferenceValue()

None mrmeshpy.ObjectComparableWithReference.setComparisonReferenceValue	(		self,
		int	i,
		std_optional_std_variant_float_Vector3_float	value )

Sets the internal reference value. Makes `hasComparisonReferenceValue()` return true.
If you pass nullopt, removes this reference value.
Only a certain variant type is legal to pass, depending on the derived class and the index. Use `getComparisonReferenceValue()` to determine that type.
`i` goes up to `numComparisonReferenceValues()`, exclusive.

Reimplemented in mrmeshpy.DistanceMeasurementObject, and mrmeshpy.PointMeasurementObject.

setComparisonTolerance()

None mrmeshpy.ObjectComparableWithReference.setComparisonTolerance	(		self,
		int	i,
		std_optional_ObjectComparableWithReference_ComparisonTolerance	newTolerance )

Sets the tolerance for a specific comparable property.
`i` goes up to `numComparableProperties()`, exclusive.

Reimplemented in mrmeshpy.DistanceMeasurementObject, and mrmeshpy.PointMeasurementObject.

---

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

• mrmeshpy.pyi