MRObject.h File Reference

#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>

Go to the source code of this file.

Typedefs
typedef struct MR_std_shared_ptr_const_MR_Object	MR_std_shared_ptr_const_MR_Object
typedef struct MR_std_vector_std_shared_ptr_const_MR_Object	MR_std_vector_std_shared_ptr_const_MR_Object

Functions
MRC_API MR_ObjectChildrenHolder *	MR_ObjectChildrenHolder_DefaultConstruct (void)
MRC_API MR_ObjectChildrenHolder *	MR_ObjectChildrenHolder_DefaultConstructArray (size_t num_elems)
MRC_API const MR_ObjectChildrenHolder *	MR_ObjectChildrenHolder_OffsetPtr (const MR_ObjectChildrenHolder *ptr, ptrdiff_t i)
MRC_API MR_ObjectChildrenHolder *	MR_ObjectChildrenHolder_OffsetMutablePtr (MR_ObjectChildrenHolder *ptr, ptrdiff_t i)
MRC_API MR_ObjectChildrenHolder *	MR_ObjectChildrenHolder_ConstructFromAnother (MR_PassBy _other_pass_by, MR_ObjectChildrenHolder *_other)
MRC_API void	MR_ObjectChildrenHolder_Destroy (const MR_ObjectChildrenHolder *_this)
	Destroys a heap-allocated instance of MR_ObjectChildrenHolder. Does nothing if the pointer is null.
MRC_API void	MR_ObjectChildrenHolder_DestroyArray (const MR_ObjectChildrenHolder *_this)
	Destroys a heap-allocated array of MR_ObjectChildrenHolder. Does nothing if the pointer is null.
MRC_API MR_ObjectChildrenHolder *	MR_ObjectChildrenHolder_AssignFromAnother (MR_ObjectChildrenHolder *_this, MR_PassBy _other_pass_by, MR_ObjectChildrenHolder *_other)
MRC_API MR_std_shared_ptr_MR_Object *	MR_ObjectChildrenHolder_getSharedPtr (const MR_ObjectChildrenHolder *_this)
MRC_API MR_uint64_t	MR_ObjectChildrenHolder_heapBytes (const MR_ObjectChildrenHolder *_this)
MRC_API MR_Object *	MR_Object_DefaultConstruct (void)
MRC_API MR_Object *	MR_Object_DefaultConstructArray (size_t num_elems)
MRC_API const MR_Object *	MR_Object_OffsetPtr (const MR_Object *ptr, ptrdiff_t i)
MRC_API MR_Object *	MR_Object_OffsetMutablePtr (MR_Object *ptr, ptrdiff_t i)
MRC_API const MR_ObjectChildrenHolder *	MR_Object_UpcastTo_MR_ObjectChildrenHolder (const MR_Object *object)
MRC_API MR_ObjectChildrenHolder *	MR_Object_MutableUpcastTo_MR_ObjectChildrenHolder (MR_Object *object)
MRC_API const MR_Object *	MR_Object_StaticDowncastFrom_MR_ObjectChildrenHolder (const MR_ObjectChildrenHolder *object)
MRC_API MR_Object *	MR_Object_MutableStaticDowncastFrom_MR_ObjectChildrenHolder (MR_ObjectChildrenHolder *object)
MRC_API MR_Object *	MR_Object_ConstructFromAnother (MR_PassBy _other_pass_by, MR_Object *_other)
MRC_API void	MR_Object_Destroy (const MR_Object *_this)
	Destroys a heap-allocated instance of MR_Object. Does nothing if the pointer is null.
MRC_API void	MR_Object_DestroyArray (const MR_Object *_this)
	Destroys a heap-allocated array of MR_Object. Does nothing if the pointer is null.
MRC_API MR_Object *	MR_Object_AssignFromAnother (MR_Object *_this, MR_PassBy _other_pass_by, MR_Object *_other)
MRC_API const char *	MR_Object_StaticTypeName (void)
	Generated from method MR::Object::StaticTypeName.
MRC_API const char *	MR_Object_typeName (const MR_Object *_this)
MRC_API const char *	MR_Object_StaticClassName (void)
MRC_API MR_std_string *	MR_Object_className (const MR_Object *_this)
MRC_API const char *	MR_Object_StaticClassNameInPlural (void)
MRC_API MR_std_string *	MR_Object_classNameInPlural (const MR_Object *_this)
MRC_API MR_VisualObject *	MR_Object_asType_mut (MR_Object *_this)
MRC_API const MR_VisualObject *	MR_Object_asType (const MR_Object *_this)
MRC_API const MR_std_string *	MR_Object_name (const MR_Object *_this)
MRC_API void	MR_Object_setName (MR_Object *_this, const char *name, const char *name_end)
MRC_API MR_std_shared_ptr_const_MR_Object *	MR_Object_find (const MR_Object *_this, const char *name, const char *name_end)
MRC_API MR_std_shared_ptr_MR_Object *	MR_Object_find_mut (MR_Object *_this, const char *name, const char *name_end)
MRC_API const MR_AffineXf3f *	MR_Object_xf (const MR_Object *_this, const MR_ViewportId *id, bool *isDef)
MRC_API void	MR_Object_setXf (MR_Object *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id)
MRC_API void	MR_Object_resetXf (MR_Object *_this, const MR_ViewportId *id)
MRC_API const MR_ViewportProperty_MR_AffineXf3f *	MR_Object_xfsForAllViewports (const MR_Object *_this)
MRC_API void	MR_Object_setXfsForAllViewports (MR_Object *_this, MR_PassBy xf_pass_by, MR_ViewportProperty_MR_AffineXf3f *xf)
MRC_API MR_AffineXf3f	MR_Object_worldXf (const MR_Object *_this, const MR_ViewportId *id, bool *isDef)
MRC_API void	MR_Object_setWorldXf (MR_Object *_this, const MR_AffineXf3f *xf, const MR_ViewportId *id)
MRC_API void	MR_Object_applyScale (MR_Object *_this, float scaleFactor)
MRC_API MR_ViewportMask *	MR_Object_globalVisibilityMask (const MR_Object *_this)
MRC_API bool	MR_Object_globalVisibility (const MR_Object *_this, const MR_ViewportMask *viewportMask)
MRC_API void	MR_Object_setGlobalVisibility (MR_Object *_this, bool on, const MR_ViewportMask *viewportMask)
MRC_API bool	MR_Object_isLocked (const MR_Object *_this)
MRC_API void	MR_Object_setLocked (MR_Object *_this, bool on)
MRC_API bool	MR_Object_isParentLocked (const MR_Object *_this)
MRC_API void	MR_Object_setParentLocked (MR_Object *_this, bool lock)
MRC_API const MR_Object *	MR_Object_parent (const MR_Object *_this)
MRC_API MR_Object *	MR_Object_parent_mut (MR_Object *_this)
MRC_API bool	MR_Object_isAncestor (const MR_Object *_this, const MR_Object *ancestor)
MRC_API MR_Object *	MR_Object_findCommonAncestor_mut (MR_Object *_this, MR_Object *other)
MRC_API const MR_Object *	MR_Object_findCommonAncestor (const MR_Object *_this, const MR_Object *other)
MRC_API bool	MR_Object_detachFromParent (MR_Object *_this)
MRC_API const MR_std_vector_std_shared_ptr_MR_Object *	MR_Object_children_mut (MR_Object *_this)
MRC_API const MR_std_vector_std_shared_ptr_const_MR_Object *	MR_Object_children (const MR_Object *_this)
MRC_API bool	MR_Object_addChild (MR_Object *_this, MR_PassBy child_pass_by, MR_std_shared_ptr_MR_Object *child, const bool *recognizedChild)
MRC_API bool	MR_Object_addChildBefore (MR_Object *_this, MR_PassBy newChild_pass_by, MR_std_shared_ptr_MR_Object *newChild, const MR_std_shared_ptr_MR_Object *existingChild)
MRC_API bool	MR_Object_removeChild_std_shared_ptr_MR_Object (MR_Object *_this, const MR_std_shared_ptr_MR_Object *child)
MRC_API bool	MR_Object_removeChild_MR_Object_ptr (MR_Object *_this, MR_Object *child)
MRC_API void	MR_Object_removeAllChildren (MR_Object *_this)
MRC_API void	MR_Object_sortChildren (MR_Object *_this)
MRC_API bool	MR_Object_select (MR_Object *_this, bool on)
MRC_API bool	MR_Object_isSelected (const MR_Object *_this)
MRC_API void	MR_Object_setAncillary (MR_Object *_this, bool ancillary)
MRC_API bool	MR_Object_isAncillary (const MR_Object *_this)
MRC_API bool	MR_Object_isGlobalAncillary (const MR_Object *_this)
MRC_API void	MR_Object_setVisible (MR_Object *_this, bool on, const MR_ViewportMask *viewportMask)
MRC_API bool	MR_Object_isVisible (const MR_Object *_this, const MR_ViewportMask *viewportMask)
MRC_API void	MR_Object_setVisibilityMask (MR_Object *_this, const MR_ViewportMask *viewportMask)
MRC_API MR_ViewportMask *	MR_Object_visibilityMask (const MR_Object *_this)
MRC_API bool	MR_Object_getRedrawFlag (const MR_Object *_this, const MR_ViewportMask *_1)
MRC_API void	MR_Object_resetRedrawFlag (const MR_Object *_this)
MRC_API MR_std_shared_ptr_MR_Object *	MR_Object_cloneTree (const MR_Object *_this)
MRC_API MR_std_shared_ptr_MR_Object *	MR_Object_clone (const MR_Object *_this)
MRC_API MR_std_shared_ptr_MR_Object *	MR_Object_shallowCloneTree (const MR_Object *_this)
MRC_API MR_std_shared_ptr_MR_Object *	MR_Object_shallowClone (const MR_Object *_this)
MRC_API MR_std_vector_std_string *	MR_Object_getInfoLines (const MR_Object *_this)
MRC_API void	MR_Object_swap (MR_Object *_this, MR_Object *other)
MRC_API MR_Box3f	MR_Object_getWorldBox (const MR_Object *_this, const MR_ViewportId *_1)
MRC_API MR_Box3f	MR_Object_getWorldTreeBox (const MR_Object *_this, const MR_ViewportId *_1)
MRC_API bool	MR_Object_hasVisualRepresentation (const MR_Object *_this)
MRC_API bool	MR_Object_hasModel (const MR_Object *_this)
MRC_API const MR_std_set_std_string *	MR_Object_tags (const MR_Object *_this)
MRC_API bool	MR_Object_addTag (MR_Object *_this, const char *tag, const char *tag_end)
MRC_API bool	MR_Object_removeTag (MR_Object *_this, const char *tag, const char *tag_end)
MRC_API MR_uint64_t	MR_Object_heapBytes (const MR_Object *_this)
MRC_API bool	MR_Object_sameModels (const MR_Object *_this, const MR_Object *other)
MRC_API MR_uint64_t	MR_Object_getModelHash (const MR_Object *_this)
MRC_API MR_std_shared_ptr_MR_Object *	MR_Object_getSharedPtr (const MR_Object *_this)

Typedef Documentation

MR_std_shared_ptr_const_MR_Object

typedef struct MR_std_shared_ptr_const_MR_Object MR_std_shared_ptr_const_MR_Object

Wraps a pointer to a single shared reference-counted heap-allocated const MR::Object. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_std_vector_std_shared_ptr_const_MR_Object

typedef struct MR_std_vector_std_shared_ptr_const_MR_Object MR_std_vector_std_shared_ptr_const_MR_Object

Generated from C++ container std::vector<std::shared_ptr<const MR::Object>>. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

Function Documentation

MR_Object_addChild()

MRC_API bool MR_Object_addChild	(	MR_Object *	_this,
		MR_PassBy	child_pass_by,
		MR_std_shared_ptr_MR_Object *	child,
		const bool *	recognizedChild )

adds given object at the end of children (recognized or not); returns false if it was already child of this, of if given pointer is empty; child object will always report this as parent after the call;

Parameters

recognizedChild

if set to false then child object will be excluded from children() and it will be stored by weak_ptr Generated from method MR::Object::addChild. Parameter _this can not be null. It is a single object. Parameter recognizedChild has a default argument: true, pass a null pointer to use it.

MR_Object_addChildBefore()

MRC_API bool MR_Object_addChildBefore	(	MR_Object *	_this,
		MR_PassBy	newChild_pass_by,
		MR_std_shared_ptr_MR_Object *	newChild,
		const MR_std_shared_ptr_MR_Object *	existingChild )

adds given object in the recognized children before existingChild; if newChild was already among this children then moves it just before existingChild keeping the order of other children intact; returns false if newChild is nullptr, or existingChild is not a child of this Generated from method MR::Object::addChildBefore. Parameter _this can not be null. It is a single object. Parameter existingChild can not be null. It is a single object.

MR_Object_addTag()

MRC_API bool MR_Object_addTag	(	MR_Object *	_this,
		const char *	tag,
		const char *	tag_end )

adds tag to the object's tag storage additionally calls ObjectTagManager::tagAddedSignal NOTE: tags starting with a dot are considered as service ones and might be hidden from UI Generated from method MR::Object::addTag. Parameter _this can not be null. It is a single object. Parameter tag can not be null. If tag_end is null, then tag is assumed to be null-terminated.

MR_Object_applyScale()

MRC_API void MR_Object_applyScale	(	MR_Object *	_this,
		float	scaleFactor )

scale object size (all point positions) Generated from method MR::Object::applyScale. Parameter _this can not be null. It is a single object.

MR_Object_AssignFromAnother()

MRC_API MR_Object * MR_Object_AssignFromAnother	(	MR_Object *	_this,
		MR_PassBy	_other_pass_by,
		MR_Object *	_other )

Generated from method MR::Object::operator=. Parameter _this can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved in the return value. When this function is called, this object will drop any object references it held previously.

MR_Object_asType()

MRC_API const MR_VisualObject * MR_Object_asType

(

const MR_Object *

_this

)

Generated from method MR::Object::asType<MR::VisualObject>. Parameter _this can not be null. It is a single object.

MR_Object_asType_mut()

MRC_API MR_VisualObject * MR_Object_asType_mut

(

MR_Object *

_this

)

Generated from method MR::Object::asType<MR::VisualObject>. Parameter _this can not be null. It is a single object.

MR_Object_children()

MRC_API const MR_std_vector_std_shared_ptr_const_MR_Object * MR_Object_children

(

const MR_Object *

_this

)

Generated from method MR::Object::children. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_Object_children_mut()

MRC_API const MR_std_vector_std_shared_ptr_MR_Object * MR_Object_children_mut

(

MR_Object *

_this

)

an object can hold other sub-objects Generated from method MR::Object::children. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_Object_className()

MRC_API MR_std_string * MR_Object_className

(

const MR_Object *

_this

)

Generated from method MR::Object::className. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_string_Destroy() to free it when you're done using it.

MR_Object_classNameInPlural()

MRC_API MR_std_string * MR_Object_classNameInPlural

(

const MR_Object *

_this

)

Generated from method MR::Object::classNameInPlural. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_string_Destroy() to free it when you're done using it.

MR_Object_clone()

MRC_API MR_std_shared_ptr_MR_Object * MR_Object_clone

(

const MR_Object *

_this

)

clones current object only, without parent and/or children Generated from method MR::Object::clone. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_Object_cloneTree()

MRC_API MR_std_shared_ptr_MR_Object * MR_Object_cloneTree

(

const MR_Object *

_this

)

clones all tree of this object (except ancillary and unrecognized children) Generated from method MR::Object::cloneTree. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_Object_ConstructFromAnother()

MRC_API MR_Object * MR_Object_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_Object *	_other )

Generated from constructor MR::Object::Object. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_Object_Destroy() to free it when you're done using it.

MR_Object_DefaultConstruct()

MRC_API MR_Object * MR_Object_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_Object_Destroy() to free it when you're done using it.

MR_Object_DefaultConstructArray()

MRC_API MR_Object * MR_Object_DefaultConstructArray

(

size_t

num_elems

)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_Object_DestroyArray(). Use MR_Object_OffsetMutablePtr() and MR_Object_OffsetPtr() to access the array elements.

MR_Object_Destroy()

MRC_API void MR_Object_Destroy

(

const MR_Object *

_this

)

Destroys a heap-allocated instance of MR_Object. Does nothing if the pointer is null.

MR_Object_DestroyArray()

MRC_API void MR_Object_DestroyArray

(

const MR_Object *

_this

)

Destroys a heap-allocated array of MR_Object. Does nothing if the pointer is null.

MR_Object_detachFromParent()

MRC_API bool MR_Object_detachFromParent

(

MR_Object *

_this

)

removes this from its parent children list returns false if it was already orphan Generated from method MR::Object::detachFromParent. Parameter _this can not be null. It is a single object.

MR_Object_find()

MRC_API MR_std_shared_ptr_const_MR_Object * MR_Object_find	(	const MR_Object *	_this,
		const char *	name,
		const char *	name_end )

finds a direct child by name Generated from method MR::Object::find. Parameter _this can not be null. It is a single object. Parameter name can not be null. If name_end is null, then name is assumed to be null-terminated. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_const_MR_Object_Destroy() to free it when you're done using it.

MR_Object_find_mut()

MRC_API MR_std_shared_ptr_MR_Object * MR_Object_find_mut	(	MR_Object *	_this,
		const char *	name,
		const char *	name_end )

Generated from method MR::Object::find. Parameter _this can not be null. It is a single object. Parameter name can not be null. If name_end is null, then name is assumed to be null-terminated. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_Object_findCommonAncestor()

MRC_API const MR_Object * MR_Object_findCommonAncestor	(	const MR_Object *	_this,
		const MR_Object *	other )

Generated from method MR::Object::findCommonAncestor. Parameter _this can not be null. It is a single object. Parameter other can not be null. It is a single object.

MR_Object_findCommonAncestor_mut()

MRC_API MR_Object * MR_Object_findCommonAncestor_mut	(	MR_Object *	_this,
		MR_Object *	other )

Find a common ancestor between this object and the other one. Returns null on failure (which is impossible if both are children of the scene root). Will return this if other matches this. Generated from method MR::Object::findCommonAncestor. Parameter _this can not be null. It is a single object. Parameter other can not be null. It is a single object.

MR_Object_getInfoLines()

MRC_API MR_std_vector_std_string * MR_Object_getInfoLines

(

const MR_Object *

_this

)

return several info lines that can better describe object in the UI Generated from method MR::Object::getInfoLines. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_vector_std_string_Destroy() to free it when you're done using it.

MR_Object_getModelHash()

MRC_API MR_uint64_t MR_Object_getModelHash

(

const MR_Object *

_this

)

Generated from method MR::Object::getModelHash. Parameter _this can not be null. It is a single object.

MR_Object_getRedrawFlag()

MRC_API bool MR_Object_getRedrawFlag	(	const MR_Object *	_this,
		const MR_ViewportMask *	_1 )

this method virtual because others data model types could have dirty flags or something Generated from method MR::Object::getRedrawFlag. Parameter _this can not be null. It is a single object. Parameter _1 can not be null. It is a single object.

MR_Object_getSharedPtr()

MRC_API MR_std_shared_ptr_MR_Object * MR_Object_getSharedPtr

(

const MR_Object *

_this

)

Generated from method MR::Object::getSharedPtr. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_Object_getWorldBox()

MRC_API MR_Box3f MR_Object_getWorldBox	(	const MR_Object *	_this,
		const MR_ViewportId *	_1 )

returns bounding box of this object in world coordinates for default or specific viewport Generated from method MR::Object::getWorldBox. Parameter _this can not be null. It is a single object. Parameter _1 has a default argument: {}, pass a null pointer to use it.

MR_Object_getWorldTreeBox()

MRC_API MR_Box3f MR_Object_getWorldTreeBox	(	const MR_Object *	_this,
		const MR_ViewportId *	_1 )

empty box returns bounding box of this object and all children visible in given (or default) viewport in world coordinates Generated from method MR::Object::getWorldTreeBox. Parameter _this can not be null. It is a single object. Parameter _1 has a default argument: {}, pass a null pointer to use it.

MR_Object_globalVisibility()

MRC_API bool MR_Object_globalVisibility	(	const MR_Object *	_this,
		const MR_ViewportMask *	viewportMask )

returns true if this object is visible together with all its parents in any of given viewports Generated from method MR::Object::globalVisibility. Parameter _this can not be null. It is a single object. Parameter viewportMask is a single object. Parameter viewportMask has a default argument: ViewportMask::any(), pass a null pointer to use it.

MR_Object_globalVisibilityMask()

MRC_API MR_ViewportMask * MR_Object_globalVisibilityMask

(

const MR_Object *

_this

)

returns all viewports where this object is visible together with all its parents Generated from method MR::Object::globalVisibilityMask. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_ViewportMask_Destroy() to free it when you're done using it.

MR_Object_hasModel()

MRC_API bool MR_Object_hasModel

(

const MR_Object *

_this

)

does the object have any model available (but possibly empty), e.g. ObjectMesh has valid mesh() or ObjectPoints has valid pointCloud() Generated from method MR::Object::hasModel. Parameter _this can not be null. It is a single object.

MR_Object_hasVisualRepresentation()

MRC_API bool MR_Object_hasVisualRepresentation

(

const MR_Object *

_this

)

does the object have any visual representation (visible points, triangles, edges, etc.), no considering child objects Generated from method MR::Object::hasVisualRepresentation. Parameter _this can not be null. It is a single object.

MR_Object_heapBytes()

MRC_API MR_uint64_t MR_Object_heapBytes

(

const MR_Object *

_this

)

returns the amount of memory this object occupies on heap Generated from method MR::Object::heapBytes. Parameter _this can not be null. It is a single object.

MR_Object_isAncestor()

MRC_API bool MR_Object_isAncestor	(	const MR_Object *	_this,
		const MR_Object *	ancestor )

return true if given object is ancestor of this one, false otherwise Generated from method MR::Object::isAncestor. Parameter _this can not be null. It is a single object.

MR_Object_isAncillary()

MRC_API bool MR_Object_isAncillary

(

const MR_Object *

_this

)

Generated from method MR::Object::isAncillary. Parameter _this can not be null. It is a single object.

MR_Object_isGlobalAncillary()

MRC_API bool MR_Object_isGlobalAncillary

(

const MR_Object *

_this

)

returns true if the object or any of its ancestors are ancillary Generated from method MR::Object::isGlobalAncillary. Parameter _this can not be null. It is a single object.

MR_Object_isLocked()

MRC_API bool MR_Object_isLocked

(

const MR_Object *

_this

)

object properties lock for UI Generated from method MR::Object::isLocked. Parameter _this can not be null. It is a single object.

MR_Object_isParentLocked()

MRC_API bool MR_Object_isParentLocked

(

const MR_Object *

_this

)

If true, the scene tree GUI doesn't allow you to drag'n'drop this object into a different parent. Defaults to false. Generated from method MR::Object::isParentLocked. Parameter _this can not be null. It is a single object.

MR_Object_isSelected()

MRC_API bool MR_Object_isSelected

(

const MR_Object *

_this

)

Generated from method MR::Object::isSelected. Parameter _this can not be null. It is a single object.

MR_Object_isVisible()

MRC_API bool MR_Object_isVisible	(	const MR_Object *	_this,
		const MR_ViewportMask *	viewportMask )

checks whether the object is visible in any of the viewports specified by the mask (by default in any viewport) Generated from method MR::Object::isVisible. Parameter _this can not be null. It is a single object. Parameter viewportMask is a single object. Parameter viewportMask has a default argument: ViewportMask::any(), pass a null pointer to use it.

MR_Object_MutableStaticDowncastFrom_MR_ObjectChildrenHolder()

MRC_API MR_Object * MR_Object_MutableStaticDowncastFrom_MR_ObjectChildrenHolder

(

MR_ObjectChildrenHolder *

object

)

Downcasts an instance of MR::ObjectChildrenHolder to a derived class MR::Object. This is a static downcast, it trusts the programmer that the target type is correct. Results in UB and returns an invalid pointer otherwise. The reference to the parameter object might be preserved in the return value.

MR_Object_MutableUpcastTo_MR_ObjectChildrenHolder()

MRC_API MR_ObjectChildrenHolder * MR_Object_MutableUpcastTo_MR_ObjectChildrenHolder

(

MR_Object *

object

)

Upcasts an instance of MR::Object to its base class MR::ObjectChildrenHolder. The reference to the parameter object might be preserved in the return value.

MR_Object_name()

MRC_API const MR_std_string * MR_Object_name

(

const MR_Object *

_this

)

Generated from method MR::Object::name. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_Object_OffsetMutablePtr()

MRC_API MR_Object * MR_Object_OffsetMutablePtr	(	MR_Object *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_Object_OffsetPtr()

MRC_API const MR_Object * MR_Object_OffsetPtr	(	const MR_Object *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_Object_parent()

MRC_API const MR_Object * MR_Object_parent

(

const MR_Object *

_this

)

returns parent object in the tree Generated from method MR::Object::parent. Parameter _this can not be null. It is a single object.

MR_Object_parent_mut()

MRC_API MR_Object * MR_Object_parent_mut

(

MR_Object *

_this

)

Generated from method MR::Object::parent. Parameter _this can not be null. It is a single object.

MR_Object_removeAllChildren()

MRC_API void MR_Object_removeAllChildren

(

MR_Object *

_this

)

detaches all recognized children from this, keeping all unrecognized ones Generated from method MR::Object::removeAllChildren. Parameter _this can not be null. It is a single object.

MR_Object_removeChild_MR_Object_ptr()

MRC_API bool MR_Object_removeChild_MR_Object_ptr	(	MR_Object *	_this,
		MR_Object *	child )

Generated from method MR::Object::removeChild. Parameter _this can not be null. It is a single object.

MR_Object_removeChild_std_shared_ptr_MR_Object()

MRC_API bool MR_Object_removeChild_std_shared_ptr_MR_Object	(	MR_Object *	_this,
		const MR_std_shared_ptr_MR_Object *	child )

returns false if it was not child of this Generated from method MR::Object::removeChild. Parameter _this can not be null. It is a single object. Parameter child can not be null. It is a single object.

MR_Object_removeTag()

MRC_API bool MR_Object_removeTag	(	MR_Object *	_this,
		const char *	tag,
		const char *	tag_end )

removes tag from the object's tag storage additionally calls ObjectTagManager::tagRemovedSignal Generated from method MR::Object::removeTag. Parameter _this can not be null. It is a single object. Parameter tag can not be null. If tag_end is null, then tag is assumed to be null-terminated.

MR_Object_resetRedrawFlag()

MRC_API void MR_Object_resetRedrawFlag

(

const MR_Object *

_this

)

Generated from method MR::Object::resetRedrawFlag. Parameter _this can not be null. It is a single object.

MR_Object_resetXf()

MRC_API void MR_Object_resetXf	(	MR_Object *	_this,
		const MR_ViewportId *	id )

forgets specific transform in given viewport (or forgets all specific transforms for {} input) Generated from method MR::Object::resetXf. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_Object_sameModels()

MRC_API bool MR_Object_sameModels	(	const MR_Object *	_this,
		const MR_Object *	other )

Generated from method MR::Object::sameModels. Parameter _this can not be null. It is a single object. Parameter other can not be null. It is a single object.

MR_Object_select()

MRC_API bool MR_Object_select	(	MR_Object *	_this,
		bool	on )

selects the object, returns true if value changed, otherwise returns false Generated from method MR::Object::select. Parameter _this can not be null. It is a single object.

MR_Object_setAncillary()

MRC_API void MR_Object_setAncillary	(	MR_Object *	_this,
		bool	ancillary )

ancillary object is an object hidden (in scene menu) from a regular user such objects cannot be selected, and if it has been selected, it is unselected when turn ancillary Generated from method MR::Object::setAncillary. Parameter _this can not be null. It is a single object.

MR_Object_setGlobalVisibility()

MRC_API void MR_Object_setGlobalVisibility	(	MR_Object *	_this,
		bool	on,
		const MR_ViewportMask *	viewportMask )

if true sets all predecessors visible, otherwise sets this object invisible Generated from method MR::Object::setGlobalVisibility. Parameter _this can not be null. It is a single object. Parameter viewportMask is a single object. Parameter viewportMask has a default argument: ViewportMask::any(), pass a null pointer to use it.

MR_Object_setLocked()

MRC_API void MR_Object_setLocked	(	MR_Object *	_this,
		bool	on )

Generated from method MR::Object::setLocked. Parameter _this can not be null. It is a single object.

MR_Object_setName()

MRC_API void MR_Object_setName	(	MR_Object *	_this,
		const char *	name,
		const char *	name_end )

Generated from method MR::Object::setName. Parameter _this can not be null. It is a single object. Parameter name can not be null. If name_end is null, then name is assumed to be null-terminated.

MR_Object_setParentLocked()

MRC_API void MR_Object_setParentLocked	(	MR_Object *	_this,
		bool	lock )

Generated from method MR::Object::setParentLocked. Parameter _this can not be null. It is a single object.

MR_Object_setVisibilityMask()

MRC_API void MR_Object_setVisibilityMask	(	MR_Object *	_this,
		const MR_ViewportMask *	viewportMask )

specifies object visibility as bitmask of viewports Generated from method MR::Object::setVisibilityMask. Parameter _this can not be null. It is a single object. Parameter viewportMask can not be null. It is a single object.

MR_Object_setVisible()

MRC_API void MR_Object_setVisible	(	MR_Object *	_this,
		bool	on,
		const MR_ViewportMask *	viewportMask )

sets the object visible in the viewports specified by the mask (by default in all viewports) Generated from method MR::Object::setVisible. Parameter _this can not be null. It is a single object. Parameter viewportMask is a single object. Parameter viewportMask has a default argument: ViewportMask::all(), pass a null pointer to use it.

MR_Object_setWorldXf()

MRC_API void MR_Object_setWorldXf	(	MR_Object *	_this,
		const MR_AffineXf3f *	xf,
		const MR_ViewportId *	id )

Generated from method MR::Object::setWorldXf. Parameter _this can not be null. It is a single object. Parameter xf can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_Object_setXf()

MRC_API void MR_Object_setXf	(	MR_Object *	_this,
		const MR_AffineXf3f *	xf,
		const MR_ViewportId *	id )

Generated from method MR::Object::setXf. Parameter _this can not be null. It is a single object. Parameter xf can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it.

MR_Object_setXfsForAllViewports()

MRC_API void MR_Object_setXfsForAllViewports	(	MR_Object *	_this,
		MR_PassBy	xf_pass_by,
		MR_ViewportProperty_MR_AffineXf3f *	xf )

modifies xfs for all viewports at once Generated from method MR::Object::setXfsForAllViewports. Parameter _this can not be null. It is a single object.

MR_Object_shallowClone()

MRC_API MR_std_shared_ptr_MR_Object * MR_Object_shallowClone

(

const MR_Object *

_this

)

clones current object only, without parent and/or children clones only pointers to mesh, points or voxels Generated from method MR::Object::shallowClone. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_Object_shallowCloneTree()

MRC_API MR_std_shared_ptr_MR_Object * MR_Object_shallowCloneTree

(

const MR_Object *

_this

)

clones all tree of this object (except ancillary and unrecognied children) clones only pointers to mesh, points or voxels Generated from method MR::Object::shallowCloneTree. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_Object_sortChildren()

MRC_API void MR_Object_sortChildren

(

MR_Object *

_this

)

sort recognized children by name Generated from method MR::Object::sortChildren. Parameter _this can not be null. It is a single object.

MR_Object_StaticClassName()

MRC_API const char * MR_Object_StaticClassName

(

void

)

return human readable name of subclass Generated from method MR::Object::StaticClassName.

MR_Object_StaticClassNameInPlural()

MRC_API const char * MR_Object_StaticClassNameInPlural

(

void

)

return human readable name of subclass in plural form Generated from method MR::Object::StaticClassNameInPlural.

MR_Object_StaticDowncastFrom_MR_ObjectChildrenHolder()

MRC_API const MR_Object * MR_Object_StaticDowncastFrom_MR_ObjectChildrenHolder

(

const MR_ObjectChildrenHolder *

object

)

Downcasts an instance of MR::ObjectChildrenHolder to a derived class MR::Object. This is a static downcast, it trusts the programmer that the target type is correct. Results in UB and returns an invalid pointer otherwise. This version is acting on mutable pointers. The reference to the parameter object might be preserved in the return value.

MR_Object_StaticTypeName()

MRC_API const char * MR_Object_StaticTypeName

(

void

)

Generated from method MR::Object::StaticTypeName.

MR_Object_swap()

MRC_API void MR_Object_swap	(	MR_Object *	_this,
		MR_Object *	other )

swaps this object with other note: do not swap object signals, so listeners will get notifications from swapped object requires implementation of swapBase_ and swapSignals_ (if type has signals) Generated from method MR::Object::swap. Parameter _this can not be null. It is a single object. Parameter other can not be null. It is a single object.

MR_Object_tags()

MRC_API const MR_std_set_std_string * MR_Object_tags

(

const MR_Object *

_this

)

provides read-only access to the tag storage the storage is a set of unique strings Generated from method MR::Object::tags. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_Object_typeName()

MRC_API const char * MR_Object_typeName

(

const MR_Object *

_this

)

Generated from method MR::Object::typeName. Parameter _this can not be null. It is a single object.

MR_Object_UpcastTo_MR_ObjectChildrenHolder()

MRC_API const MR_ObjectChildrenHolder * MR_Object_UpcastTo_MR_ObjectChildrenHolder

(

const MR_Object *

object

)

Upcasts an instance of MR::Object to its base class MR::ObjectChildrenHolder. This version is acting on mutable pointers. The reference to the parameter object might be preserved in the return value.

MR_Object_visibilityMask()

MRC_API MR_ViewportMask * MR_Object_visibilityMask

(

const MR_Object *

_this

)

gets object visibility as bitmask of viewports Generated from method MR::Object::visibilityMask. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_ViewportMask_Destroy() to free it when you're done using it.

MR_Object_worldXf()

MRC_API MR_AffineXf3f MR_Object_worldXf	(	const MR_Object *	_this,
		const MR_ViewportId *	id,
		bool *	isDef )

this space to world space transformation for default or specific viewport

Parameters

isDef

receives true if the object has default transformation in this viewport (same as worldXf() returns) Generated from method MR::Object::worldXf. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it. Parameter isDef defaults to a null pointer in C++.

MR_Object_xf()

MRC_API const MR_AffineXf3f * MR_Object_xf	(	const MR_Object *	_this,
		const MR_ViewportId *	id,
		bool *	isDef )

this space to parent space transformation (to world space if no parent) for default or given viewport

Parameters

isDef

receives true if the object has default transformation in this viewport (same as xf() returns) Generated from method MR::Object::xf. Parameter _this can not be null. It is a single object. Parameter id has a default argument: {}, pass a null pointer to use it. Parameter isDef defaults to a null pointer in C++. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_Object_xfsForAllViewports()

MRC_API const MR_ViewportProperty_MR_AffineXf3f * MR_Object_xfsForAllViewports

(

const MR_Object *

_this

)

returns xfs for all viewports, combined into a single object Generated from method MR::Object::xfsForAllViewports. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_ObjectChildrenHolder_AssignFromAnother()

MRC_API MR_ObjectChildrenHolder * MR_ObjectChildrenHolder_AssignFromAnother	(	MR_ObjectChildrenHolder *	_this,
		MR_PassBy	_other_pass_by,
		MR_ObjectChildrenHolder *	_other )

Generated from method MR::ObjectChildrenHolder::operator=. Parameter _this can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved in the return value. When this function is called, this object will drop any object references it held previously.

MR_ObjectChildrenHolder_ConstructFromAnother()

MRC_API MR_ObjectChildrenHolder * MR_ObjectChildrenHolder_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_ObjectChildrenHolder *	_other )

Generated from constructor MR::ObjectChildrenHolder::ObjectChildrenHolder. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ObjectChildrenHolder_Destroy() to free it when you're done using it.

MR_ObjectChildrenHolder_DefaultConstruct()

MRC_API MR_ObjectChildrenHolder * MR_ObjectChildrenHolder_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_ObjectChildrenHolder_Destroy() to free it when you're done using it.

MR_ObjectChildrenHolder_DefaultConstructArray()

MRC_API MR_ObjectChildrenHolder * MR_ObjectChildrenHolder_DefaultConstructArray

(

size_t

num_elems

)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_ObjectChildrenHolder_DestroyArray(). Use MR_ObjectChildrenHolder_OffsetMutablePtr() and MR_ObjectChildrenHolder_OffsetPtr() to access the array elements.

MR_ObjectChildrenHolder_Destroy()

MRC_API void MR_ObjectChildrenHolder_Destroy

(

const MR_ObjectChildrenHolder *

_this

)

Destroys a heap-allocated instance of MR_ObjectChildrenHolder. Does nothing if the pointer is null.

MR_ObjectChildrenHolder_DestroyArray()

MRC_API void MR_ObjectChildrenHolder_DestroyArray

(

const MR_ObjectChildrenHolder *

_this

)

Destroys a heap-allocated array of MR_ObjectChildrenHolder. Does nothing if the pointer is null.

MR_ObjectChildrenHolder_getSharedPtr()

MRC_API MR_std_shared_ptr_MR_Object * MR_ObjectChildrenHolder_getSharedPtr

(

const MR_ObjectChildrenHolder *

_this

)

Generated from method MR::ObjectChildrenHolder::getSharedPtr. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_ObjectChildrenHolder_heapBytes()

MRC_API MR_uint64_t MR_ObjectChildrenHolder_heapBytes

(

const MR_ObjectChildrenHolder *

_this

)

returns the amount of memory this object occupies on heap, including the memory of all recognized children Generated from method MR::ObjectChildrenHolder::heapBytes. Parameter _this can not be null. It is a single object.

MR_ObjectChildrenHolder_OffsetMutablePtr()

MRC_API MR_ObjectChildrenHolder * MR_ObjectChildrenHolder_OffsetMutablePtr	(	MR_ObjectChildrenHolder *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_ObjectChildrenHolder_OffsetPtr()

MRC_API const MR_ObjectChildrenHolder * MR_ObjectChildrenHolder_OffsetPtr	(	const MR_ObjectChildrenHolder *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.