MRChangeObjectAction.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_ChangeObjectAction	MR_ChangeObjectAction

Functions
MRC_API MR_ChangeObjectAction *	MR_ChangeObjectAction_ConstructFromAnother (MR_PassBy _other_pass_by, MR_ChangeObjectAction *_other)
MRC_API const MR_ChangeObjectAction *	MR_ChangeObjectAction_OffsetPtr (const MR_ChangeObjectAction *ptr, ptrdiff_t i)
MRC_API MR_ChangeObjectAction *	MR_ChangeObjectAction_OffsetMutablePtr (MR_ChangeObjectAction *ptr, ptrdiff_t i)
MRC_API const MR_HistoryAction *	MR_ChangeObjectAction_UpcastTo_MR_HistoryAction (const MR_ChangeObjectAction *object)
MRC_API MR_HistoryAction *	MR_ChangeObjectAction_MutableUpcastTo_MR_HistoryAction (MR_ChangeObjectAction *object)
MRC_API const MR_ChangeObjectAction *	MR_ChangeObjectAction_StaticDowncastFrom_MR_HistoryAction (const MR_HistoryAction *object)
MRC_API MR_ChangeObjectAction *	MR_ChangeObjectAction_MutableStaticDowncastFrom_MR_HistoryAction (MR_HistoryAction *object)
MRC_API const MR_ChangeObjectAction *	MR_ChangeObjectAction_DynamicDowncastFrom_MR_HistoryAction (const MR_HistoryAction *object)
MRC_API MR_ChangeObjectAction *	MR_ChangeObjectAction_MutableDynamicDowncastFrom_MR_HistoryAction (MR_HistoryAction *object)
MRC_API const MR_ChangeObjectAction *	MR_ChangeObjectAction_DynamicDowncastFromOrFail_MR_HistoryAction (const MR_HistoryAction *object)
MRC_API MR_ChangeObjectAction *	MR_ChangeObjectAction_MutableDynamicDowncastFromOrFail_MR_HistoryAction (MR_HistoryAction *object)
MRC_API MR_ChangeObjectAction *	MR_ChangeObjectAction_Construct (const char *name, const char *name_end, const MR_std_shared_ptr_MR_Object *obj)
MRC_API void	MR_ChangeObjectAction_Destroy (const MR_ChangeObjectAction *_this)
	Destroys a heap-allocated instance of MR_ChangeObjectAction. Does nothing if the pointer is null.
MRC_API void	MR_ChangeObjectAction_DestroyArray (const MR_ChangeObjectAction *_this)
	Destroys a heap-allocated array of MR_ChangeObjectAction. Does nothing if the pointer is null.
MRC_API MR_ChangeObjectAction *	MR_ChangeObjectAction_AssignFromAnother (MR_ChangeObjectAction *_this, MR_PassBy _other_pass_by, MR_ChangeObjectAction *_other)
MRC_API MR_std_string *	MR_ChangeObjectAction_name (const MR_ChangeObjectAction *_this)
MRC_API void	MR_ChangeObjectAction_action (MR_ChangeObjectAction *_this, MR_HistoryAction_Type _1)
MRC_API MR_uint64_t	MR_ChangeObjectAction_heapBytes (const MR_ChangeObjectAction *_this)

Typedef Documentation

MR_ChangeObjectAction

typedef struct MR_ChangeObjectAction MR_ChangeObjectAction

History action for object change Generated from class MR::ChangeObjectAction. 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).

Function Documentation

MR_ChangeObjectAction_action()

MRC_API void MR_ChangeObjectAction_action	(	MR_ChangeObjectAction *	_this,
		MR_HistoryAction_Type	_1 )

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

MR_ChangeObjectAction_AssignFromAnother()

MRC_API MR_ChangeObjectAction * MR_ChangeObjectAction_AssignFromAnother	(	MR_ChangeObjectAction *	_this,
		MR_PassBy	_other_pass_by,
		MR_ChangeObjectAction *	_other )

Generated from method MR::ChangeObjectAction::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_ChangeObjectAction_Construct()

MRC_API MR_ChangeObjectAction * MR_ChangeObjectAction_Construct	(	const char *	name,
		const char *	name_end,
		const MR_std_shared_ptr_MR_Object *	obj )

Constructed from original Object Generated from constructor MR::ChangeObjectAction::ChangeObjectAction. 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. Never returns null. Returns an instance allocated on the heap! Must call MR_ChangeObjectAction_Destroy() to free it when you're done using it.

MR_ChangeObjectAction_ConstructFromAnother()

MRC_API MR_ChangeObjectAction * MR_ChangeObjectAction_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_ChangeObjectAction *	_other )

Generated from constructor MR::ChangeObjectAction::ChangeObjectAction. 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_ChangeObjectAction_Destroy() to free it when you're done using it.

MR_ChangeObjectAction_Destroy()

MRC_API void MR_ChangeObjectAction_Destroy

(

const MR_ChangeObjectAction *

_this

)

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

MR_ChangeObjectAction_DestroyArray()

MRC_API void MR_ChangeObjectAction_DestroyArray

(

const MR_ChangeObjectAction *

_this

)

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

MR_ChangeObjectAction_DynamicDowncastFrom_MR_HistoryAction()

MRC_API const MR_ChangeObjectAction * MR_ChangeObjectAction_DynamicDowncastFrom_MR_HistoryAction

(

const MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeObjectAction. 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_ChangeObjectAction_DynamicDowncastFromOrFail_MR_HistoryAction()

MRC_API const MR_ChangeObjectAction * MR_ChangeObjectAction_DynamicDowncastFromOrFail_MR_HistoryAction

(

const MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeObjectAction. 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_ChangeObjectAction_heapBytes()

MRC_API MR_uint64_t MR_ChangeObjectAction_heapBytes

(

const MR_ChangeObjectAction *

_this

)

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

MR_ChangeObjectAction_MutableDynamicDowncastFrom_MR_HistoryAction()

MRC_API MR_ChangeObjectAction * MR_ChangeObjectAction_MutableDynamicDowncastFrom_MR_HistoryAction

(

MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeObjectAction. 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_ChangeObjectAction_MutableDynamicDowncastFromOrFail_MR_HistoryAction()

MRC_API MR_ChangeObjectAction * MR_ChangeObjectAction_MutableDynamicDowncastFromOrFail_MR_HistoryAction

(

MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeObjectAction. 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_ChangeObjectAction_MutableStaticDowncastFrom_MR_HistoryAction()

MRC_API MR_ChangeObjectAction * MR_ChangeObjectAction_MutableStaticDowncastFrom_MR_HistoryAction

(

MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeObjectAction. 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_ChangeObjectAction_MutableUpcastTo_MR_HistoryAction()

MRC_API MR_HistoryAction * MR_ChangeObjectAction_MutableUpcastTo_MR_HistoryAction

(

MR_ChangeObjectAction *

object

)

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

MR_ChangeObjectAction_name()

MRC_API MR_std_string * MR_ChangeObjectAction_name

(

const MR_ChangeObjectAction *

_this

)

Generated from method MR::ChangeObjectAction::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_ChangeObjectAction_OffsetMutablePtr()

MRC_API MR_ChangeObjectAction * MR_ChangeObjectAction_OffsetMutablePtr	(	MR_ChangeObjectAction *	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_ChangeObjectAction_OffsetPtr()

MRC_API const MR_ChangeObjectAction * MR_ChangeObjectAction_OffsetPtr	(	const MR_ChangeObjectAction *	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_ChangeObjectAction_StaticDowncastFrom_MR_HistoryAction()

MRC_API const MR_ChangeObjectAction * MR_ChangeObjectAction_StaticDowncastFrom_MR_HistoryAction

(

const MR_HistoryAction *

object

)

Downcasts an instance of MR::HistoryAction to a derived class MR::ChangeObjectAction. 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_ChangeObjectAction_UpcastTo_MR_HistoryAction()

MRC_API const MR_HistoryAction * MR_ChangeObjectAction_UpcastTo_MR_HistoryAction

(

const MR_ChangeObjectAction *

object

)

Upcasts an instance of MR::ChangeObjectAction 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.