MRSceneRoot.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMesh/MRAffineXf.h>
#include <MRCMesh/MRBox.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_ConstChildren MR_ConstChildren; // Defined in `#include <MRCMesh/MRConstChildren.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_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_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_Object MR_std_shared_ptr_MR_Object; // Defined in `#include <MRCMisc/std_shared_ptr_MR_Object.h>`.
typedef struct MR_std_shared_ptr_MR_SceneRootObject MR_std_shared_ptr_MR_SceneRootObject; // Defined in `#include <MRCMisc/std_shared_ptr_MR_SceneRootObject.h>`.
typedef struct MR_std_shared_ptr_const_MR_SceneRootObject MR_std_shared_ptr_const_MR_SceneRootObject; // Defined in `#include <MRCMisc/std_shared_ptr_const_MR_SceneRootObject.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>`.
 

typedef struct MR_SceneRootObject MR_SceneRootObject;

typedef struct MR_SceneRoot MR_SceneRoot;

MRC_API MR_SceneRootObject *MR_SceneRootObject_DefaultConstruct(void);

MRC_API MR_SceneRootObject *MR_SceneRootObject_DefaultConstructArray(size_t num_elems);

MRC_API const MR_SceneRootObject *MR_SceneRootObject_OffsetPtr(const MR_SceneRootObject *ptr, ptrdiff_t i);

MRC_API MR_SceneRootObject *MR_SceneRootObject_OffsetMutablePtr(MR_SceneRootObject *ptr, ptrdiff_t i);

MRC_API const MR_ObjectChildrenHolder *MR_SceneRootObject_UpcastTo_MR_ObjectChildrenHolder(const MR_SceneRootObject *object);

MRC_API MR_ObjectChildrenHolder *MR_SceneRootObject_MutableUpcastTo_MR_ObjectChildrenHolder(MR_SceneRootObject *object);

MRC_API const MR_SceneRootObject *MR_SceneRootObject_StaticDowncastFrom_MR_ObjectChildrenHolder(const MR_ObjectChildrenHolder *object);

MRC_API MR_SceneRootObject *MR_SceneRootObject_MutableStaticDowncastFrom_MR_ObjectChildrenHolder(MR_ObjectChildrenHolder *object);

MRC_API const MR_Object *MR_SceneRootObject_UpcastTo_MR_Object(const MR_SceneRootObject *object);

MRC_API MR_Object *MR_SceneRootObject_MutableUpcastTo_MR_Object(MR_SceneRootObject *object);

MRC_API const MR_SceneRootObject *MR_SceneRootObject_StaticDowncastFrom_MR_Object(const MR_Object *object);

MRC_API MR_SceneRootObject *MR_SceneRootObject_MutableStaticDowncastFrom_MR_Object(MR_Object *object);

MRC_API const MR_SceneRootObject *MR_SceneRootObject_DynamicDowncastFrom_MR_Object(const MR_Object *object);

MRC_API MR_SceneRootObject *MR_SceneRootObject_MutableDynamicDowncastFrom_MR_Object(MR_Object *object);

MRC_API const MR_SceneRootObject *MR_SceneRootObject_DynamicDowncastFromOrFail_MR_Object(const MR_Object *object);

MRC_API MR_SceneRootObject *MR_SceneRootObject_MutableDynamicDowncastFromOrFail_MR_Object(MR_Object *object);

MRC_API MR_SceneRootObject *MR_SceneRootObject_ConstructFromAnother(MR_PassBy _other_pass_by, MR_SceneRootObject *_other);

MRC_API void MR_SceneRootObject_Destroy(const MR_SceneRootObject *_this);

MRC_API void MR_SceneRootObject_DestroyArray(const MR_SceneRootObject *_this);

MRC_API MR_SceneRootObject *MR_SceneRootObject_AssignFromAnother(MR_SceneRootObject *_this, MR_PassBy _other_pass_by, MR_SceneRootObject *_other);

MRC_API const char *MR_SceneRootObject_StaticTypeName(void);

MRC_API const char *MR_SceneRootObject_typeName(const MR_SceneRootObject *_this);

MRC_API const char *MR_SceneRootObject_StaticClassName(void);

MRC_API MR_std_string *MR_SceneRootObject_className(const MR_SceneRootObject *_this);

MRC_API const char *MR_SceneRootObject_StaticClassNameInPlural(void);

MRC_API MR_std_string *MR_SceneRootObject_classNameInPlural(const MR_SceneRootObject *_this);

MRC_API const char *MR_SceneRootObject_RootName(void);

MRC_API void MR_SceneRootObject_setAncillary(MR_SceneRootObject *_this, bool _1);

MRC_API bool MR_SceneRootObject_select(MR_SceneRootObject *_this, bool _1);

MRC_API void MR_SceneRootObject_setName(MR_SceneRootObject *_this, const char *_1, const char *_1_end);

MRC_API MR_std_shared_ptr_MR_Object *MR_SceneRootObject_clone(const MR_SceneRootObject *_this);

MRC_API MR_std_shared_ptr_MR_SceneRootObject *MR_SceneRootObject_cloneRoot(const MR_SceneRootObject *_this);

MRC_API const MR_std_string *MR_SceneRootObject_name(const MR_SceneRootObject *_this);

MRC_API const MR_AffineXf3f *MR_SceneRootObject_xf(const MR_SceneRootObject *_this, const MR_ViewportId *id, bool *isDef);

MRC_API void MR_SceneRootObject_setXf(MR_SceneRootObject *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id);

MRC_API void MR_SceneRootObject_resetXf(MR_SceneRootObject *_this, const MR_ViewportId *id);

MRC_API const MR_ViewportProperty_MR_AffineXf3f *MR_SceneRootObject_xfsForAllViewports(const MR_SceneRootObject *_this);

MRC_API void MR_SceneRootObject_setXfsForAllViewports(MR_SceneRootObject *_this, MR_PassBy xf_pass_by, MR_ViewportProperty_MR_AffineXf3f *xf);

MRC_API MR_AffineXf3f MR_SceneRootObject_worldXf(const MR_SceneRootObject *_this, const MR_ViewportId *id, bool *isDef);

MRC_API void MR_SceneRootObject_setWorldXf(MR_SceneRootObject *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id);

MRC_API void MR_SceneRootObject_applyScale(MR_SceneRootObject *_this, float scaleFactor);

MRC_API MR_ViewportMask *MR_SceneRootObject_globalVisibilityMask(const MR_SceneRootObject *_this);

MRC_API bool MR_SceneRootObject_globalVisibility(const MR_SceneRootObject *_this, const MR_ViewportMask *viewportMask);

MRC_API void MR_SceneRootObject_setGlobalVisibility(MR_SceneRootObject *_this, bool on, const MR_ViewportMask *viewportMask);

MRC_API bool MR_SceneRootObject_isLocked(const MR_SceneRootObject *_this);

MRC_API void MR_SceneRootObject_setLocked(MR_SceneRootObject *_this, bool on);

MRC_API bool MR_SceneRootObject_isParentLocked(const MR_SceneRootObject *_this);

MRC_API void MR_SceneRootObject_setParentLocked(MR_SceneRootObject *_this, bool lock);

MRC_API bool MR_SceneRootObject_isAncestor(const MR_SceneRootObject *_this, const MR_Object *ancestor);

MRC_API bool MR_SceneRootObject_detachFromParent(MR_SceneRootObject *_this);

MRC_API MR_ConstChildren *MR_SceneRootObject_constChildren(const MR_SceneRootObject *_this);

MRC_API bool MR_SceneRootObject_addChild(MR_SceneRootObject *_this, MR_PassBy child_pass_by, MR_std_shared_ptr_MR_Object *child, const bool *recognizedChild);

MRC_API bool MR_SceneRootObject_addChildBefore(MR_SceneRootObject *_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_SceneRootObject_removeAllChildren(MR_SceneRootObject *_this);

MRC_API void MR_SceneRootObject_sortChildren(MR_SceneRootObject *_this);

MRC_API bool MR_SceneRootObject_isSelected(const MR_SceneRootObject *_this);

MRC_API bool MR_SceneRootObject_isAncillary(const MR_SceneRootObject *_this);

MRC_API bool MR_SceneRootObject_isGlobalAncillary(const MR_SceneRootObject *_this);

MRC_API void MR_SceneRootObject_setVisible(MR_SceneRootObject *_this, bool on, const MR_ViewportMask *viewportMask);

MRC_API bool MR_SceneRootObject_isVisible(const MR_SceneRootObject *_this, const MR_ViewportMask *viewportMask);

MRC_API void MR_SceneRootObject_setVisibilityMask(MR_SceneRootObject *_this, const MR_ViewportMask *viewportMask);

MRC_API MR_ViewportMask *MR_SceneRootObject_visibilityMask(const MR_SceneRootObject *_this);

MRC_API bool MR_SceneRootObject_getRedrawFlag(const MR_SceneRootObject *_this, const MR_ViewportMask *_1);

MRC_API void MR_SceneRootObject_resetRedrawFlag(const MR_SceneRootObject *_this);

MRC_API MR_std_shared_ptr_MR_Object *MR_SceneRootObject_cloneTree(const MR_SceneRootObject *_this);

MRC_API MR_std_shared_ptr_MR_Object *MR_SceneRootObject_shallowCloneTree(const MR_SceneRootObject *_this);

MRC_API MR_std_shared_ptr_MR_Object *MR_SceneRootObject_shallowClone(const MR_SceneRootObject *_this);

MRC_API MR_std_vector_std_string *MR_SceneRootObject_getInfoLines(const MR_SceneRootObject *_this);

MRC_API void MR_SceneRootObject_swap(MR_SceneRootObject *_this, MR_Object *other);

MRC_API MR_Box3f MR_SceneRootObject_getWorldBox(const MR_SceneRootObject *_this, const MR_ViewportId *_1);

MRC_API MR_Box3f MR_SceneRootObject_getWorldTreeBox(const MR_SceneRootObject *_this, const MR_ViewportId *_1);

MRC_API bool MR_SceneRootObject_hasVisualRepresentation(const MR_SceneRootObject *_this);

MRC_API bool MR_SceneRootObject_hasModel(const MR_SceneRootObject *_this);

MRC_API const MR_std_set_std_string *MR_SceneRootObject_tags(const MR_SceneRootObject *_this);

MRC_API bool MR_SceneRootObject_addTag(MR_SceneRootObject *_this, const char *tag, const char *tag_end);

MRC_API bool MR_SceneRootObject_removeTag(MR_SceneRootObject *_this, const char *tag, const char *tag_end);

MRC_API size_t MR_SceneRootObject_heapBytes(const MR_SceneRootObject *_this);
 
// return true if model of current object equals to model (the same) of other
MRC_API bool MR_SceneRootObject_sameModels(const MR_SceneRootObject *_this, const MR_Object *other);
 
// return hash of model (or hash object pointer if object has no model)
MRC_API size_t MR_SceneRootObject_getModelHash(const MR_SceneRootObject *_this);
 
// returns this Object as shared_ptr
// finds it among its parent's recognized children
MRC_API MR_std_shared_ptr_MR_Object *MR_SceneRootObject_getSharedPtr(const MR_SceneRootObject *_this);

MRC_API MR_std_shared_ptr_MR_SceneRootObject *MR_createRootFormObject(MR_PassBy obj_pass_by, MR_std_shared_ptr_MR_Object *obj);

MRC_API MR_SceneRoot *MR_SceneRoot_ConstructFromAnother(MR_PassBy _other_pass_by, MR_SceneRoot *_other);

MRC_API const MR_SceneRoot *MR_SceneRoot_OffsetPtr(const MR_SceneRoot *ptr, ptrdiff_t i);

MRC_API MR_SceneRoot *MR_SceneRoot_OffsetMutablePtr(MR_SceneRoot *ptr, ptrdiff_t i);

MRC_API void MR_SceneRoot_Destroy(const MR_SceneRoot *_this);

MRC_API void MR_SceneRoot_DestroyArray(const MR_SceneRoot *_this);

MRC_API MR_SceneRoot *MR_SceneRoot_AssignFromAnother(MR_SceneRoot *_this, MR_PassBy _other_pass_by, MR_SceneRoot *_other);

MRC_API MR_SceneRootObject *MR_SceneRoot_get(void);

MRC_API MR_std_shared_ptr_MR_SceneRootObject *MR_SceneRoot_getSharedPtr(void);

MRC_API void MR_SceneRoot_setScenePath(const char *scenePath, const char *scenePath_end);

MRC_API const MR_SceneRootObject *MR_SceneRoot_constGet(void);

MRC_API MR_std_shared_ptr_const_MR_SceneRootObject *MR_SceneRoot_constGetSharedPtr(void);

MRC_API const MR_std_filesystem_path *MR_SceneRoot_getScenePath(void);
 
#ifdef __cplusplus
} // extern "C"
#endif