meshlib::ObjectComparableWithReference Struct Reference

Inheritance diagram for meshlib::ObjectComparableWithReference:

Public Member Functions
auto	num_comparable_properties () const -> usize
auto	get_comparable_property_name (i:usize) const -> meshlib::Owned< meshlib::std_string_view >
auto	compute_comparable_property (i:usize) const -> meshlib::Owned< meshlib::std_optional_MR_ObjectComparableWithReference_ComparableProperty >
auto	get_comparison_tolerence (i:usize) const -> meshlib::Owned< meshlib::std_optional_MR_ObjectComparableWithReference_ComparisonTolerance >
void	set_comparison_tolerance (i:usize, newTolerance:Option<&meshlib::ObjectComparableWithReference_ComparisonTolerance >)
auto	comparison_tolerance_is_always_only_positive (i:usize) const -> bool
auto	num_comparison_reference_values () const -> usize
auto	get_comparison_reference_value_name (i:usize) const -> meshlib::Owned< meshlib::std_string_view >
auto	get_comparison_reference_value (i:usize) const -> meshlib::Owned< meshlib::ObjectComparableWithReference_ComparisonReferenceValue >
void	set_comparison_reference_value (i:usize, value:Option<&meshlib::std_variant_float_MR_Vector3f >)
void	set_comparison_reference_val (i:usize, value:&meshlib::ObjectComparableWithReference_ComparisonReferenceValue)

Additional Inherited Members
Static Public Member Functions inherited from meshlib::CppClass
static void	destroy (ptr:*mut Self)

Detailed Description

A base class for a data-model object that is a feature/measurement that can be compared between two models. Generated from class MR::ObjectComparableWithReference. Derived classes: Direct: (non-virtual) MR::DistanceMeasurementObject MR::PointMeasurementObject

Generated from class MR::ObjectComparableWithReference. Heap-allocated instances are held in Owned<ObjectComparableWithReference>.

Member Function Documentation

comparison_tolerance_is_always_only_positive()

auto meshlib::ObjectComparableWithReference::comparison_tolerance_is_always_only_positive

(

i:usize

)

const -> bool

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. Generated from method MR::ObjectComparableWithReference::comparisonToleranceIsAlwaysOnlyPositive.

Calls MR_ObjectComparableWithReference_comparisonToleranceIsAlwaysOnlyPositive().

compute_comparable_property()

auto meshlib::ObjectComparableWithReference::compute_comparable_property

(

i:usize

)

const -> meshlib::Owned< meshlib::std_optional_MR_ObjectComparableWithReference_ComparableProperty >

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. Generated from method MR::ObjectComparableWithReference::computeComparableProperty.

Calls MR_ObjectComparableWithReference_computeComparableProperty().

get_comparable_property_name()

auto meshlib::ObjectComparableWithReference::get_comparable_property_name

(

i:usize

)

const -> meshlib::Owned< meshlib::std_string_view >

i goes up to numComparableProperties(), exclusive. Generated from method MR::ObjectComparableWithReference::getComparablePropertyName.

Calls MR_ObjectComparableWithReference_getComparablePropertyName().

get_comparison_reference_value()

auto meshlib::ObjectComparableWithReference::get_comparison_reference_value

(

i:usize

)

const -> meshlib::Owned< meshlib::ObjectComparableWithReference_ComparisonReferenceValue >

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. Generated from method MR::ObjectComparableWithReference::getComparisonReferenceValue.

Calls MR_ObjectComparableWithReference_getComparisonReferenceValue().

get_comparison_reference_value_name()

auto meshlib::ObjectComparableWithReference::get_comparison_reference_value_name

(

i:usize

)

const -> meshlib::Owned< meshlib::std_string_view >

i goes up to numComparisonReferenceValues(), exclusive. Generated from method MR::ObjectComparableWithReference::getComparisonReferenceValueName.

Calls MR_ObjectComparableWithReference_getComparisonReferenceValueName().

get_comparison_tolerence()

auto meshlib::ObjectComparableWithReference::get_comparison_tolerence

(

i:usize

)

const -> meshlib::Owned< meshlib::std_optional_MR_ObjectComparableWithReference_ComparisonTolerance >

Returns the tolerance for a specific comparable property. Returns null if not set. i goes up to numComparableProperties(), exclusive. Generated from method MR::ObjectComparableWithReference::getComparisonTolerence.

Calls MR_ObjectComparableWithReference_getComparisonTolerence().

num_comparable_properties()

auto meshlib::ObjectComparableWithReference::num_comparable_properties

(

)

const -> usize

When comparing this object with a reference, how many different properties can we output? Generated from method MR::ObjectComparableWithReference::numComparableProperties.

Calls MR_ObjectComparableWithReference_numComparableProperties().

num_comparison_reference_values()

auto meshlib::ObjectComparableWithReference::num_comparison_reference_values

(

)

const -> usize

The number and types of reference values can be entirely different compared to numComparableProperties(). Generated from method MR::ObjectComparableWithReference::numComparisonReferenceValues.

Calls MR_ObjectComparableWithReference_numComparisonReferenceValues().

set_comparison_reference_val()

void meshlib::ObjectComparableWithReference::set_comparison_reference_val	(	i:usize	,
		value:&meshlib::ObjectComparableWithReference_ComparisonReferenceValue	)

Generated from method MR::ObjectComparableWithReference::setComparisonReferenceVal.

Calls MR_ObjectComparableWithReference_setComparisonReferenceVal().

set_comparison_reference_value()

void meshlib::ObjectComparableWithReference::set_comparison_reference_value	(	i:usize	,
		value:Option<&meshlib::std_variant_float_MR_Vector3f >	)

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. Generated from method MR::ObjectComparableWithReference::setComparisonReferenceValue.

Calls MR_ObjectComparableWithReference_setComparisonReferenceValue().

set_comparison_tolerance()

void meshlib::ObjectComparableWithReference::set_comparison_tolerance	(	i:usize	,
		newTolerance:Option<&meshlib::ObjectComparableWithReference_ComparisonTolerance >	)

Sets the tolerance for a specific comparable property. i goes up to numComparableProperties(), exclusive. Generated from method MR::ObjectComparableWithReference::setComparisonTolerance.

Calls MR_ObjectComparableWithReference_setComparisonTolerance().

---

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

• MRObjectComparableWithReference.rs