MRDistanceMeasurementObject.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMesh/MRVector3.h>
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct MR_MeasurementObject MR_MeasurementObject; // Defined in `#include <MRCMesh/MRMeasurementObject.h>`.
typedef struct MR_Object MR_Object; // Defined in `#include <MRCMesh/MRObject.h>`.
typedef struct MR_ObjectChildrenHolder MR_ObjectChildrenHolder; // Defined in `#include <MRCMesh/MRObject.h>`.
typedef struct MR_ObjectComparableWithReference MR_ObjectComparableWithReference; // Defined in `#include <MRCMesh/MRObjectComparableWithReference.h>`.
typedef struct MR_ObjectComparableWithReference_ComparisonReferenceValue MR_ObjectComparableWithReference_ComparisonReferenceValue; // Defined in `#include <MRCMesh/MRObjectComparableWithReference.h>`.
typedef struct MR_ObjectComparableWithReference_ComparisonTolerance MR_ObjectComparableWithReference_ComparisonTolerance; // Defined in `#include <MRCMesh/MRObjectComparableWithReference.h>`.
typedef struct MR_VisualObject MR_VisualObject; // Defined in `#include <MRCMesh/MRVisualObject.h>`.
typedef struct MR_std_optional_MR_ObjectComparableWithReference_ComparableProperty MR_std_optional_MR_ObjectComparableWithReference_ComparableProperty; // Defined in `#include <MRCMisc/std_optional_MR_ObjectComparableWithReference_ComparableProperty.h>`.
typedef struct MR_std_optional_MR_ObjectComparableWithReference_ComparisonTolerance MR_std_optional_MR_ObjectComparableWithReference_ComparisonTolerance; // Defined in `#include <MRCMisc/std_optional_MR_ObjectComparableWithReference_ComparisonTolerance.h>`.
typedef struct MR_std_shared_ptr_MR_Object MR_std_shared_ptr_MR_Object; // Defined in `#include <MRCMisc/std_shared_ptr_MR_Object.h>`.
typedef struct MR_std_string MR_std_string; // Defined in `#include <MRCMisc/std_string.h>`.
typedef struct MR_std_string_view MR_std_string_view; // Defined in `#include <MRCMisc/std_string_view.h>`.
typedef struct MR_std_variant_float_MR_Vector3f MR_std_variant_float_MR_Vector3f; // Defined in `#include <MRCMisc/std_variant_float_MR_Vector3f.h>`.
typedef struct MR_std_vector_std_string MR_std_vector_std_string; // Defined in `#include <MRCMisc/std_vector_std_string.h>`.
 
 
// Represents a distance measurement.
typedef struct MR_DistanceMeasurementObject MR_DistanceMeasurementObject;
 
typedef enum MR_DistanceMeasurementObject_DistanceMode
{
    // Euclidean distance.
    MR_DistanceMeasurementObject_DistanceMode_euclidean = 0,
    // Euclidean distance, but also display per-axis deltas with signs.
    MR_DistanceMeasurementObject_DistanceMode_euclideanWithSignedDeltasPerAxis = 1,
    // Euclidean distance, but also display per-axis deltas without signs.
    MR_DistanceMeasurementObject_DistanceMode_euclideanWithAbsoluteDeltasPerAxis = 2,
    // Absolute distance in one axis.
    // This can still be made negative by `setIsNegative(true)`. The point is that the real sign is ignored.
    MR_DistanceMeasurementObject_DistanceMode_xAbsolute = 3,
    // Absolute distance in one axis.
    // This can still be made negative by `setIsNegative(true)`. The point is that the real sign is ignored.
    MR_DistanceMeasurementObject_DistanceMode_yAbsolute = 4,
    // Absolute distance in one axis.
    // This can still be made negative by `setIsNegative(true)`. The point is that the real sign is ignored.
    MR_DistanceMeasurementObject_DistanceMode_zAbsolute = 5,
} MR_DistanceMeasurementObject_DistanceMode;
 
MRC_API MR_DistanceMeasurementObject *MR_DistanceMeasurementObject_DefaultConstruct(void);
 
MRC_API MR_DistanceMeasurementObject *MR_DistanceMeasurementObject_DefaultConstructArray(size_t num_elems);
 
MRC_API const MR_DistanceMeasurementObject *MR_DistanceMeasurementObject_OffsetPtr(const MR_DistanceMeasurementObject *ptr, ptrdiff_t i);
 
MRC_API MR_DistanceMeasurementObject *MR_DistanceMeasurementObject_OffsetMutablePtr(MR_DistanceMeasurementObject *ptr, ptrdiff_t i);
 
MRC_API const MR_MeasurementObject *MR_DistanceMeasurementObject_UpcastTo_MR_MeasurementObject(const MR_DistanceMeasurementObject *object);
 
MRC_API MR_MeasurementObject *MR_DistanceMeasurementObject_MutableUpcastTo_MR_MeasurementObject(MR_DistanceMeasurementObject *object);
 
MRC_API const MR_Object *MR_DistanceMeasurementObject_UpcastTo_MR_Object(const MR_DistanceMeasurementObject *object);
 
MRC_API MR_Object *MR_DistanceMeasurementObject_MutableUpcastTo_MR_Object(MR_DistanceMeasurementObject *object);
 
MRC_API const MR_ObjectChildrenHolder *MR_DistanceMeasurementObject_UpcastTo_MR_ObjectChildrenHolder(const MR_DistanceMeasurementObject *object);
 
MRC_API MR_ObjectChildrenHolder *MR_DistanceMeasurementObject_MutableUpcastTo_MR_ObjectChildrenHolder(MR_DistanceMeasurementObject *object);
 
MRC_API const MR_ObjectComparableWithReference *MR_DistanceMeasurementObject_UpcastTo_MR_ObjectComparableWithReference(const MR_DistanceMeasurementObject *object);
 
MRC_API MR_ObjectComparableWithReference *MR_DistanceMeasurementObject_MutableUpcastTo_MR_ObjectComparableWithReference(MR_DistanceMeasurementObject *object);
 
MRC_API const MR_VisualObject *MR_DistanceMeasurementObject_UpcastTo_MR_VisualObject(const MR_DistanceMeasurementObject *object);
 
MRC_API MR_VisualObject *MR_DistanceMeasurementObject_MutableUpcastTo_MR_VisualObject(MR_DistanceMeasurementObject *object);
 
MRC_API MR_DistanceMeasurementObject *MR_DistanceMeasurementObject_ConstructFromAnother(MR_PassBy _other_pass_by, MR_DistanceMeasurementObject *_other);
 
MRC_API void MR_DistanceMeasurementObject_Destroy(const MR_DistanceMeasurementObject *_this);
 
MRC_API void MR_DistanceMeasurementObject_DestroyArray(const MR_DistanceMeasurementObject *_this);
 
MRC_API MR_DistanceMeasurementObject *MR_DistanceMeasurementObject_AssignFromAnother(MR_DistanceMeasurementObject *_this, MR_PassBy _other_pass_by, MR_DistanceMeasurementObject *_other);
 
MRC_API const char *MR_DistanceMeasurementObject_TypeName(void);
 
MRC_API const char *MR_DistanceMeasurementObject_typeName(const MR_DistanceMeasurementObject *_this);
 
MRC_API const char *MR_DistanceMeasurementObject_ClassName(void);
 
MRC_API MR_std_string *MR_DistanceMeasurementObject_className(const MR_DistanceMeasurementObject *_this);
 
MRC_API const char *MR_DistanceMeasurementObject_ClassNameInPlural(void);
 
MRC_API MR_std_string *MR_DistanceMeasurementObject_classNameInPlural(const MR_DistanceMeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_DistanceMeasurementObject_clone(const MR_DistanceMeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_DistanceMeasurementObject_shallowClone(const MR_DistanceMeasurementObject *_this);
 
// Get the starting point in world coordinates.
MRC_API MR_Vector3f MR_DistanceMeasurementObject_getWorldPoint(const MR_DistanceMeasurementObject *_this);
 
// Get the starting point in local coordinates.
MRC_API MR_Vector3f MR_DistanceMeasurementObject_getLocalPoint(const MR_DistanceMeasurementObject *_this);
 
// The delta from the starting point to the other point.
MRC_API MR_Vector3f MR_DistanceMeasurementObject_getWorldDelta(const MR_DistanceMeasurementObject *_this);
 
MRC_API MR_Vector3f MR_DistanceMeasurementObject_getLocalDelta(const MR_DistanceMeasurementObject *_this);
 
// Set the start point in the local coordinates.
MRC_API void MR_DistanceMeasurementObject_setLocalPoint(MR_DistanceMeasurementObject *_this, const MR_Vector3f *point);
 
// Set the delta vector in the local coordinates.
MRC_API void MR_DistanceMeasurementObject_setLocalDelta(MR_DistanceMeasurementObject *_this, const MR_Vector3f *delta);
 
// Whether the distance should be displayed as a negative one.
MRC_API bool MR_DistanceMeasurementObject_isNegative(const MR_DistanceMeasurementObject *_this);
 
MRC_API void MR_DistanceMeasurementObject_setIsNegative(MR_DistanceMeasurementObject *_this, bool value);
 
// Whether we should draw the individual X/Y/Z deltas in addition to the distance itself.
MRC_API MR_DistanceMeasurementObject_DistanceMode MR_DistanceMeasurementObject_getDistanceMode(const MR_DistanceMeasurementObject *_this);
 
MRC_API void MR_DistanceMeasurementObject_setDistanceMode(MR_DistanceMeasurementObject *_this, MR_DistanceMeasurementObject_DistanceMode mode);
 
// Computes the distance value. This is affected by `getDistanceMode()`.
// In `euclidean`, this is `getWorldDelta().length() * (isNegative() ? -1 : 1)`.
MRC_API float MR_DistanceMeasurementObject_computeDistance(const MR_DistanceMeasurementObject *_this);
 
MRC_API MR_std_vector_std_string *MR_DistanceMeasurementObject_getInfoLines(const MR_DistanceMeasurementObject *_this);
 
// Implement `ObjectComparableWithReference`:
MRC_API MR_uint64_t MR_DistanceMeasurementObject_numComparableProperties(const MR_DistanceMeasurementObject *_this);
 
MRC_API MR_std_string_view *MR_DistanceMeasurementObject_getComparablePropertyName(const MR_DistanceMeasurementObject *_this, MR_uint64_t i);
 
MRC_API MR_std_optional_MR_ObjectComparableWithReference_ComparableProperty *MR_DistanceMeasurementObject_computeComparableProperty(const MR_DistanceMeasurementObject *_this, MR_uint64_t i);
 
MRC_API MR_std_optional_MR_ObjectComparableWithReference_ComparisonTolerance *MR_DistanceMeasurementObject_getComparisonTolerence(const MR_DistanceMeasurementObject *_this, MR_uint64_t i);
 
MRC_API void MR_DistanceMeasurementObject_setComparisonTolerance(MR_DistanceMeasurementObject *_this, MR_uint64_t i, const MR_ObjectComparableWithReference_ComparisonTolerance *newTolerance);
 
MRC_API MR_std_string_view *MR_DistanceMeasurementObject_getComparisonReferenceValueName(const MR_DistanceMeasurementObject *_this, MR_uint64_t i);
 
MRC_API MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_DistanceMeasurementObject_getComparisonReferenceValue(const MR_DistanceMeasurementObject *_this, MR_uint64_t i);
 
MRC_API void MR_DistanceMeasurementObject_setComparisonReferenceValue(MR_DistanceMeasurementObject *_this, MR_uint64_t i, const MR_std_variant_float_MR_Vector3f *value);
 
#ifdef __cplusplus
} // extern "C"
#endif