MRCombinedHistoryAction.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_std_function_bool_from_const_std_shared_ptr_MR_HistoryAction_ref	MR_std_function_bool_from_const_std_shared_ptr_MR_HistoryAction_ref
typedef struct MR_std_vector_std_shared_ptr_MR_HistoryAction	MR_std_vector_std_shared_ptr_MR_HistoryAction
typedef struct MR_CombinedHistoryAction	MR_CombinedHistoryAction

Functions
MRC_API MR_CombinedHistoryAction *	MR_CombinedHistoryAction_ConstructFromAnother (MR_PassBy _other_pass_by, MR_CombinedHistoryAction *_other)
MRC_API const MR_CombinedHistoryAction *	MR_CombinedHistoryAction_OffsetPtr (const MR_CombinedHistoryAction *ptr, ptrdiff_t i)
MRC_API MR_CombinedHistoryAction *	MR_CombinedHistoryAction_OffsetMutablePtr (MR_CombinedHistoryAction *ptr, ptrdiff_t i)
MRC_API const MR_HistoryAction *	MR_CombinedHistoryAction_UpcastTo_MR_HistoryAction (const MR_CombinedHistoryAction *object)
MRC_API MR_HistoryAction *	MR_CombinedHistoryAction_MutableUpcastTo_MR_HistoryAction (MR_CombinedHistoryAction *object)
MRC_API const MR_CombinedHistoryAction *	MR_CombinedHistoryAction_StaticDowncastFrom_MR_HistoryAction (const MR_HistoryAction *object)
MRC_API MR_CombinedHistoryAction *	MR_CombinedHistoryAction_MutableStaticDowncastFrom_MR_HistoryAction (MR_HistoryAction *object)
MRC_API const MR_CombinedHistoryAction *	MR_CombinedHistoryAction_DynamicDowncastFrom_MR_HistoryAction (const MR_HistoryAction *object)
MRC_API MR_CombinedHistoryAction *	MR_CombinedHistoryAction_MutableDynamicDowncastFrom_MR_HistoryAction (MR_HistoryAction *object)
MRC_API const MR_CombinedHistoryAction *	MR_CombinedHistoryAction_DynamicDowncastFromOrFail_MR_HistoryAction (const MR_HistoryAction *object)
MRC_API MR_CombinedHistoryAction *	MR_CombinedHistoryAction_MutableDynamicDowncastFromOrFail_MR_HistoryAction (MR_HistoryAction *object)
MRC_API MR_CombinedHistoryAction *	MR_CombinedHistoryAction_Construct (const char *name, const char *name_end, const MR_std_vector_std_shared_ptr_MR_HistoryAction *actions)
MRC_API void	MR_CombinedHistoryAction_Destroy (const MR_CombinedHistoryAction *_this)
	Destroys a heap-allocated instance of MR_CombinedHistoryAction. Does nothing if the pointer is null.
MRC_API void	MR_CombinedHistoryAction_DestroyArray (const MR_CombinedHistoryAction *_this)
	Destroys a heap-allocated array of MR_CombinedHistoryAction. Does nothing if the pointer is null.
MRC_API MR_CombinedHistoryAction *	MR_CombinedHistoryAction_AssignFromAnother (MR_CombinedHistoryAction *_this, MR_PassBy _other_pass_by, MR_CombinedHistoryAction *_other)
MRC_API MR_std_string *	MR_CombinedHistoryAction_name (const MR_CombinedHistoryAction *_this)
MRC_API void	MR_CombinedHistoryAction_action (MR_CombinedHistoryAction *_this, MR_HistoryAction_Type type)
MRC_API MR_std_vector_std_shared_ptr_MR_HistoryAction *	MR_CombinedHistoryAction_getStack_mut (MR_CombinedHistoryAction *_this)
MRC_API const MR_std_vector_std_shared_ptr_MR_HistoryAction *	MR_CombinedHistoryAction_getStack (const MR_CombinedHistoryAction *_this)
MRC_API bool	MR_CombinedHistoryAction_filter (MR_CombinedHistoryAction *_this, MR_PassBy filteringCondition_pass_by, MR_std_function_bool_from_const_std_shared_ptr_MR_HistoryAction_ref *filteringCondition)
MRC_API bool	MR_CombinedHistoryAction_empty (const MR_CombinedHistoryAction *_this)
MRC_API MR_uint64_t	MR_CombinedHistoryAction_heapBytes (const MR_CombinedHistoryAction *_this)

Typedef Documentation

MR_CombinedHistoryAction

typedef struct MR_CombinedHistoryAction MR_CombinedHistoryAction

History action for combine some history actions Generated from class MR::CombinedHistoryAction. 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_std_function_bool_from_const_std_shared_ptr_MR_HistoryAction_ref

typedef struct MR_std_function_bool_from_const_std_shared_ptr_MR_HistoryAction_ref MR_std_function_bool_from_const_std_shared_ptr_MR_HistoryAction_ref

Stores a functor of type: bool(const std::shared_ptr<MR::HistoryAction> &). Possibly stateful. 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_HistoryAction

typedef struct MR_std_vector_std_shared_ptr_MR_HistoryAction MR_std_vector_std_shared_ptr_MR_HistoryAction

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

Function Documentation

MR_CombinedHistoryAction_action()

MRC_API void MR_CombinedHistoryAction_action	(	MR_CombinedHistoryAction *	_this,
		MR_HistoryAction_Type	type )

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

MR_CombinedHistoryAction_AssignFromAnother()

MRC_API MR_CombinedHistoryAction * MR_CombinedHistoryAction_AssignFromAnother	(	MR_CombinedHistoryAction *	_this,
		MR_PassBy	_other_pass_by,
		MR_CombinedHistoryAction *	_other )

Generated from method MR::CombinedHistoryAction::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_CombinedHistoryAction_Construct()

MRC_API MR_CombinedHistoryAction * MR_CombinedHistoryAction_Construct	(	const char *	name,
		const char *	name_end,
		const MR_std_vector_std_shared_ptr_MR_HistoryAction *	actions )

Will call action() for each actions in given order (undo in reverse, redo in forward) Generated from constructor MR::CombinedHistoryAction::CombinedHistoryAction. 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 actions can not be null. It is a single object. The reference to the parameter actions might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_CombinedHistoryAction_Destroy() to free it when you're done using it.

MR_CombinedHistoryAction_ConstructFromAnother()

MRC_API MR_CombinedHistoryAction * MR_CombinedHistoryAction_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_CombinedHistoryAction *	_other )

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

MR_CombinedHistoryAction_Destroy()

MRC_API void MR_CombinedHistoryAction_Destroy

(

const MR_CombinedHistoryAction *

_this

)

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

MR_CombinedHistoryAction_DestroyArray()

MRC_API void MR_CombinedHistoryAction_DestroyArray

(

const MR_CombinedHistoryAction *

_this

)

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

MR_CombinedHistoryAction_DynamicDowncastFrom_MR_HistoryAction()

MRC_API const MR_CombinedHistoryAction * MR_CombinedHistoryAction_DynamicDowncastFrom_MR_HistoryAction

(

const MR_HistoryAction *

object

)

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

MRC_API const MR_CombinedHistoryAction * MR_CombinedHistoryAction_DynamicDowncastFromOrFail_MR_HistoryAction

(

const MR_HistoryAction *

object

)

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

MRC_API bool MR_CombinedHistoryAction_empty

(

const MR_CombinedHistoryAction *

_this

)

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

MR_CombinedHistoryAction_filter()

MRC_API bool MR_CombinedHistoryAction_filter	(	MR_CombinedHistoryAction *	_this,
		MR_PassBy	filteringCondition_pass_by,
		MR_std_function_bool_from_const_std_shared_ptr_MR_HistoryAction_ref *	filteringCondition )

Remove some actions according to condition inside combined actions. Do deep filtering. Generated from method MR::CombinedHistoryAction::filter. Parameter _this can not be null. It is a single object.

MR_CombinedHistoryAction_getStack()

MRC_API const MR_std_vector_std_shared_ptr_MR_HistoryAction * MR_CombinedHistoryAction_getStack

(

const MR_CombinedHistoryAction *

_this

)

Generated from method MR::CombinedHistoryAction::getStack. 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_CombinedHistoryAction_getStack_mut()

MRC_API MR_std_vector_std_shared_ptr_MR_HistoryAction * MR_CombinedHistoryAction_getStack_mut

(

MR_CombinedHistoryAction *

_this

)

Generated from method MR::CombinedHistoryAction::getStack. 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_CombinedHistoryAction_heapBytes()

MRC_API MR_uint64_t MR_CombinedHistoryAction_heapBytes

(

const MR_CombinedHistoryAction *

_this

)

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

MR_CombinedHistoryAction_MutableDynamicDowncastFrom_MR_HistoryAction()

MRC_API MR_CombinedHistoryAction * MR_CombinedHistoryAction_MutableDynamicDowncastFrom_MR_HistoryAction

(

MR_HistoryAction *

object

)

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

MRC_API MR_CombinedHistoryAction * MR_CombinedHistoryAction_MutableDynamicDowncastFromOrFail_MR_HistoryAction

(

MR_HistoryAction *

object

)

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

MRC_API MR_CombinedHistoryAction * MR_CombinedHistoryAction_MutableStaticDowncastFrom_MR_HistoryAction

(

MR_HistoryAction *

object

)

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

MRC_API MR_HistoryAction * MR_CombinedHistoryAction_MutableUpcastTo_MR_HistoryAction

(

MR_CombinedHistoryAction *

object

)

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

MR_CombinedHistoryAction_name()

MRC_API MR_std_string * MR_CombinedHistoryAction_name

(

const MR_CombinedHistoryAction *

_this

)

Generated from method MR::CombinedHistoryAction::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_CombinedHistoryAction_OffsetMutablePtr()

MRC_API MR_CombinedHistoryAction * MR_CombinedHistoryAction_OffsetMutablePtr	(	MR_CombinedHistoryAction *	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_CombinedHistoryAction_OffsetPtr()

MRC_API const MR_CombinedHistoryAction * MR_CombinedHistoryAction_OffsetPtr	(	const MR_CombinedHistoryAction *	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_CombinedHistoryAction_StaticDowncastFrom_MR_HistoryAction()

MRC_API const MR_CombinedHistoryAction * MR_CombinedHistoryAction_StaticDowncastFrom_MR_HistoryAction

(

const MR_HistoryAction *

object

)

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

MRC_API const MR_HistoryAction * MR_CombinedHistoryAction_UpcastTo_MR_HistoryAction

(

const MR_CombinedHistoryAction *

object

)

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