MRRadiusMeasurementObject.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_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 radius measurement.
typedef struct MR_RadiusMeasurementObject MR_RadiusMeasurementObject;
 
MRC_API MR_RadiusMeasurementObject *MR_RadiusMeasurementObject_DefaultConstruct(void);
 
MRC_API MR_RadiusMeasurementObject *MR_RadiusMeasurementObject_DefaultConstructArray(size_t num_elems);
 
MRC_API const MR_RadiusMeasurementObject *MR_RadiusMeasurementObject_OffsetPtr(const MR_RadiusMeasurementObject *ptr, ptrdiff_t i);
 
MRC_API MR_RadiusMeasurementObject *MR_RadiusMeasurementObject_OffsetMutablePtr(MR_RadiusMeasurementObject *ptr, ptrdiff_t i);
 
MRC_API const MR_MeasurementObject *MR_RadiusMeasurementObject_UpcastTo_MR_MeasurementObject(const MR_RadiusMeasurementObject *object);
 
MRC_API MR_MeasurementObject *MR_RadiusMeasurementObject_MutableUpcastTo_MR_MeasurementObject(MR_RadiusMeasurementObject *object);
 
MRC_API const MR_Object *MR_RadiusMeasurementObject_UpcastTo_MR_Object(const MR_RadiusMeasurementObject *object);
 
MRC_API MR_Object *MR_RadiusMeasurementObject_MutableUpcastTo_MR_Object(MR_RadiusMeasurementObject *object);
 
MRC_API const MR_ObjectChildrenHolder *MR_RadiusMeasurementObject_UpcastTo_MR_ObjectChildrenHolder(const MR_RadiusMeasurementObject *object);
 
MRC_API MR_ObjectChildrenHolder *MR_RadiusMeasurementObject_MutableUpcastTo_MR_ObjectChildrenHolder(MR_RadiusMeasurementObject *object);
 
MRC_API const MR_VisualObject *MR_RadiusMeasurementObject_UpcastTo_MR_VisualObject(const MR_RadiusMeasurementObject *object);
 
MRC_API MR_VisualObject *MR_RadiusMeasurementObject_MutableUpcastTo_MR_VisualObject(MR_RadiusMeasurementObject *object);
 
MRC_API MR_RadiusMeasurementObject *MR_RadiusMeasurementObject_ConstructFromAnother(MR_PassBy _other_pass_by, MR_RadiusMeasurementObject *_other);
 
MRC_API void MR_RadiusMeasurementObject_Destroy(const MR_RadiusMeasurementObject *_this);
 
MRC_API void MR_RadiusMeasurementObject_DestroyArray(const MR_RadiusMeasurementObject *_this);
 
MRC_API MR_RadiusMeasurementObject *MR_RadiusMeasurementObject_AssignFromAnother(MR_RadiusMeasurementObject *_this, MR_PassBy _other_pass_by, MR_RadiusMeasurementObject *_other);
 
MRC_API const char *MR_RadiusMeasurementObject_TypeName(void);
 
MRC_API const char *MR_RadiusMeasurementObject_typeName(const MR_RadiusMeasurementObject *_this);
 
MRC_API MR_std_string *MR_RadiusMeasurementObject_getClassName(const MR_RadiusMeasurementObject *_this);
 
MRC_API MR_std_string *MR_RadiusMeasurementObject_getClassNameInPlural(const MR_RadiusMeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_RadiusMeasurementObject_clone(const MR_RadiusMeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_RadiusMeasurementObject_shallowClone(const MR_RadiusMeasurementObject *_this);
 
// Get the center in world coordinates.
MRC_API MR_Vector3f MR_RadiusMeasurementObject_getWorldCenter(const MR_RadiusMeasurementObject *_this);
 
// Get the center in local coordinates.
MRC_API MR_Vector3f MR_RadiusMeasurementObject_getLocalCenter(const MR_RadiusMeasurementObject *_this);
 
// The length of this vector is the radius, and the direction is the preferred line drawing direction.
MRC_API MR_Vector3f MR_RadiusMeasurementObject_getWorldRadiusAsVector(const MR_RadiusMeasurementObject *_this);
 
MRC_API MR_Vector3f MR_RadiusMeasurementObject_getLocalRadiusAsVector(const MR_RadiusMeasurementObject *_this);
 
// The preferred radius normal, for non-spherical radiuses.
MRC_API MR_Vector3f MR_RadiusMeasurementObject_getWorldNormal(const MR_RadiusMeasurementObject *_this);
 
MRC_API MR_Vector3f MR_RadiusMeasurementObject_getLocalNormal(const MR_RadiusMeasurementObject *_this);
 
MRC_API void MR_RadiusMeasurementObject_setLocalCenter(MR_RadiusMeasurementObject *_this, const MR_Vector3f *center);
 
// Sets the local radius vector (the length of which is the radius value),
//   and also the radius normal (which is ignored for spherical radiuses).
// The normal is automatically normalized and made perpendicular to the `radiusVec`.
MRC_API void MR_RadiusMeasurementObject_setLocalRadiusAsVector_2(MR_RadiusMeasurementObject *_this, const MR_Vector3f *radiusVec, const MR_Vector3f *normal);
 
// Same, but without a preferred normal.
MRC_API void MR_RadiusMeasurementObject_setLocalRadiusAsVector_1(MR_RadiusMeasurementObject *_this, const MR_Vector3f *radiusVec);
 
// Whether we should draw this as a diameter instead of a radius.
MRC_API bool MR_RadiusMeasurementObject_getDrawAsDiameter(const MR_RadiusMeasurementObject *_this);
 
MRC_API void MR_RadiusMeasurementObject_setDrawAsDiameter(MR_RadiusMeasurementObject *_this, bool value);
 
// Whether this is a sphere radius, as opposed to circle/cylinder radius.
MRC_API bool MR_RadiusMeasurementObject_getIsSpherical(const MR_RadiusMeasurementObject *_this);
 
MRC_API void MR_RadiusMeasurementObject_setIsSpherical(MR_RadiusMeasurementObject *_this, bool value);
 
// The visual leader line length multiplier, relative to the radius.
// You're recommended to set a min absolute value for the resulting length when rendering.
MRC_API float MR_RadiusMeasurementObject_getVisualLengthMultiplier(const MR_RadiusMeasurementObject *_this);
 
MRC_API void MR_RadiusMeasurementObject_setVisualLengthMultiplier(MR_RadiusMeasurementObject *_this, float value);
 
// Computes the radius/diameter value, as if by `getLocalRadiusAsVector()`, possibly multiplied by two if `getDrawAsDiameter()`.
MRC_API float MR_RadiusMeasurementObject_computeRadiusOrDiameter(const MR_RadiusMeasurementObject *_this);
 
MRC_API MR_std_vector_std_string *MR_RadiusMeasurementObject_getInfoLines(const MR_RadiusMeasurementObject *_this);
 
#ifdef __cplusplus
} // extern "C"
#endif