MRLineObject.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMesh/MRAffineXf.h>
#include <MRCMesh/MRBox.h>
#include <MRCMesh/MREnums.h>
#include <MRCMesh/MRMatrix3.h>
#include <MRCMesh/MRVector3.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_FeatureObject MR_FeatureObject; // Defined in `#include <MRCMesh/MRFeatureObject.h>`.
typedef struct MR_FeatureObjectProjectPointResult MR_FeatureObjectProjectPointResult; // Defined in `#include <MRCMesh/MRFeatureObject.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_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_optional_MR_Vector3f MR_std_optional_MR_Vector3f; // Defined in `#include <MRCMisc/std_optional_MR_Vector3f.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_FeatureObjectSharedProperty MR_std_vector_MR_FeatureObjectSharedProperty; // Defined in `#include <MRCMisc/std_vector_MR_FeatureObjectSharedProperty.h>`.
typedef struct MR_std_vector_MR_Vector3f MR_std_vector_MR_Vector3f; // Defined in `#include <MRCMisc/std_vector_MR_Vector3f.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 struct MR_LineObject MR_LineObject;
 
MRC_API MR_LineObject *MR_LineObject_DefaultConstruct(void);
 
MRC_API MR_LineObject *MR_LineObject_DefaultConstructArray(size_t num_elems);
 
MRC_API const MR_LineObject *MR_LineObject_OffsetPtr(const MR_LineObject *ptr, ptrdiff_t i);
 
MRC_API MR_LineObject *MR_LineObject_OffsetMutablePtr(MR_LineObject *ptr, ptrdiff_t i);
 
MRC_API const MR_ObjectChildrenHolder *MR_LineObject_UpcastTo_MR_ObjectChildrenHolder(const MR_LineObject *object);
 
MRC_API MR_ObjectChildrenHolder *MR_LineObject_MutableUpcastTo_MR_ObjectChildrenHolder(MR_LineObject *object);
 
MRC_API const MR_Object *MR_LineObject_UpcastTo_MR_Object(const MR_LineObject *object);
 
MRC_API MR_Object *MR_LineObject_MutableUpcastTo_MR_Object(MR_LineObject *object);
 
MRC_API const MR_VisualObject *MR_LineObject_UpcastTo_MR_VisualObject(const MR_LineObject *object);
 
MRC_API MR_VisualObject *MR_LineObject_MutableUpcastTo_MR_VisualObject(MR_LineObject *object);
 
MRC_API const MR_FeatureObject *MR_LineObject_UpcastTo_MR_FeatureObject(const MR_LineObject *object);
 
MRC_API MR_FeatureObject *MR_LineObject_MutableUpcastTo_MR_FeatureObject(MR_LineObject *object);
 
MRC_API MR_LineObject *MR_LineObject_ConstructFromAnother(MR_PassBy _other_pass_by, MR_LineObject *_other);
 
MRC_API MR_LineObject *MR_LineObject_Construct(const MR_std_vector_MR_Vector3f *pointsToApprox);
 
MRC_API void MR_LineObject_Destroy(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_DestroyArray(const MR_LineObject *_this);
 
MRC_API MR_LineObject *MR_LineObject_AssignFromAnother(MR_LineObject *_this, MR_PassBy _other_pass_by, MR_LineObject *_other);
 
MRC_API const char *MR_LineObject_StaticTypeName(void);
 
MRC_API const char *MR_LineObject_typeName(const MR_LineObject *_this);
 
MRC_API const char *MR_LineObject_StaticClassName(void);
 
MRC_API MR_std_string *MR_LineObject_className(const MR_LineObject *_this);
 
MRC_API const char *MR_LineObject_StaticClassNameInPlural(void);
 
MRC_API MR_std_string *MR_LineObject_classNameInPlural(const MR_LineObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_LineObject_clone(const MR_LineObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_LineObject_shallowClone(const MR_LineObject *_this);
 
MRC_API MR_Vector3f MR_LineObject_getDirection(const MR_LineObject *_this, const MR_ViewportId *id);
 
MRC_API MR_Vector3f MR_LineObject_getCenter(const MR_LineObject *_this, const MR_ViewportId *id);
 
MRC_API void MR_LineObject_setDirection(MR_LineObject *_this, const MR_Vector3f *normal, const MR_ViewportId *id);
 
MRC_API void MR_LineObject_setCenter(MR_LineObject *_this, const MR_Vector3f *center, const MR_ViewportId *id);
 
MRC_API void MR_LineObject_setLength(MR_LineObject *_this, float size, const MR_ViewportId *id);
 
MRC_API float MR_LineObject_getLength(const MR_LineObject *_this, const MR_ViewportId *id);
 
// Returns point considered as base for the feature
MRC_API MR_Vector3f MR_LineObject_getBasePoint(const MR_LineObject *_this, const MR_ViewportId *id);
 
MRC_API MR_Vector3f MR_LineObject_getPointA(const MR_LineObject *_this, const MR_ViewportId *id);
 
MRC_API MR_Vector3f MR_LineObject_getPointB(const MR_LineObject *_this, const MR_ViewportId *id);
 
MRC_API MR_FeatureObjectProjectPointResult *MR_LineObject_projectPoint(const MR_LineObject *_this, const MR_Vector3f *point, const MR_ViewportId *id);
 
MRC_API const MR_std_vector_MR_FeatureObjectSharedProperty *MR_LineObject_getAllSharedProperties(const MR_LineObject *_this);
 
MRC_API bool MR_LineObject_supportsVisualizeProperty(const MR_LineObject *_this, const MR_AnyVisualizeMaskEnum *type);
 
MRC_API MR_std_vector_MR_ViewportMask *MR_LineObject_getAllVisualizeProperties(const MR_LineObject *_this);
 
MRC_API const MR_ViewportMask *MR_LineObject_getVisualizePropertyMask(const MR_LineObject *_this, const MR_AnyVisualizeMaskEnum *type);
 
MRC_API MR_std_optional_MR_Vector3f *MR_LineObject_getNormal(const MR_LineObject *_this, const MR_Vector3f *point);
 
MRC_API void MR_LineObject_setXf(MR_LineObject *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id);
 
MRC_API void MR_LineObject_resetXf(MR_LineObject *_this, const MR_ViewportId *id);
 
// The cached orthonormalized rotation matrix.
// `isDef` receives false if matrix is overridden for this specific viewport.
MRC_API MR_Matrix3f MR_LineObject_getRotationMatrix(const MR_LineObject *_this, const MR_ViewportId *id, bool *isDef);
 
// The cached scale and shear matrix. The main diagnoal stores the scale, and some other elements store the shearing.
// `isDef` receives false if matrix is overridden for this specific viewport.
MRC_API MR_Matrix3f MR_LineObject_getScaleShearMatrix(const MR_LineObject *_this, const MR_ViewportId *id, bool *isDef);
 
// This color is used for subfeatures.
// `isDef` receives false if matrix is overridden for this specific viewport.
MRC_API const MR_Color *MR_LineObject_getDecorationsColor(const MR_LineObject *_this, bool selected, const MR_ViewportId *viewportId, bool *isDef);
 
MRC_API void MR_LineObject_setDecorationsColor(MR_LineObject *_this, const MR_Color *color, bool selected, const MR_ViewportId *viewportId);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_LineObject_getDecorationsColorForAllViewports(const MR_LineObject *_this, bool selected);
 
MRC_API void MR_LineObject_setDecorationsColorForAllViewports(MR_LineObject *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val, bool selected);
 
// Point size and line width, for primary rendering rather than subfeatures.
MRC_API float MR_LineObject_getPointSize(const MR_LineObject *_this);
 
MRC_API float MR_LineObject_getLineWidth(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setPointSize(MR_LineObject *_this, float pointSize);
 
MRC_API void MR_LineObject_setLineWidth(MR_LineObject *_this, float lineWidth);
 
// Point size and line width, for subfeatures rather than primary rendering.
MRC_API float MR_LineObject_getSubfeaturePointSize(const MR_LineObject *_this);
 
MRC_API float MR_LineObject_getSubfeatureLineWidth(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setSubfeaturePointSize(MR_LineObject *_this, float pointSize);
 
MRC_API void MR_LineObject_setSubfeatureLineWidth(MR_LineObject *_this, float lineWidth);
 
// Per-component alpha multipliers. The global alpha is multiplied by thise.
MRC_API float MR_LineObject_getMainFeatureAlpha(const MR_LineObject *_this);
 
MRC_API float MR_LineObject_getSubfeatureAlphaPoints(const MR_LineObject *_this);
 
MRC_API float MR_LineObject_getSubfeatureAlphaLines(const MR_LineObject *_this);
 
MRC_API float MR_LineObject_getSubfeatureAlphaMesh(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setMainFeatureAlpha(MR_LineObject *_this, float alpha);
 
MRC_API void MR_LineObject_setSubfeatureAlphaPoints(MR_LineObject *_this, float alpha);
 
MRC_API void MR_LineObject_setSubfeatureAlphaLines(MR_LineObject *_this, float alpha);
 
MRC_API void MR_LineObject_setSubfeatureAlphaMesh(MR_LineObject *_this, float alpha);
 
MRC_API void MR_LineObject_setVisualizeProperty(MR_LineObject *_this, bool value, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_LineObject_setVisualizePropertyMask(MR_LineObject *_this, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_LineObject_getVisualizeProperty(const MR_LineObject *_this, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_LineObject_toggleVisualizeProperty(MR_LineObject *_this, const MR_AnyVisualizeMaskEnum *type, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_LineObject_setAllVisualizeProperties(MR_LineObject *_this, const MR_std_vector_MR_ViewportMask *properties);
 
MRC_API void MR_LineObject_copyAllSolidColors(MR_LineObject *_this, const MR_VisualObject *other);
 
MRC_API MR_ViewportMask *MR_LineObject_globalClippedByPlaneMask(const MR_LineObject *_this);
 
MRC_API bool MR_LineObject_globalClippedByPlane(const MR_LineObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_LineObject_setGlobalClippedByPlane(MR_LineObject *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API const MR_Color *MR_LineObject_getFrontColor(const MR_LineObject *_this, const bool *selected, const MR_ViewportId *viewportId);
 
MRC_API void MR_LineObject_setFrontColor(MR_LineObject *_this, const MR_Color *color, bool selected, const MR_ViewportId *viewportId);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_LineObject_getFrontColorsForAllViewports(const MR_LineObject *_this, const bool *selected);
 
MRC_API void MR_LineObject_setFrontColorsForAllViewports(MR_LineObject *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val, const bool *selected);
 
MRC_API const MR_ViewportProperty_MR_Color *MR_LineObject_getBackColorsForAllViewports(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setBackColorsForAllViewports(MR_LineObject *_this, MR_PassBy val_pass_by, MR_ViewportProperty_MR_Color *val);
 
MRC_API const MR_Color *MR_LineObject_getBackColor(const MR_LineObject *_this, const MR_ViewportId *viewportId);
 
MRC_API void MR_LineObject_setBackColor(MR_LineObject *_this, const MR_Color *color, const MR_ViewportId *viewportId);
 
MRC_API const unsigned char *MR_LineObject_getGlobalAlpha(const MR_LineObject *_this, const MR_ViewportId *viewportId);
 
MRC_API void MR_LineObject_setGlobalAlpha(MR_LineObject *_this, unsigned char alpha, const MR_ViewportId *viewportId);
 
MRC_API const MR_ViewportProperty_unsigned_char *MR_LineObject_getGlobalAlphaForAllViewports(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setGlobalAlphaForAllViewports(MR_LineObject *_this, MR_PassBy val_pass_by, MR_ViewportProperty_unsigned_char *val);
 
MRC_API void MR_LineObject_setDirtyFlags(MR_LineObject *_this, unsigned int mask, const bool *invalidateCaches);
 
MRC_API unsigned int MR_LineObject_getDirtyFlags(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_resetDirty(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_resetDirtyExceptMask(const MR_LineObject *_this, unsigned int mask);
 
MRC_API MR_Box3f MR_LineObject_getBoundingBox(const MR_LineObject *_this);
 
MRC_API MR_Box3f MR_LineObject_getWorldBox(const MR_LineObject *_this, const MR_ViewportId *_1);
 
MRC_API bool MR_LineObject_getRedrawFlag(const MR_LineObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_LineObject_isPickable(const MR_LineObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_LineObject_setPickable(MR_LineObject *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API MR_ColoringType MR_LineObject_getColoringType(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setColoringType(MR_LineObject *_this, MR_ColoringType coloringType);
 
MRC_API float MR_LineObject_getShininess(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setShininess(MR_LineObject *_this, float shininess);
 
MRC_API float MR_LineObject_getSpecularStrength(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setSpecularStrength(MR_LineObject *_this, float specularStrength);
 
MRC_API float MR_LineObject_getAmbientStrength(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setAmbientStrength(MR_LineObject *_this, float ambientStrength);
 
MRC_API bool MR_LineObject_render(const MR_LineObject *_this, const MR_ModelRenderParams *_1);
 
MRC_API void MR_LineObject_renderForPicker(const MR_LineObject *_this, const MR_ModelBaseRenderParams *_1, unsigned int _2);
 
MRC_API void MR_LineObject_renderUi(const MR_LineObject *_this, const MR_UiRenderParams *params);
 
MRC_API MR_uint64_t MR_LineObject_heapBytes(const MR_LineObject *_this);
 
MRC_API MR_std_vector_std_string *MR_LineObject_getInfoLines(const MR_LineObject *_this);
 
MRC_API bool MR_LineObject_useDefaultScenePropertiesOnDeserialization(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setUseDefaultScenePropertiesOnDeserialization(MR_LineObject *_this, bool useDefaultScenePropertiesOnDeserialization);
 
MRC_API void MR_LineObject_resetFrontColor(MR_LineObject *_this);
 
MRC_API void MR_LineObject_resetColors(MR_LineObject *_this);
 
MRC_API const MR_std_string *MR_LineObject_name(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setName(MR_LineObject *_this, const char *name, const char *name_end);
 
MRC_API const MR_AffineXf3f *MR_LineObject_xf(const MR_LineObject *_this, const MR_ViewportId *id, bool *isDef);
 
MRC_API const MR_ViewportProperty_MR_AffineXf3f *MR_LineObject_xfsForAllViewports(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setXfsForAllViewports(MR_LineObject *_this, MR_PassBy xf_pass_by, MR_ViewportProperty_MR_AffineXf3f *xf);
 
MRC_API MR_AffineXf3f MR_LineObject_worldXf(const MR_LineObject *_this, const MR_ViewportId *id, bool *isDef);
 
MRC_API void MR_LineObject_setWorldXf(MR_LineObject *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id);
 
MRC_API void MR_LineObject_applyScale(MR_LineObject *_this, float scaleFactor);
 
MRC_API MR_ViewportMask *MR_LineObject_globalVisibilityMask(const MR_LineObject *_this);
 
MRC_API bool MR_LineObject_globalVisibility(const MR_LineObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_LineObject_setGlobalVisibility(MR_LineObject *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_LineObject_isLocked(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setLocked(MR_LineObject *_this, bool on);
 
MRC_API bool MR_LineObject_isParentLocked(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setParentLocked(MR_LineObject *_this, bool lock);
 
MRC_API bool MR_LineObject_isAncestor(const MR_LineObject *_this, const MR_Object *ancestor);
 
MRC_API bool MR_LineObject_detachFromParent(MR_LineObject *_this);
 
MRC_API bool MR_LineObject_addChild(MR_LineObject *_this, MR_PassBy child_pass_by, MR_std_shared_ptr_MR_Object *child, const bool *recognizedChild);
 
MRC_API bool MR_LineObject_addChildBefore(MR_LineObject *_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_LineObject_removeAllChildren(MR_LineObject *_this);
 
MRC_API void MR_LineObject_sortChildren(MR_LineObject *_this);
 
MRC_API bool MR_LineObject_select(MR_LineObject *_this, bool on);
 
MRC_API bool MR_LineObject_isSelected(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setAncillary(MR_LineObject *_this, bool ancillary);
 
MRC_API bool MR_LineObject_isAncillary(const MR_LineObject *_this);
 
MRC_API bool MR_LineObject_isGlobalAncillary(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_setVisible(MR_LineObject *_this, bool on, const MR_ViewportMask *viewportMask);
 
MRC_API bool MR_LineObject_isVisible(const MR_LineObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API void MR_LineObject_setVisibilityMask(MR_LineObject *_this, const MR_ViewportMask *viewportMask);
 
MRC_API MR_ViewportMask *MR_LineObject_visibilityMask(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_resetRedrawFlag(const MR_LineObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_LineObject_cloneTree(const MR_LineObject *_this);
 
MRC_API MR_std_shared_ptr_MR_Object *MR_LineObject_shallowCloneTree(const MR_LineObject *_this);
 
MRC_API void MR_LineObject_swap(MR_LineObject *_this, MR_Object *other);
 
MRC_API MR_Box3f MR_LineObject_getWorldTreeBox(const MR_LineObject *_this, const MR_ViewportId *_1);
 
MRC_API bool MR_LineObject_hasVisualRepresentation(const MR_LineObject *_this);
 
MRC_API bool MR_LineObject_hasModel(const MR_LineObject *_this);
 
MRC_API const MR_std_set_std_string *MR_LineObject_tags(const MR_LineObject *_this);
 
MRC_API bool MR_LineObject_addTag(MR_LineObject *_this, const char *tag, const char *tag_end);
 
MRC_API bool MR_LineObject_removeTag(MR_LineObject *_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_LineObject_sameModels(const MR_LineObject *_this, const MR_Object *other);
 
// return hash of model (or hash object pointer if object has no model)
MRC_API MR_uint64_t MR_LineObject_getModelHash(const MR_LineObject *_this);
 
// returns this Object as shared_ptr
// finds it among its parent's recognized children
MRC_API MR_std_shared_ptr_MR_Object *MR_LineObject_getSharedPtr(const MR_LineObject *_this);
 
#ifdef __cplusplus
} // extern "C"
#endif