MRAngleMeasurementObject.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 an angle measurement.
typedef struct MR_AngleMeasurementObject MR_AngleMeasurementObject;
 
MRC_API MR_AngleMeasurementObject *MR_AngleMeasurementObject_DefaultConstruct(void);
 
MRC_API MR_AngleMeasurementObject *MR_AngleMeasurementObject_DefaultConstructArray(size_t num_elems);
 
MRC_API const MR_AngleMeasurementObject *MR_AngleMeasurementObject_OffsetPtr(const MR_AngleMeasurementObject *ptr, ptrdiff_t i);
 
MRC_API MR_AngleMeasurementObject *MR_AngleMeasurementObject_OffsetMutablePtr(MR_AngleMeasurementObject *ptr, ptrdiff_t i);
 
MRC_API const MR_MeasurementObject *MR_AngleMeasurementObject_UpcastTo_MR_MeasurementObject(const MR_AngleMeasurementObject *object);
 
MRC_API MR_MeasurementObject *MR_AngleMeasurementObject_MutableUpcastTo_MR_MeasurementObject(MR_AngleMeasurementObject *object);
 
MRC_API const MR_Object *MR_AngleMeasurementObject_UpcastTo_MR_Object(const MR_AngleMeasurementObject *object);
 
MRC_API MR_Object *MR_AngleMeasurementObject_MutableUpcastTo_MR_Object(MR_AngleMeasurementObject *object);
 
MRC_API const MR_ObjectChildrenHolder *MR_AngleMeasurementObject_UpcastTo_MR_ObjectChildrenHolder(const MR_AngleMeasurementObject *object);
 
MRC_API MR_ObjectChildrenHolder *MR_AngleMeasurementObject_MutableUpcastTo_MR_ObjectChildrenHolder(MR_AngleMeasurementObject *object);
 
MRC_API const MR_VisualObject *MR_AngleMeasurementObject_UpcastTo_MR_VisualObject(const MR_AngleMeasurementObject *object);
 
MRC_API MR_VisualObject *MR_AngleMeasurementObject_MutableUpcastTo_MR_VisualObject(MR_AngleMeasurementObject *object);
 
MRC_API MR_AngleMeasurementObject *MR_AngleMeasurementObject_ConstructFromAnother(MR_PassBy _other_pass_by, MR_AngleMeasurementObject *_other);
 
MRC_API void MR_AngleMeasurementObject_Destroy(const MR_AngleMeasurementObject *_this);
 
MRC_API void MR_AngleMeasurementObject_DestroyArray(const MR_AngleMeasurementObject *_this);
 
MRC_API MR_AngleMeasurementObject *MR_AngleMeasurementObject_AssignFromAnother(MR_AngleMeasurementObject *_this, MR_PassBy _other_pass_by, MR_AngleMeasurementObject *_other);
 
MRC_API const char *MR_AngleMeasurementObject_TypeName(void);
 
MRC_API const char *MR_AngleMeasurementObject_typeName(const MR_AngleMeasurementObject *_this);
 
MRC_API MR_std_string *MR_AngleMeasurementObject_getClassName(const MR_AngleMeasurementObject *_this);
 
MRC_API MR_std_string *MR_AngleMeasurementObject_getClassNameInPlural(const MR_AngleMeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_AngleMeasurementObject_clone(const MR_AngleMeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_AngleMeasurementObject_shallowClone(const MR_AngleMeasurementObject *_this);
 
// Get the angle point in world coordinates.
MRC_API MR_Vector3f MR_AngleMeasurementObject_getWorldPoint(const MR_AngleMeasurementObject *_this);
 
// Get the angle point in local coordinates.
MRC_API MR_Vector3f MR_AngleMeasurementObject_getLocalPoint(const MR_AngleMeasurementObject *_this);
 
// One of the two rays representing the angle, relative to the starting point.
// They can have length != 1 for visualization purposes, it's probably a good idea to take the smaller of the two lengths.
MRC_API MR_Vector3f MR_AngleMeasurementObject_getWorldRay(const MR_AngleMeasurementObject *_this, bool second);
 
// Same, but in local coordinates.
MRC_API MR_Vector3f MR_AngleMeasurementObject_getLocalRay(const MR_AngleMeasurementObject *_this, bool second);
 
// Set the angle point in the local coordinates.
MRC_API void MR_AngleMeasurementObject_setLocalPoint(MR_AngleMeasurementObject *_this, const MR_Vector3f *point);
 
// Set the two rays representing the angle in the local coordinates.
// The lengths are preserved.
MRC_API void MR_AngleMeasurementObject_setLocalRays(MR_AngleMeasurementObject *_this, const MR_Vector3f *a, const MR_Vector3f *b);
 
// Whether this is a conical angle. The middle line between the rays is preserved, but the rays themselves can be rotated.
MRC_API bool MR_AngleMeasurementObject_getIsConical(const MR_AngleMeasurementObject *_this);
 
MRC_API void MR_AngleMeasurementObject_setIsConical(MR_AngleMeasurementObject *_this, bool value);
 
// Whether we should draw a ray from the center point to better visualize the angle. Enable this if there isn't already a line object there.
MRC_API bool MR_AngleMeasurementObject_getShouldVisualizeRay(const MR_AngleMeasurementObject *_this, bool second);
 
MRC_API void MR_AngleMeasurementObject_setShouldVisualizeRay(MR_AngleMeasurementObject *_this, bool second, bool enable);
 
// Computes the angle value, as if by `acos(dot(...))` from the two normalized `getWorldRay()`s.
MRC_API float MR_AngleMeasurementObject_computeAngle(const MR_AngleMeasurementObject *_this);
 
MRC_API MR_std_vector_std_string *MR_AngleMeasurementObject_getInfoLines(const MR_AngleMeasurementObject *_this);
 
#ifdef __cplusplus
} // extern "C"
#endif