MRPointMeasurementObject.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMesh/MRVector3.h>
#include <MRCMesh/MRViewportId.h>
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct MR_AnyVisualizeMaskEnum MR_AnyVisualizeMaskEnum; // Defined in `#include <MRCMesh/MRVisualObject.h>`.
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_ViewportMask MR_ViewportMask; // Defined in `#include <MRCMesh/MRViewportId.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_MR_ViewportMask MR_std_vector_MR_ViewportMask; // Defined in `#include <MRCMisc/std_vector_MR_ViewportMask.h>`.
 
 
typedef enum MR_PointMeasurementVisualizePropertyType
{
    MR_PointMeasurementVisualizePropertyType_CapVisibility = 0,
    MR_PointMeasurementVisualizePropertyType__count = 1,
} MR_PointMeasurementVisualizePropertyType;
 
typedef struct MR_PointMeasurementObject MR_PointMeasurementObject;
 
MRC_API MR_PointMeasurementObject *MR_PointMeasurementObject_DefaultConstruct(void);
 
MRC_API MR_PointMeasurementObject *MR_PointMeasurementObject_DefaultConstructArray(size_t num_elems);
 
MRC_API const MR_PointMeasurementObject *MR_PointMeasurementObject_OffsetPtr(const MR_PointMeasurementObject *ptr, ptrdiff_t i);
 
MRC_API MR_PointMeasurementObject *MR_PointMeasurementObject_OffsetMutablePtr(MR_PointMeasurementObject *ptr, ptrdiff_t i);
 
MRC_API const MR_MeasurementObject *MR_PointMeasurementObject_UpcastTo_MR_MeasurementObject(const MR_PointMeasurementObject *object);
 
MRC_API MR_MeasurementObject *MR_PointMeasurementObject_MutableUpcastTo_MR_MeasurementObject(MR_PointMeasurementObject *object);
 
MRC_API const MR_Object *MR_PointMeasurementObject_UpcastTo_MR_Object(const MR_PointMeasurementObject *object);
 
MRC_API MR_Object *MR_PointMeasurementObject_MutableUpcastTo_MR_Object(MR_PointMeasurementObject *object);
 
MRC_API const MR_ObjectChildrenHolder *MR_PointMeasurementObject_UpcastTo_MR_ObjectChildrenHolder(const MR_PointMeasurementObject *object);
 
MRC_API MR_ObjectChildrenHolder *MR_PointMeasurementObject_MutableUpcastTo_MR_ObjectChildrenHolder(MR_PointMeasurementObject *object);
 
MRC_API const MR_ObjectComparableWithReference *MR_PointMeasurementObject_UpcastTo_MR_ObjectComparableWithReference(const MR_PointMeasurementObject *object);
 
MRC_API MR_ObjectComparableWithReference *MR_PointMeasurementObject_MutableUpcastTo_MR_ObjectComparableWithReference(MR_PointMeasurementObject *object);
 
MRC_API const MR_VisualObject *MR_PointMeasurementObject_UpcastTo_MR_VisualObject(const MR_PointMeasurementObject *object);
 
MRC_API MR_VisualObject *MR_PointMeasurementObject_MutableUpcastTo_MR_VisualObject(MR_PointMeasurementObject *object);
 
MRC_API MR_PointMeasurementObject *MR_PointMeasurementObject_ConstructFromAnother(MR_PassBy _other_pass_by, MR_PointMeasurementObject *_other);
 
MRC_API void MR_PointMeasurementObject_Destroy(const MR_PointMeasurementObject *_this);
 
MRC_API void MR_PointMeasurementObject_DestroyArray(const MR_PointMeasurementObject *_this);
 
MRC_API MR_PointMeasurementObject *MR_PointMeasurementObject_AssignFromAnother(MR_PointMeasurementObject *_this, MR_PassBy _other_pass_by, MR_PointMeasurementObject *_other);
 
MRC_API const char *MR_PointMeasurementObject_TypeName(void);
 
MRC_API const char *MR_PointMeasurementObject_typeName(const MR_PointMeasurementObject *_this);
 
MRC_API const char *MR_PointMeasurementObject_ClassName(void);
 
MRC_API MR_std_string *MR_PointMeasurementObject_className(const MR_PointMeasurementObject *_this);
 
MRC_API const char *MR_PointMeasurementObject_ClassNameInPlural(void);
 
MRC_API MR_std_string *MR_PointMeasurementObject_classNameInPlural(const MR_PointMeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_PointMeasurementObject_clone(const MR_PointMeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_PointMeasurementObject_shallowClone(const MR_PointMeasurementObject *_this);
 
MRC_API bool MR_PointMeasurementObject_supportsVisualizeProperty(const MR_PointMeasurementObject *_this, const MR_AnyVisualizeMaskEnum *type);
 
MRC_API MR_std_vector_MR_ViewportMask *MR_PointMeasurementObject_getAllVisualizeProperties(const MR_PointMeasurementObject *_this);
 
MRC_API const MR_ViewportMask *MR_PointMeasurementObject_getVisualizePropertyMask(const MR_PointMeasurementObject *_this, const MR_AnyVisualizeMaskEnum *type);
 
MRC_API MR_Vector3f MR_PointMeasurementObject_getLocalPoint(const MR_PointMeasurementObject *_this, const MR_ViewportId *id);
 
MRC_API MR_Vector3f MR_PointMeasurementObject_getWorldPoint(const MR_PointMeasurementObject *_this, const MR_ViewportId *id);
 
MRC_API void MR_PointMeasurementObject_setLocalPoint(MR_PointMeasurementObject *_this, const MR_Vector3f *point, const MR_ViewportId *id);
 
MRC_API void MR_PointMeasurementObject_setWorldPoint(MR_PointMeasurementObject *_this, const MR_Vector3f *point, const MR_ViewportId *id);
 
// Implement `ObjectComparableWithReference`:
MRC_API MR_uint64_t MR_PointMeasurementObject_numComparableProperties(const MR_PointMeasurementObject *_this);
 
MRC_API MR_std_string_view *MR_PointMeasurementObject_getComparablePropertyName(const MR_PointMeasurementObject *_this, MR_uint64_t i);
 
MRC_API MR_std_optional_MR_ObjectComparableWithReference_ComparableProperty *MR_PointMeasurementObject_computeComparableProperty(const MR_PointMeasurementObject *_this, MR_uint64_t i);
 
MRC_API MR_std_optional_MR_ObjectComparableWithReference_ComparisonTolerance *MR_PointMeasurementObject_getComparisonTolerence(const MR_PointMeasurementObject *_this, MR_uint64_t i);
 
MRC_API void MR_PointMeasurementObject_setComparisonTolerance(MR_PointMeasurementObject *_this, MR_uint64_t i, const MR_ObjectComparableWithReference_ComparisonTolerance *newTolerance);
 
MRC_API bool MR_PointMeasurementObject_comparisonToleranceIsAlwaysOnlyPositive(const MR_PointMeasurementObject *_this, MR_uint64_t i);
 
// This returns 2: the point, and the optional normal direction. The normal doesn't need to be normalized, its length doesn't affect calculations.
// If the normal isn't specified, the Euclidean distance gets used.
MRC_API MR_uint64_t MR_PointMeasurementObject_numComparisonReferenceValues(const MR_PointMeasurementObject *_this);
 
MRC_API MR_std_string_view *MR_PointMeasurementObject_getComparisonReferenceValueName(const MR_PointMeasurementObject *_this, MR_uint64_t i);
 
MRC_API MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_PointMeasurementObject_getComparisonReferenceValue(const MR_PointMeasurementObject *_this, MR_uint64_t i);
 
MRC_API void MR_PointMeasurementObject_setComparisonReferenceValue(MR_PointMeasurementObject *_this, MR_uint64_t i, const MR_std_variant_float_MR_Vector3f *value);
 
#ifdef __cplusplus
} // extern "C"
#endif