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>
#include <stdint.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_VisualObject MR_VisualObject; // Defined in `#include <MRCMesh/MRVisualObject.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_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 int32_t MR_DistanceMeasurementObject_PerCoordDeltas;
enum // MR_DistanceMeasurementObject_PerCoordDeltas
{
    // Hide.
    MR_DistanceMeasurementObject_PerCoordDeltas_none = 0,
    // Display as is.
    MR_DistanceMeasurementObject_PerCoordDeltas_withSign = 1,
    // Display absolute values.
    MR_DistanceMeasurementObject_PerCoordDeltas_absolute = 2,
};
 
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_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 MR_std_string *MR_DistanceMeasurementObject_getClassName(const MR_DistanceMeasurementObject *_this);
 
MRC_API MR_std_string *MR_DistanceMeasurementObject_getClassNameInPlural(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_getDrawAsNegative(const MR_DistanceMeasurementObject *_this);
 
MRC_API void MR_DistanceMeasurementObject_setDrawAsNegative(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_PerCoordDeltas MR_DistanceMeasurementObject_getPerCoordDeltasMode(const MR_DistanceMeasurementObject *_this);
 
MRC_API void MR_DistanceMeasurementObject_setPerCoordDeltasMode(MR_DistanceMeasurementObject *_this, MR_DistanceMeasurementObject_PerCoordDeltas mode);
 
// Computes the distance value: `getWorldDelta().length() * (getDrawAsNegative() ? -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);
 
#ifdef __cplusplus
} // extern "C"
#endif