MRObjectsAccess.h File Reference

#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
#include <stdbool.h>

Go to the source code of this file.

Typedefs
typedef struct MR_Object	MR_Object
typedef struct MR_std_shared_ptr_MR_Object	MR_std_shared_ptr_MR_Object
typedef struct MR_std_vector_std_shared_ptr_MR_Object	MR_std_vector_std_shared_ptr_MR_Object
typedef enum MR_ObjectSelectivityType	MR_ObjectSelectivityType

Enumerations
enum	MR_ObjectSelectivityType {   MR_ObjectSelectivityType_Selectable = 0 , MR_ObjectSelectivityType_LocalSelectable = 1 , MR_ObjectSelectivityType_Selected = 2 , MR_ObjectSelectivityType_LocalSelected = 3 ,   MR_ObjectSelectivityType_Any = 4 }

Functions
MRC_API MR_std_shared_ptr_MR_Object *	MR_asSelectivityType (MR_PassBy obj_pass_by, MR_std_shared_ptr_MR_Object *obj, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_Object *	MR_getAllObjectsInTree (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_Object *	MR_getTopmostVisibleObjects (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_Object *	MR_getTopmostObjects (MR_Object *root, const MR_ObjectSelectivityType *type, const bool *visibilityCheck)
MRC_API MR_std_shared_ptr_MR_Object *	MR_getDepthFirstObject (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API bool	MR_objectHasSelectableChildren (const MR_Object *object, const bool *recurse)

Typedef Documentation

MR_Object

typedef struct MR_Object MR_Object

MR_ObjectSelectivityType

typedef enum MR_ObjectSelectivityType MR_ObjectSelectivityType

MR_std_shared_ptr_MR_Object

typedef struct MR_std_shared_ptr_MR_Object MR_std_shared_ptr_MR_Object

MR_std_vector_std_shared_ptr_MR_Object

typedef struct MR_std_vector_std_shared_ptr_MR_Object MR_std_vector_std_shared_ptr_MR_Object

Enumeration Type Documentation

MR_ObjectSelectivityType

enum MR_ObjectSelectivityType

Enumerator
MR_ObjectSelectivityType_Selectable	object itself and all its ancestors are selectable
MR_ObjectSelectivityType_LocalSelectable	object itself is selectable
MR_ObjectSelectivityType_Selected	object itself is selected and all its ancestors are selectable
MR_ObjectSelectivityType_LocalSelected	object itself is selected
MR_ObjectSelectivityType_Any	any object

Function Documentation

MR_asSelectivityType()

MRC_API MR_std_shared_ptr_MR_Object * MR_asSelectivityType	(	MR_PassBy	obj_pass_by,
		MR_std_shared_ptr_MR_Object *	obj,
		const MR_ObjectSelectivityType *	type )

if input object is of given type then returns another pointer on it Generated from function MR::asSelectivityType<MR::Object>. Parameter type 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_getAllObjectsInTree()

MRC_API MR_std_vector_std_shared_ptr_MR_Object * MR_getAllObjectsInTree	(	MR_Object *	root,
		const MR_ObjectSelectivityType *	type )

Traverses tree and collect objects of given type excluding root returns vector Generated from function MR::getAllObjectsInTree<MR::Object>. Parameter type is a single object. Parameter type has a default argument: ObjectSelectivityType::Selectable, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_std_vector_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_getDepthFirstObject()

MRC_API MR_std_shared_ptr_MR_Object * MR_getDepthFirstObject	(	MR_Object *	root,
		const MR_ObjectSelectivityType *	type )

return first object of given type in depth-first traverse order excluding root Generated from function MR::getDepthFirstObject<MR::Object>. Parameter type 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_getTopmostObjects()

MRC_API MR_std_vector_std_shared_ptr_MR_Object * MR_getTopmostObjects	(	MR_Object *	root,
		const MR_ObjectSelectivityType *	type,
		const bool *	visibilityCheck )

Returns all topmost objects of given type (if an object is returned, its children are not) excluding root Generated from function MR::getTopmostObjects<MR::Object>. Parameter type is a single object. Parameter type has a default argument: ObjectSelectivityType::Selectable, pass a null pointer to use it. Parameter visibilityCheck has a default argument: false, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_std_vector_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_getTopmostVisibleObjects()

MRC_API MR_std_vector_std_shared_ptr_MR_Object * MR_getTopmostVisibleObjects	(	MR_Object *	root,
		const MR_ObjectSelectivityType *	type )

Returns all topmost visible objects of given type (if an object is returned, its children are not) excluding root Generated from function MR::getTopmostVisibleObjects<MR::Object>. Parameter type is a single object. Parameter type has a default argument: ObjectSelectivityType::Selectable, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_std_vector_std_shared_ptr_MR_Object_Destroy() to free it when you're done using it.

MR_objectHasSelectableChildren()

MRC_API bool MR_objectHasSelectableChildren	(	const MR_Object *	object,
		const bool *	recurse )

returns whether the object has selectable children

Parameters

recurse

- if true, look up for selectable children at any depth Generated from function MR::objectHasSelectableChildren. Parameter object can not be null. It is a single object. Parameter recurse has a default argument: false, pass a null pointer to use it.