MRChangeSceneAction.h File Reference

#include <MRCMesh/MRHistoryAction.h>
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_HistoryAction	MR_HistoryAction
typedef struct MR_std_shared_ptr_MR_Object	MR_std_shared_ptr_MR_Object
typedef struct MR_std_string	MR_std_string
typedef enum MR_ChangeSceneAction_Type	MR_ChangeSceneAction_Type
typedef struct MR_ChangeSceneAction	MR_ChangeSceneAction

Enumerations
enum	MR_ChangeSceneAction_Type { MR_ChangeSceneAction_Type_AddObject = 0 , MR_ChangeSceneAction_Type_RemoveObject = 1 }

Functions
MRC_API MR_ChangeSceneAction *	MR_ChangeSceneAction_ConstructFromAnother (MR_PassBy _other_pass_by, MR_ChangeSceneAction *_other)
MRC_API const MR_ChangeSceneAction *	MR_ChangeSceneAction_OffsetPtr (const MR_ChangeSceneAction *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.
MRC_API MR_ChangeSceneAction *	MR_ChangeSceneAction_OffsetMutablePtr (MR_ChangeSceneAction *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.
MRC_API const MR_HistoryAction *	MR_ChangeSceneAction_UpcastTo_MR_HistoryAction (const MR_ChangeSceneAction *object)
MRC_API MR_HistoryAction *	MR_ChangeSceneAction_MutableUpcastTo_MR_HistoryAction (MR_ChangeSceneAction *object)
	Upcasts an instance of MR::ChangeSceneAction to its base class MR::HistoryAction.
MRC_API MR_ChangeSceneAction *	MR_ChangeSceneAction_Construct (const char *name, const char *name_end, const MR_std_shared_ptr_MR_Object *obj, MR_ChangeSceneAction_Type type)
MRC_API void	MR_ChangeSceneAction_Destroy (const MR_ChangeSceneAction *_this)
	Destroys a heap-allocated instance of MR_ChangeSceneAction. Does nothing if the pointer is null.
MRC_API void	MR_ChangeSceneAction_DestroyArray (const MR_ChangeSceneAction *_this)
	Destroys a heap-allocated array of MR_ChangeSceneAction. Does nothing if the pointer is null.
MRC_API MR_ChangeSceneAction *	MR_ChangeSceneAction_AssignFromAnother (MR_ChangeSceneAction *_this, MR_PassBy _other_pass_by, MR_ChangeSceneAction *_other)
MRC_API MR_std_string *	MR_ChangeSceneAction_name (const MR_ChangeSceneAction *_this)
MRC_API void	MR_ChangeSceneAction_action (MR_ChangeSceneAction *_this, MR_HistoryAction_Type actionType)
MRC_API MR_uint64_t	MR_ChangeSceneAction_heapBytes (const MR_ChangeSceneAction *_this)

Typedef Documentation

MR_ChangeSceneAction

typedef struct MR_ChangeSceneAction MR_ChangeSceneAction

Change scene action Generated from class MR::ChangeSceneAction. Base classes: Direct: (non-virtual) MR::HistoryAction Supported MR_PassBy modes: MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_ChangeSceneAction_Type

typedef enum MR_ChangeSceneAction_Type MR_ChangeSceneAction_Type

MR_HistoryAction

typedef struct MR_HistoryAction MR_HistoryAction

MR_std_shared_ptr_MR_Object

typedef struct MR_std_shared_ptr_MR_Object MR_std_shared_ptr_MR_Object

MR_std_string

typedef struct MR_std_string MR_std_string

Enumeration Type Documentation

MR_ChangeSceneAction_Type

enum MR_ChangeSceneAction_Type

Enumerator
MR_ChangeSceneAction_Type_AddObject
MR_ChangeSceneAction_Type_RemoveObject

Function Documentation

MR_ChangeSceneAction_action()

MRC_API void MR_ChangeSceneAction_action	(	MR_ChangeSceneAction *	_this,
		MR_HistoryAction_Type	actionType )

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

MR_ChangeSceneAction_AssignFromAnother()

MRC_API MR_ChangeSceneAction * MR_ChangeSceneAction_AssignFromAnother	(	MR_ChangeSceneAction *	_this,
		MR_PassBy	_other_pass_by,
		MR_ChangeSceneAction *	_other )

Generated from method MR::ChangeSceneAction::operator=. 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_ChangeSceneAction_Construct()

MRC_API MR_ChangeSceneAction * MR_ChangeSceneAction_Construct	(	const char *	name,
		const char *	name_end,
		const MR_std_shared_ptr_MR_Object *	obj,
		MR_ChangeSceneAction_Type	type )

Constructed before removal or addition Generated from constructor MR::ChangeSceneAction::ChangeSceneAction. Parameter name can not be null. If name_end is null, then name is assumed to be null-terminated. Parameter obj can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_ChangeSceneAction_Destroy() to free it when you're done using it.

MR_ChangeSceneAction_ConstructFromAnother()

MRC_API MR_ChangeSceneAction * MR_ChangeSceneAction_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_ChangeSceneAction *	_other )

Generated from constructor MR::ChangeSceneAction::ChangeSceneAction. Never returns null. Returns an instance allocated on the heap! Must call MR_ChangeSceneAction_Destroy() to free it when you're done using it.

MR_ChangeSceneAction_Destroy()

MRC_API void MR_ChangeSceneAction_Destroy

(

const MR_ChangeSceneAction *

_this

)

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

MR_ChangeSceneAction_DestroyArray()

MRC_API void MR_ChangeSceneAction_DestroyArray

(

const MR_ChangeSceneAction *

_this

)

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

MR_ChangeSceneAction_heapBytes()

MRC_API MR_uint64_t MR_ChangeSceneAction_heapBytes

(

const MR_ChangeSceneAction *

_this

)

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

MR_ChangeSceneAction_MutableUpcastTo_MR_HistoryAction()

MRC_API MR_HistoryAction * MR_ChangeSceneAction_MutableUpcastTo_MR_HistoryAction

(

MR_ChangeSceneAction *

object

)

Upcasts an instance of MR::ChangeSceneAction to its base class MR::HistoryAction.

MR_ChangeSceneAction_name()

MRC_API MR_std_string * MR_ChangeSceneAction_name

(

const MR_ChangeSceneAction *

_this

)

Generated from method MR::ChangeSceneAction::name. 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_ChangeSceneAction_OffsetMutablePtr()

MRC_API MR_ChangeSceneAction * MR_ChangeSceneAction_OffsetMutablePtr	(	MR_ChangeSceneAction *	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.

MR_ChangeSceneAction_OffsetPtr()

MRC_API const MR_ChangeSceneAction * MR_ChangeSceneAction_OffsetPtr	(	const MR_ChangeSceneAction *	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.

MR_ChangeSceneAction_UpcastTo_MR_HistoryAction()

MRC_API const MR_HistoryAction * MR_ChangeSceneAction_UpcastTo_MR_HistoryAction

(

const MR_ChangeSceneAction *

object

)

Upcasts an instance of MR::ChangeSceneAction to its base class MR::HistoryAction. This version is acting on mutable pointers.