MRMeasurementObject.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMesh/MRAffineXf.h>
#include <MRCMesh/MRBox.h>
#include <MRCMesh/MREnums.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_AngleMeasurementObject MR_AngleMeasurementObject; // Defined in `#include <MRCMesh/MRAngleMeasurementObject.h>`.
typedef struct MR_AnyVisualizeMaskEnum MR_AnyVisualizeMaskEnum; // Defined in `#include <MRCMesh/MRVisualObject.h>`.
typedef struct MR_Color MR_Color; // Defined in `#include <MRCMesh/MRColor.h>`.
typedef struct MR_DistanceMeasurementObject MR_DistanceMeasurementObject; // Defined in `#include <MRCMesh/MRDistanceMeasurementObject.h>`.
typedef struct MR_ModelBaseRenderParams MR_ModelBaseRenderParams; // Defined in `#include <MRCMesh/MRIRenderObject.h>`.
typedef struct MR_ModelRenderParams MR_ModelRenderParams; // Defined in `#include <MRCMesh/MRIRenderObject.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_PointMeasurementObject MR_PointMeasurementObject; // Defined in `#include <MRCMesh/MRPointMeasurementObject.h>`.
typedef struct MR_RadiusMeasurementObject MR_RadiusMeasurementObject; // Defined in `#include <MRCMesh/MRRadiusMeasurementObject.h>`.
typedef struct MR_UiRenderParams MR_UiRenderParams; // Defined in `#include <MRCMesh/MRIRenderObject.h>`.
typedef struct MR_ViewportMask MR_ViewportMask; // Defined in `#include <MRCMesh/MRViewportId.h>`.
typedef struct MR_ViewportProperty_MR_AffineXf3f MR_ViewportProperty_MR_AffineXf3f; // Defined in `#include <MRCMesh/MRViewportProperty.h>`.
typedef struct MR_ViewportProperty_MR_Color MR_ViewportProperty_MR_Color; // Defined in `#include <MRCMesh/MRViewportProperty.h>`.
typedef struct MR_ViewportProperty_unsigned_char MR_ViewportProperty_unsigned_char; // Defined in `#include <MRCMesh/MRViewportProperty.h>`.
typedef struct MR_VisualObject MR_VisualObject; // Defined in `#include <MRCMesh/MRVisualObject.h>`.
typedef struct MR_std_set_std_string MR_std_set_std_string; // Defined in `#include <MRCMisc/std_set_std_string.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_MR_ViewportMask MR_std_vector_MR_ViewportMask; // Defined in `#include <MRCMisc/std_vector_MR_ViewportMask.h>`.
typedef struct MR_std_vector_std_string MR_std_vector_std_string; // Defined in `#include <MRCMisc/std_vector_std_string.h>`.
 
 
// A common base class for measurement objects.
// Can't be constructed directly.
typedef struct MR_MeasurementObject MR_MeasurementObject;
 
MRC_API MR_MeasurementObject *MR_MeasurementObject_ConstructFromAnother(MR_PassBy _other_pass_by, MR_MeasurementObject *_other);
 
MRC_API const MR_MeasurementObject *MR_MeasurementObject_OffsetPtr(const MR_MeasurementObject *ptr, ptrdiff_t i);
 
MRC_API MR_MeasurementObject *MR_MeasurementObject_OffsetMutablePtr(MR_MeasurementObject *ptr, ptrdiff_t i);
 
MRC_API const MR_ObjectChildrenHolder *MR_MeasurementObject_UpcastTo_MR_ObjectChildrenHolder(const MR_MeasurementObject *object);
 
MRC_API MR_ObjectChildrenHolder *MR_MeasurementObject_MutableUpcastTo_MR_ObjectChildrenHolder(MR_MeasurementObject *object);
 
MRC_API const MR_Object *MR_MeasurementObject_UpcastTo_MR_Object(const MR_MeasurementObject *object);
 
MRC_API MR_Object *MR_MeasurementObject_MutableUpcastTo_MR_Object(MR_MeasurementObject *object);
 
MRC_API const MR_VisualObject *MR_MeasurementObject_UpcastTo_MR_VisualObject(const MR_MeasurementObject *object);
 
MRC_API MR_VisualObject *MR_MeasurementObject_MutableUpcastTo_MR_VisualObject(MR_MeasurementObject *object);
 
MRC_API const MR_AngleMeasurementObject *MR_MeasurementObject_StaticDowncastTo_MR_AngleMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_AngleMeasurementObject *MR_MeasurementObject_MutableStaticDowncastTo_MR_AngleMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_AngleMeasurementObject *MR_MeasurementObject_DynamicDowncastTo_MR_AngleMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_AngleMeasurementObject *MR_MeasurementObject_MutableDynamicDowncastTo_MR_AngleMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_AngleMeasurementObject *MR_MeasurementObject_DynamicDowncastToOrFail_MR_AngleMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_AngleMeasurementObject *MR_MeasurementObject_MutableDynamicDowncastToOrFail_MR_AngleMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_DistanceMeasurementObject *MR_MeasurementObject_StaticDowncastTo_MR_DistanceMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_DistanceMeasurementObject *MR_MeasurementObject_MutableStaticDowncastTo_MR_DistanceMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_DistanceMeasurementObject *MR_MeasurementObject_DynamicDowncastTo_MR_DistanceMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_DistanceMeasurementObject *MR_MeasurementObject_MutableDynamicDowncastTo_MR_DistanceMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_DistanceMeasurementObject *MR_MeasurementObject_DynamicDowncastToOrFail_MR_DistanceMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_DistanceMeasurementObject *MR_MeasurementObject_MutableDynamicDowncastToOrFail_MR_DistanceMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_PointMeasurementObject *MR_MeasurementObject_StaticDowncastTo_MR_PointMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_PointMeasurementObject *MR_MeasurementObject_MutableStaticDowncastTo_MR_PointMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_PointMeasurementObject *MR_MeasurementObject_DynamicDowncastTo_MR_PointMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_PointMeasurementObject *MR_MeasurementObject_MutableDynamicDowncastTo_MR_PointMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_PointMeasurementObject *MR_MeasurementObject_DynamicDowncastToOrFail_MR_PointMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_PointMeasurementObject *MR_MeasurementObject_MutableDynamicDowncastToOrFail_MR_PointMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_RadiusMeasurementObject *MR_MeasurementObject_StaticDowncastTo_MR_RadiusMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_RadiusMeasurementObject *MR_MeasurementObject_MutableStaticDowncastTo_MR_RadiusMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_RadiusMeasurementObject *MR_MeasurementObject_DynamicDowncastTo_MR_RadiusMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_RadiusMeasurementObject *MR_MeasurementObject_MutableDynamicDowncastTo_MR_RadiusMeasurementObject(MR_MeasurementObject *object);
 
MRC_API const MR_RadiusMeasurementObject *MR_MeasurementObject_DynamicDowncastToOrFail_MR_RadiusMeasurementObject(const MR_MeasurementObject *object);
 
MRC_API MR_RadiusMeasurementObject *MR_MeasurementObject_MutableDynamicDowncastToOrFail_MR_RadiusMeasurementObject(MR_MeasurementObject *object);
 
MRC_API void MR_MeasurementObject_Destroy(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_DestroyArray(const MR_MeasurementObject *_this);
 
MRC_API MR_MeasurementObject *MR_MeasurementObject_AssignFromAnother(MR_MeasurementObject *_this, MR_PassBy _other_pass_by, MR_MeasurementObject *_other);
 
MRC_API const char *MR_MeasurementObject_StaticTypeName(void);
 
MRC_API const char *MR_MeasurementObject_typeName(const MR_MeasurementObject *_this);
 
MRC_API const char *MR_MeasurementObject_StaticClassName(void);
 
MRC_API MR_std_string *MR_MeasurementObject_className(const MR_MeasurementObject *_this);
 
MRC_API const char *MR_MeasurementObject_StaticClassNameInPlural(void);
 
MRC_API MR_std_string *MR_MeasurementObject_classNameInPlural(const MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_supportsVisualizeProperty(const MR_MeasurementObject *_this, const MR_AnyVisualizeMaskEnum *type);
 
MRC_API void MR_MeasurementObject_setVisualizeProperty(MR_MeasurementObject *_this, bool value, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_MeasurementObject_setVisualizePropertyMask(MR_MeasurementObject *_this, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_MeasurementObject_getVisualizeProperty(const MR_MeasurementObject *_this, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API const MR_ViewportMask *MR_MeasurementObject_getVisualizePropertyMask(const MR_MeasurementObject *_this, const MR_AnyVisualizeMaskEnum *type);
 
MRC_API void MR_MeasurementObject_toggleVisualizeProperty(MR_MeasurementObject *_this, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API MR_std_vector_MR_ViewportMask *MR_MeasurementObject_getAllVisualizeProperties(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setAllVisualizeProperties(MR_MeasurementObject *_this, const MR_std_vector_MR_ViewportMask *properties);
 
MRC_API void MR_MeasurementObject_copyAllSolidColors(MR_MeasurementObject *_this, const MR_VisualObject *other);
 
MRC_API MR_ViewportMask *MR_MeasurementObject_globalClippedByPlaneMask(const MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_globalClippedByPlane(const MR_MeasurementObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_MeasurementObject_setGlobalClippedByPlane(MR_MeasurementObject *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API const MR_Color *MR_MeasurementObject_getFrontColor(const MR_MeasurementObject *_this, const bool *selected, const MR_ViewportId *viewportId);
 
MRC_API void MR_MeasurementObject_setFrontColor(MR_MeasurementObject *_this, const MR_Color *color, bool selected, const MR_ViewportId *viewportId);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_MeasurementObject_getFrontColorsForAllViewports(const MR_MeasurementObject *_this, const bool *selected);
 
MRC_API void MR_MeasurementObject_setFrontColorsForAllViewports(MR_MeasurementObject *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val, const bool *selected);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_MeasurementObject_getBackColorsForAllViewports(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setBackColorsForAllViewports(MR_MeasurementObject *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val);
 
MRC_API const MR_Color *MR_MeasurementObject_getBackColor(const MR_MeasurementObject *_this, const MR_ViewportId *viewportId);
 
MRC_API void MR_MeasurementObject_setBackColor(MR_MeasurementObject *_this, const MR_Color *color, const MR_ViewportId *viewportId);
 
MRC_API const unsigned char *MR_MeasurementObject_getGlobalAlpha(const MR_MeasurementObject *_this, const MR_ViewportId *viewportId);
 
MRC_API void MR_MeasurementObject_setGlobalAlpha(MR_MeasurementObject *_this, unsigned char alpha, const MR_ViewportId *viewportId);
 
MRC_API const MR_ViewportProperty_unsigned_char *MR_MeasurementObject_getGlobalAlphaForAllViewports(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setGlobalAlphaForAllViewports(MR_MeasurementObject *_this, MR_PassBy val_pass_by, MR_ViewportProperty_unsigned_char *val);
 
MRC_API void MR_MeasurementObject_setDirtyFlags(MR_MeasurementObject *_this, unsigned int mask, const bool *invalidateCaches);
 
MRC_API unsigned int MR_MeasurementObject_getDirtyFlags(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_resetDirty(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_resetDirtyExceptMask(const MR_MeasurementObject *_this, unsigned int mask);
 
MRC_API MR_Box3f MR_MeasurementObject_getBoundingBox(const MR_MeasurementObject *_this);
 
MRC_API MR_Box3f MR_MeasurementObject_getWorldBox(const MR_MeasurementObject *_this, const MR_ViewportId *_1);
 
MRC_API bool MR_MeasurementObject_getRedrawFlag(const MR_MeasurementObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_MeasurementObject_isPickable(const MR_MeasurementObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_MeasurementObject_setPickable(MR_MeasurementObject *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API MR_ColoringType MR_MeasurementObject_getColoringType(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setColoringType(MR_MeasurementObject *_this, MR_ColoringType coloringType);
 
MRC_API float MR_MeasurementObject_getShininess(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setShininess(MR_MeasurementObject *_this, float shininess);
 
MRC_API float MR_MeasurementObject_getSpecularStrength(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setSpecularStrength(MR_MeasurementObject *_this, float specularStrength);
 
MRC_API float MR_MeasurementObject_getAmbientStrength(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setAmbientStrength(MR_MeasurementObject *_this, float ambientStrength);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_MeasurementObject_clone(const MR_MeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_MeasurementObject_shallowClone(const MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_render(const MR_MeasurementObject *_this, const MR_ModelRenderParams *_1);
 
MRC_API void MR_MeasurementObject_renderForPicker(const MR_MeasurementObject *_this, const MR_ModelBaseRenderParams *_1, unsigned int _2);
 
MRC_API void MR_MeasurementObject_renderUi(const MR_MeasurementObject *_this, const MR_UiRenderParams *params);
 
MRC_API MR_uint64_t MR_MeasurementObject_heapBytes(const MR_MeasurementObject *_this);
 
MRC_API MR_std_vector_std_string *MR_MeasurementObject_getInfoLines(const MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_useDefaultScenePropertiesOnDeserialization(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setUseDefaultScenePropertiesOnDeserialization(MR_MeasurementObject *_this, bool useDefaultScenePropertiesOnDeserialization);
 
MRC_API void MR_MeasurementObject_resetFrontColor(MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_resetColors(MR_MeasurementObject *_this);
 
MRC_API const MR_std_string *MR_MeasurementObject_name(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setName(MR_MeasurementObject *_this, const char *name, const char *name_end);
 
MRC_API const MR_AffineXf3f *MR_MeasurementObject_xf(const MR_MeasurementObject *_this, const MR_ViewportId *id, bool *isDef);
 
MRC_API void MR_MeasurementObject_setXf(MR_MeasurementObject *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id);
 
MRC_API void MR_MeasurementObject_resetXf(MR_MeasurementObject *_this, const MR_ViewportId *id);
 
MRC_API const MR_ViewportProperty_MR_AffineXf3f *MR_MeasurementObject_xfsForAllViewports(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setXfsForAllViewports(MR_MeasurementObject *_this, MR_PassBy xf_pass_by, MR_ViewportProperty_MR_AffineXf3f *xf);
 
MRC_API MR_AffineXf3f MR_MeasurementObject_worldXf(const MR_MeasurementObject *_this, const MR_ViewportId *id, bool *isDef);
 
MRC_API void MR_MeasurementObject_setWorldXf(MR_MeasurementObject *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id);
 
MRC_API void MR_MeasurementObject_applyScale(MR_MeasurementObject *_this, float scaleFactor);
 
MRC_API MR_ViewportMask *MR_MeasurementObject_globalVisibilityMask(const MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_globalVisibility(const MR_MeasurementObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_MeasurementObject_setGlobalVisibility(MR_MeasurementObject *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_MeasurementObject_isLocked(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setLocked(MR_MeasurementObject *_this, bool on);
 
MRC_API bool MR_MeasurementObject_isParentLocked(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setParentLocked(MR_MeasurementObject *_this, bool lock);
 
MRC_API bool MR_MeasurementObject_isAncestor(const MR_MeasurementObject *_this, const MR_Object *ancestor);
 
MRC_API bool MR_MeasurementObject_detachFromParent(MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_addChild(MR_MeasurementObject *_this, MR_PassBy child_pass_by, MR_std_shared_ptr_MR_Object *child, const bool *recognizedChild);
 
MRC_API bool MR_MeasurementObject_addChildBefore(MR_MeasurementObject *_this, MR_PassBy newChild_pass_by, MR_std_shared_ptr_MR_Object *newChild, const MR_std_shared_ptr_MR_Object *existingChild);
 
MRC_API void MR_MeasurementObject_removeAllChildren(MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_sortChildren(MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_select(MR_MeasurementObject *_this, bool on);
 
MRC_API bool MR_MeasurementObject_isSelected(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setAncillary(MR_MeasurementObject *_this, bool ancillary);
 
MRC_API bool MR_MeasurementObject_isAncillary(const MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_isGlobalAncillary(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_setVisible(MR_MeasurementObject *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_MeasurementObject_isVisible(const MR_MeasurementObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_MeasurementObject_setVisibilityMask(MR_MeasurementObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API MR_ViewportMask *MR_MeasurementObject_visibilityMask(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_resetRedrawFlag(const MR_MeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_MeasurementObject_cloneTree(const MR_MeasurementObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_MeasurementObject_shallowCloneTree(const MR_MeasurementObject *_this);
 
MRC_API void MR_MeasurementObject_swap(MR_MeasurementObject *_this, MR_Object *other);
 
MRC_API MR_Box3f MR_MeasurementObject_getWorldTreeBox(const MR_MeasurementObject *_this, const MR_ViewportId *_1);
 
MRC_API bool MR_MeasurementObject_hasVisualRepresentation(const MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_hasModel(const MR_MeasurementObject *_this);
 
MRC_API const MR_std_set_std_string *MR_MeasurementObject_tags(const MR_MeasurementObject *_this);
 
MRC_API bool MR_MeasurementObject_addTag(MR_MeasurementObject *_this, const char *tag, const char *tag_end);
 
MRC_API bool MR_MeasurementObject_removeTag(MR_MeasurementObject *_this, const char *tag, const char *tag_end);
 
// return true if model of current object equals to model (the same) of other
MRC_API bool MR_MeasurementObject_sameModels(const MR_MeasurementObject *_this, const MR_Object *other);
 
// return hash of model (or hash object pointer if object has no model)
MRC_API MR_uint64_t MR_MeasurementObject_getModelHash(const MR_MeasurementObject *_this);
 
// returns this Object as shared_ptr
// finds it among its parent's recognized children
MRC_API MR_std_shared_ptr_MR_Object *MR_MeasurementObject_getSharedPtr(const MR_MeasurementObject *_this);
 
#ifdef __cplusplus
} // extern "C"
#endif