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 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)
MRC_API MR_ChangeSceneAction *	MR_ChangeSceneAction_OffsetMutablePtr (MR_ChangeSceneAction *ptr, ptrdiff_t i)
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)
MRC_API const MR_ChangeSceneAction *	MR_ChangeSceneAction_StaticDowncastFrom_MR_HistoryAction (const MR_HistoryAction *object)
MRC_API MR_ChangeSceneAction *	MR_ChangeSceneAction_MutableStaticDowncastFrom_MR_HistoryAction (MR_HistoryAction *object)
MRC_API const MR_ChangeSceneAction *	MR_ChangeSceneAction_DynamicDowncastFrom_MR_HistoryAction (const MR_HistoryAction *object)
MRC_API MR_ChangeSceneAction *	MR_ChangeSceneAction_MutableDynamicDowncastFrom_MR_HistoryAction (MR_HistoryAction *object)
MRC_API const MR_ChangeSceneAction *	MR_ChangeSceneAction_DynamicDowncastFromOrFail_MR_HistoryAction (const MR_HistoryAction *object)
MRC_API MR_ChangeSceneAction *	MR_ChangeSceneAction_MutableDynamicDowncastFromOrFail_MR_HistoryAction (MR_HistoryAction *object)
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

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 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. When this function is called, this object will drop any object references it held previously.

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. The reference to the parameter name might be preserved in the constructed object. Parameter obj can not be null. It is a single object. The reference to the parameter obj might be preserved in the constructed object. The reference to the parameter type might be preserved in the constructed 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. 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_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_DynamicDowncastFrom_MR_HistoryAction()

MRC_API const MR_ChangeSceneAction * MR_ChangeSceneAction_DynamicDowncastFrom_MR_HistoryAction

(

const MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeSceneAction. This is a dynamic downcast, it checks the type before casting. This version will return zero if the target type is wrong. This version is acting on mutable pointers. The reference to the parameter object might be preserved in the return value.

MR_ChangeSceneAction_DynamicDowncastFromOrFail_MR_HistoryAction()

MRC_API const MR_ChangeSceneAction * MR_ChangeSceneAction_DynamicDowncastFromOrFail_MR_HistoryAction

(

const MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeSceneAction. This is a dynamic downcast, it checks the type before casting. This version will throw if the target type is wrong. This version is acting on mutable pointers. Parameter object can not be null. It is a single object. The reference to the parameter object might be preserved in the return value. The returned pointer will never be null. It is non-owning, do NOT destroy it.

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

MRC_API MR_ChangeSceneAction * MR_ChangeSceneAction_MutableDynamicDowncastFrom_MR_HistoryAction

(

MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeSceneAction. This is a dynamic downcast, it checks the type before casting. This version will return zero if the target type is wrong. The reference to the parameter object might be preserved in the return value.

MR_ChangeSceneAction_MutableDynamicDowncastFromOrFail_MR_HistoryAction()

MRC_API MR_ChangeSceneAction * MR_ChangeSceneAction_MutableDynamicDowncastFromOrFail_MR_HistoryAction

(

MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeSceneAction. This is a dynamic downcast, it checks the type before casting. This version will throw if the target type is wrong. Parameter object can not be null. It is a single object. The reference to the parameter object might be preserved in the return value. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_ChangeSceneAction_MutableStaticDowncastFrom_MR_HistoryAction()

MRC_API MR_ChangeSceneAction * MR_ChangeSceneAction_MutableStaticDowncastFrom_MR_HistoryAction

(

MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeSceneAction. 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_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. The reference to the parameter object might be preserved in the return value.

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. The reference to the parameter ptr might be preserved in the return value.

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. The reference to the parameter ptr might be preserved in the return value.

MR_ChangeSceneAction_StaticDowncastFrom_MR_HistoryAction()

MRC_API const MR_ChangeSceneAction * MR_ChangeSceneAction_StaticDowncastFrom_MR_HistoryAction

(

const MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeSceneAction. 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_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. The reference to the parameter object might be preserved in the return value.