MRObjectLabel.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_AnyVisualizeMaskEnum MR_AnyVisualizeMaskEnum; // Defined in `#include <MRCMesh/MRVisualObject.h>`.
typedef struct MR_Color MR_Color; // Defined in `#include <MRCMesh/MRColor.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_PositionedText MR_PositionedText; // Defined in `#include <MRCMesh/MRPositionedText.h>`.
typedef struct MR_UiRenderParams MR_UiRenderParams; // Defined in `#include <MRCMesh/MRIRenderObject.h>`.
typedef struct MR_Vector2f MR_Vector2f; // Defined in `#include <MRCMesh/MRVector2.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_filesystem_path MR_std_filesystem_path; // Defined in `#include <MRCMisc/std_filesystem_path.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_Mesh MR_std_shared_ptr_MR_Mesh; // Defined in `#include <MRCMisc/std_shared_ptr_MR_Mesh.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>`.
 
 
typedef enum MR_LabelVisualizePropertyType
{
    MR_LabelVisualizePropertyType_SourcePoint = 0,
    MR_LabelVisualizePropertyType_LeaderLine = 1,
    MR_LabelVisualizePropertyType_Background = 2,
    MR_LabelVisualizePropertyType_Contour = 3,
    MR_LabelVisualizePropertyType__count = 4,
} MR_LabelVisualizePropertyType;
 
typedef struct MR_ObjectLabel MR_ObjectLabel;
 
MRC_API MR_ObjectLabel *MR_ObjectLabel_DefaultConstruct(void);
 
MRC_API MR_ObjectLabel *MR_ObjectLabel_DefaultConstructArray(size_t num_elems);
 
MRC_API const MR_ObjectLabel *MR_ObjectLabel_OffsetPtr(const MR_ObjectLabel *ptr, ptrdiff_t i);
 
MRC_API MR_ObjectLabel *MR_ObjectLabel_OffsetMutablePtr(MR_ObjectLabel *ptr, ptrdiff_t i);
 
MRC_API const MR_ObjectChildrenHolder *MR_ObjectLabel_UpcastTo_MR_ObjectChildrenHolder(const MR_ObjectLabel *object);
 
MRC_API MR_ObjectChildrenHolder *MR_ObjectLabel_MutableUpcastTo_MR_ObjectChildrenHolder(MR_ObjectLabel *object);
 
MRC_API const MR_Object *MR_ObjectLabel_UpcastTo_MR_Object(const MR_ObjectLabel *object);
 
MRC_API MR_Object *MR_ObjectLabel_MutableUpcastTo_MR_Object(MR_ObjectLabel *object);
 
MRC_API const MR_VisualObject *MR_ObjectLabel_UpcastTo_MR_VisualObject(const MR_ObjectLabel *object);
 
MRC_API MR_VisualObject *MR_ObjectLabel_MutableUpcastTo_MR_VisualObject(MR_ObjectLabel *object);
 
MRC_API MR_ObjectLabel *MR_ObjectLabel_ConstructFromAnother(MR_PassBy _other_pass_by, MR_ObjectLabel *_other);
 
MRC_API void MR_ObjectLabel_Destroy(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_DestroyArray(const MR_ObjectLabel *_this);
 
MRC_API MR_ObjectLabel *MR_ObjectLabel_AssignFromAnother(MR_ObjectLabel *_this, MR_PassBy _other_pass_by, MR_ObjectLabel *_other);
 
MRC_API const char *MR_ObjectLabel_StaticTypeName(void);
 
MRC_API const char *MR_ObjectLabel_typeName(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_applyScale(MR_ObjectLabel *_this, float scaleFactor);
 
MRC_API bool MR_ObjectLabel_hasVisualRepresentation(const MR_ObjectLabel *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_ObjectLabel_clone(const MR_ObjectLabel *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_ObjectLabel_shallowClone(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setFontHeight(MR_ObjectLabel *_this, float size);
 
MRC_API float MR_ObjectLabel_getFontHeight(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setLabel(MR_ObjectLabel *_this, const MR_PositionedText *label);
 
MRC_API const MR_PositionedText *MR_ObjectLabel_getLabel(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setFontPath(MR_ObjectLabel *_this, const char *pathToFont, const char *pathToFont_end);
 
MRC_API const MR_std_filesystem_path *MR_ObjectLabel_getFontPath(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setPivotPoint(MR_ObjectLabel *_this, const MR_Vector2f *pivotPoint);
 
MRC_API const MR_Vector2f *MR_ObjectLabel_getPivotPoint(const MR_ObjectLabel *_this);
 
MRC_API const MR_Vector2f *MR_ObjectLabel_getPivotShift(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setLeaderLineWidth(MR_ObjectLabel *_this, float width);
 
MRC_API float MR_ObjectLabel_getLeaderLineWidth(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setSourcePointSize(MR_ObjectLabel *_this, float size);
 
MRC_API float MR_ObjectLabel_getSourcePointSize(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setBackgroundPadding(MR_ObjectLabel *_this, float padding);
 
MRC_API float MR_ObjectLabel_getBackgroundPadding(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setSourcePointColor(MR_ObjectLabel *_this, const MR_Color *color, const MR_ViewportId *id);
 
MRC_API const MR_Color *MR_ObjectLabel_getSourcePointColor(const MR_ObjectLabel *_this, const MR_ViewportId *id);
 
MRC_API void MR_ObjectLabel_setLeaderLineColor(MR_ObjectLabel *_this, const MR_Color *color, const MR_ViewportId *id);
 
MRC_API const MR_Color *MR_ObjectLabel_getLeaderLineColor(const MR_ObjectLabel *_this, const MR_ViewportId *id);
 
MRC_API void MR_ObjectLabel_setContourColor(MR_ObjectLabel *_this, const MR_Color *color, const MR_ViewportId *id);
 
MRC_API const MR_Color *MR_ObjectLabel_getContourColor(const MR_ObjectLabel *_this, const MR_ViewportId *id);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_ObjectLabel_getSourcePointColorsForAllViewports(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setSourcePointColorsForAllViewports(MR_ObjectLabel *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_ObjectLabel_getLeaderLineColorsForAllViewports(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setLeaderLineColorsForAllViewports(MR_ObjectLabel *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_ObjectLabel_getContourColorsForAllViewports(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setContourColorsForAllViewports(MR_ObjectLabel *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val);
 
MRC_API MR_Box3f MR_ObjectLabel_getWorldBox(const MR_ObjectLabel *_this, const MR_ViewportId *_1);
 
MRC_API const MR_std_shared_ptr_MR_Mesh *MR_ObjectLabel_labelRepresentingMesh(const MR_ObjectLabel *_this);
 
MRC_API MR_uint64_t MR_ObjectLabel_heapBytes(const MR_ObjectLabel *_this);
 
MRC_API MR_std_vector_MR_ViewportMask *MR_ObjectLabel_getAllVisualizeProperties(const MR_ObjectLabel *_this);
 
MRC_API const MR_ViewportMask *MR_ObjectLabel_getVisualizePropertyMask(const MR_ObjectLabel *_this, const MR_AnyVisualizeMaskEnum *type);
 
MRC_API void MR_ObjectLabel_buildMeshFromText(const MR_ObjectLabel *_this);
 
MRC_API const char *MR_ObjectLabel_StaticClassName(void);
 
MRC_API MR_std_string *MR_ObjectLabel_className(const MR_ObjectLabel *_this);
 
MRC_API const char *MR_ObjectLabel_StaticClassNameInPlural(void);
 
MRC_API MR_std_string *MR_ObjectLabel_classNameInPlural(const MR_ObjectLabel *_this);
 
MRC_API bool MR_ObjectLabel_supportsVisualizeProperty(const MR_ObjectLabel *_this, const MR_AnyVisualizeMaskEnum *type);
 
MRC_API void MR_ObjectLabel_setVisualizeProperty(MR_ObjectLabel *_this, bool value, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_ObjectLabel_setVisualizePropertyMask(MR_ObjectLabel *_this, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_ObjectLabel_getVisualizeProperty(const MR_ObjectLabel *_this, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_ObjectLabel_toggleVisualizeProperty(MR_ObjectLabel *_this, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_ObjectLabel_setAllVisualizeProperties(MR_ObjectLabel *_this, const MR_std_vector_MR_ViewportMask *properties);
 
MRC_API void MR_ObjectLabel_copyAllSolidColors(MR_ObjectLabel *_this, const MR_VisualObject *other);
 
MRC_API MR_ViewportMask *MR_ObjectLabel_globalClippedByPlaneMask(const MR_ObjectLabel *_this);
 
MRC_API bool MR_ObjectLabel_globalClippedByPlane(const MR_ObjectLabel *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_ObjectLabel_setGlobalClippedByPlane(MR_ObjectLabel *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API const MR_Color *MR_ObjectLabel_getFrontColor(const MR_ObjectLabel *_this, const bool *selected, const MR_ViewportId *viewportId);
 
MRC_API void MR_ObjectLabel_setFrontColor(MR_ObjectLabel *_this, const MR_Color *color, bool selected, const MR_ViewportId *viewportId);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_ObjectLabel_getFrontColorsForAllViewports(const MR_ObjectLabel *_this, const bool *selected);
 
MRC_API void MR_ObjectLabel_setFrontColorsForAllViewports(MR_ObjectLabel *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val, const bool *selected);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_ObjectLabel_getBackColorsForAllViewports(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setBackColorsForAllViewports(MR_ObjectLabel *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val);
 
MRC_API const MR_Color *MR_ObjectLabel_getBackColor(const MR_ObjectLabel *_this, const MR_ViewportId *viewportId);
 
MRC_API void MR_ObjectLabel_setBackColor(MR_ObjectLabel *_this, const MR_Color *color, const MR_ViewportId *viewportId);
 
MRC_API const unsigned char *MR_ObjectLabel_getGlobalAlpha(const MR_ObjectLabel *_this, const MR_ViewportId *viewportId);
 
MRC_API void MR_ObjectLabel_setGlobalAlpha(MR_ObjectLabel *_this, unsigned char alpha, const MR_ViewportId *viewportId);
 
MRC_API const MR_ViewportProperty_unsigned_char *MR_ObjectLabel_getGlobalAlphaForAllViewports(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setGlobalAlphaForAllViewports(MR_ObjectLabel *_this, MR_PassBy val_pass_by, MR_ViewportProperty_unsigned_char *val);
 
MRC_API void MR_ObjectLabel_setDirtyFlags(MR_ObjectLabel *_this, unsigned int mask, const bool *invalidateCaches);
 
MRC_API unsigned int MR_ObjectLabel_getDirtyFlags(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_resetDirty(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_resetDirtyExceptMask(const MR_ObjectLabel *_this, unsigned int mask);
 
MRC_API MR_Box3f MR_ObjectLabel_getBoundingBox(const MR_ObjectLabel *_this);
 
MRC_API bool MR_ObjectLabel_getRedrawFlag(const MR_ObjectLabel *_this, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_ObjectLabel_isPickable(const MR_ObjectLabel *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_ObjectLabel_setPickable(MR_ObjectLabel *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API MR_ColoringType MR_ObjectLabel_getColoringType(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setColoringType(MR_ObjectLabel *_this, MR_ColoringType coloringType);
 
MRC_API float MR_ObjectLabel_getShininess(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setShininess(MR_ObjectLabel *_this, float shininess);
 
MRC_API float MR_ObjectLabel_getSpecularStrength(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setSpecularStrength(MR_ObjectLabel *_this, float specularStrength);
 
MRC_API float MR_ObjectLabel_getAmbientStrength(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setAmbientStrength(MR_ObjectLabel *_this, float ambientStrength);
 
MRC_API bool MR_ObjectLabel_render(const MR_ObjectLabel *_this, const MR_ModelRenderParams *_1);
 
MRC_API void MR_ObjectLabel_renderForPicker(const MR_ObjectLabel *_this, const MR_ModelBaseRenderParams *_1, unsigned int _2);
 
MRC_API void MR_ObjectLabel_renderUi(const MR_ObjectLabel *_this, const MR_UiRenderParams *params);
 
MRC_API MR_std_vector_std_string *MR_ObjectLabel_getInfoLines(const MR_ObjectLabel *_this);
 
MRC_API bool MR_ObjectLabel_useDefaultScenePropertiesOnDeserialization(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setUseDefaultScenePropertiesOnDeserialization(MR_ObjectLabel *_this, bool useDefaultScenePropertiesOnDeserialization);
 
MRC_API void MR_ObjectLabel_resetFrontColor(MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_resetColors(MR_ObjectLabel *_this);
 
MRC_API const MR_std_string *MR_ObjectLabel_name(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setName(MR_ObjectLabel *_this, const char *name, const char *name_end);
 
MRC_API const MR_AffineXf3f *MR_ObjectLabel_xf(const MR_ObjectLabel *_this, const MR_ViewportId *id, bool *isDef);
 
MRC_API void MR_ObjectLabel_setXf(MR_ObjectLabel *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id);
 
MRC_API void MR_ObjectLabel_resetXf(MR_ObjectLabel *_this, const MR_ViewportId *id);
 
MRC_API const MR_ViewportProperty_MR_AffineXf3f *MR_ObjectLabel_xfsForAllViewports(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setXfsForAllViewports(MR_ObjectLabel *_this, MR_PassBy xf_pass_by, MR_ViewportProperty_MR_AffineXf3f *xf);
 
MRC_API MR_AffineXf3f MR_ObjectLabel_worldXf(const MR_ObjectLabel *_this, const MR_ViewportId *id, bool *isDef);
 
MRC_API void MR_ObjectLabel_setWorldXf(MR_ObjectLabel *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id);
 
MRC_API MR_ViewportMask *MR_ObjectLabel_globalVisibilityMask(const MR_ObjectLabel *_this);
 
MRC_API bool MR_ObjectLabel_globalVisibility(const MR_ObjectLabel *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_ObjectLabel_setGlobalVisibility(MR_ObjectLabel *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_ObjectLabel_isLocked(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setLocked(MR_ObjectLabel *_this, bool on);
 
MRC_API bool MR_ObjectLabel_isParentLocked(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setParentLocked(MR_ObjectLabel *_this, bool lock);
 
MRC_API bool MR_ObjectLabel_isAncestor(const MR_ObjectLabel *_this, const MR_Object *ancestor);
 
MRC_API bool MR_ObjectLabel_detachFromParent(MR_ObjectLabel *_this);
 
MRC_API bool MR_ObjectLabel_addChild(MR_ObjectLabel *_this, MR_PassBy child_pass_by, MR_std_shared_ptr_MR_Object *child, const bool *recognizedChild);
 
MRC_API bool MR_ObjectLabel_addChildBefore(MR_ObjectLabel *_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_ObjectLabel_removeAllChildren(MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_sortChildren(MR_ObjectLabel *_this);
 
MRC_API bool MR_ObjectLabel_select(MR_ObjectLabel *_this, bool on);
 
MRC_API bool MR_ObjectLabel_isSelected(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setAncillary(MR_ObjectLabel *_this, bool ancillary);
 
MRC_API bool MR_ObjectLabel_isAncillary(const MR_ObjectLabel *_this);
 
MRC_API bool MR_ObjectLabel_isGlobalAncillary(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_setVisible(MR_ObjectLabel *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_ObjectLabel_isVisible(const MR_ObjectLabel *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_ObjectLabel_setVisibilityMask(MR_ObjectLabel *_this, const MR_ViewportMask *viewportMask);
 
MRC_API MR_ViewportMask *MR_ObjectLabel_visibilityMask(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_resetRedrawFlag(const MR_ObjectLabel *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_ObjectLabel_cloneTree(const MR_ObjectLabel *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_ObjectLabel_shallowCloneTree(const MR_ObjectLabel *_this);
 
MRC_API void MR_ObjectLabel_swap(MR_ObjectLabel *_this, MR_Object *other);
 
MRC_API MR_Box3f MR_ObjectLabel_getWorldTreeBox(const MR_ObjectLabel *_this, const MR_ViewportId *_1);
 
MRC_API bool MR_ObjectLabel_hasModel(const MR_ObjectLabel *_this);
 
MRC_API const MR_std_set_std_string *MR_ObjectLabel_tags(const MR_ObjectLabel *_this);
 
MRC_API bool MR_ObjectLabel_addTag(MR_ObjectLabel *_this, const char *tag, const char *tag_end);
 
MRC_API bool MR_ObjectLabel_removeTag(MR_ObjectLabel *_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_ObjectLabel_sameModels(const MR_ObjectLabel *_this, const MR_Object *other);
 
// return hash of model (or hash object pointer if object has no model)
MRC_API MR_uint64_t MR_ObjectLabel_getModelHash(const MR_ObjectLabel *_this);
 
// returns this Object as shared_ptr
// finds it among its parent's recognized children
MRC_API MR_std_shared_ptr_MR_Object *MR_ObjectLabel_getSharedPtr(const MR_ObjectLabel *_this);
 
#ifdef __cplusplus
} // extern "C"
#endif