MRObjectsAccess.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_std_vector_std_shared_ptr_MR_ObjectDistanceMap	MR_std_vector_std_shared_ptr_MR_ObjectDistanceMap
typedef struct MR_std_vector_std_shared_ptr_MR_ObjectLinesHolder	MR_std_vector_std_shared_ptr_MR_ObjectLinesHolder
typedef struct MR_std_vector_std_shared_ptr_MR_ObjectMeshHolder	MR_std_vector_std_shared_ptr_MR_ObjectMeshHolder
typedef struct MR_std_vector_std_shared_ptr_MR_ObjectPointsHolder	MR_std_vector_std_shared_ptr_MR_ObjectPointsHolder
typedef struct MR_std_vector_std_shared_ptr_MR_ObjectVoxels	MR_std_vector_std_shared_ptr_MR_ObjectVoxels
typedef struct MR_std_vector_std_shared_ptr_MR_VisualObject	MR_std_vector_std_shared_ptr_MR_VisualObject
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_vector_std_shared_ptr_MR_Object *	MR_getTopmostVisibleObjects_MR_Object (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_VisualObject *	MR_getTopmostVisibleObjects_MR_VisualObject (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_ObjectPoints *	MR_getTopmostVisibleObjects_MR_ObjectPoints (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_ObjectPointsHolder *	MR_getTopmostVisibleObjects_MR_ObjectPointsHolder (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_ObjectLines *	MR_getTopmostVisibleObjects_MR_ObjectLines (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_ObjectLinesHolder *	MR_getTopmostVisibleObjects_MR_ObjectLinesHolder (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_ObjectMesh *	MR_getTopmostVisibleObjects_MR_ObjectMesh (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_ObjectMeshHolder *	MR_getTopmostVisibleObjects_MR_ObjectMeshHolder (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_ObjectDistanceMap *	MR_getTopmostVisibleObjects_MR_ObjectDistanceMap (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API MR_std_vector_std_shared_ptr_MR_ObjectVoxels *	MR_getTopmostVisibleObjects_MR_ObjectVoxels (MR_Object *root, const MR_ObjectSelectivityType *type)
MRC_API bool	MR_objectHasSelectableChildren (const MR_Object *object, const bool *recurse)

Typedef Documentation

MR_ObjectSelectivityType

typedef enum MR_ObjectSelectivityType MR_ObjectSelectivityType

MR_std_vector_std_shared_ptr_MR_ObjectDistanceMap

typedef struct MR_std_vector_std_shared_ptr_MR_ObjectDistanceMap MR_std_vector_std_shared_ptr_MR_ObjectDistanceMap

Generated from C++ container std::vector<std::shared_ptr<MR::ObjectDistanceMap>>. 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_MR_ObjectLinesHolder

typedef struct MR_std_vector_std_shared_ptr_MR_ObjectLinesHolder MR_std_vector_std_shared_ptr_MR_ObjectLinesHolder

Generated from C++ container std::vector<std::shared_ptr<MR::ObjectLinesHolder>>. 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_MR_ObjectMeshHolder

typedef struct MR_std_vector_std_shared_ptr_MR_ObjectMeshHolder MR_std_vector_std_shared_ptr_MR_ObjectMeshHolder

Generated from C++ container std::vector<std::shared_ptr<MR::ObjectMeshHolder>>. 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_MR_ObjectPointsHolder

typedef struct MR_std_vector_std_shared_ptr_MR_ObjectPointsHolder MR_std_vector_std_shared_ptr_MR_ObjectPointsHolder

Generated from C++ container std::vector<std::shared_ptr<MR::ObjectPointsHolder>>. 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_MR_ObjectVoxels

typedef struct MR_std_vector_std_shared_ptr_MR_ObjectVoxels MR_std_vector_std_shared_ptr_MR_ObjectVoxels

Generated from C++ container std::vector<std::shared_ptr<MR::ObjectVoxels>>. 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_MR_VisualObject

typedef struct MR_std_vector_std_shared_ptr_MR_VisualObject MR_std_vector_std_shared_ptr_MR_VisualObject

Generated from C++ container std::vector<std::shared_ptr<MR::VisualObject>>. 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).

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_getTopmostVisibleObjects_MR_Object()

MRC_API MR_std_vector_std_shared_ptr_MR_Object * MR_getTopmostVisibleObjects_MR_Object	(	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_getTopmostVisibleObjects_MR_ObjectDistanceMap()

MRC_API MR_std_vector_std_shared_ptr_MR_ObjectDistanceMap * MR_getTopmostVisibleObjects_MR_ObjectDistanceMap	(	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::ObjectDistanceMap>. 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_ObjectDistanceMap_Destroy() to free it when you're done using it.

MR_getTopmostVisibleObjects_MR_ObjectLines()

MRC_API MR_std_vector_std_shared_ptr_MR_ObjectLines * MR_getTopmostVisibleObjects_MR_ObjectLines	(	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::ObjectLines>. 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_ObjectLines_Destroy() to free it when you're done using it.

MR_getTopmostVisibleObjects_MR_ObjectLinesHolder()

MRC_API MR_std_vector_std_shared_ptr_MR_ObjectLinesHolder * MR_getTopmostVisibleObjects_MR_ObjectLinesHolder	(	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::ObjectLinesHolder>. 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_ObjectLinesHolder_Destroy() to free it when you're done using it.

MR_getTopmostVisibleObjects_MR_ObjectMesh()

MRC_API MR_std_vector_std_shared_ptr_MR_ObjectMesh * MR_getTopmostVisibleObjects_MR_ObjectMesh	(	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::ObjectMesh>. 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_ObjectMesh_Destroy() to free it when you're done using it.

MR_getTopmostVisibleObjects_MR_ObjectMeshHolder()

MRC_API MR_std_vector_std_shared_ptr_MR_ObjectMeshHolder * MR_getTopmostVisibleObjects_MR_ObjectMeshHolder	(	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::ObjectMeshHolder>. 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_ObjectMeshHolder_Destroy() to free it when you're done using it.

MR_getTopmostVisibleObjects_MR_ObjectPoints()

MRC_API MR_std_vector_std_shared_ptr_MR_ObjectPoints * MR_getTopmostVisibleObjects_MR_ObjectPoints	(	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::ObjectPoints>. 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_ObjectPoints_Destroy() to free it when you're done using it.

MR_getTopmostVisibleObjects_MR_ObjectPointsHolder()

MRC_API MR_std_vector_std_shared_ptr_MR_ObjectPointsHolder * MR_getTopmostVisibleObjects_MR_ObjectPointsHolder	(	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::ObjectPointsHolder>. 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_ObjectPointsHolder_Destroy() to free it when you're done using it.

MR_getTopmostVisibleObjects_MR_ObjectVoxels()

MRC_API MR_std_vector_std_shared_ptr_MR_ObjectVoxels * MR_getTopmostVisibleObjects_MR_ObjectVoxels	(	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::ObjectVoxels>. 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_ObjectVoxels_Destroy() to free it when you're done using it.

MR_getTopmostVisibleObjects_MR_VisualObject()

MRC_API MR_std_vector_std_shared_ptr_MR_VisualObject * MR_getTopmostVisibleObjects_MR_VisualObject	(	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::VisualObject>. 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_VisualObject_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.