maquina::ModificationContext Class Reference

#include <ModificationContext.h>

Public Types
enum	SetValueMode { SetValueMode::no_undo, SetValueMode::undoable, SetValueMode::layer, SetValueMode::animated }

Public Member Functions
	ModificationContext (SetValueMode set_value_mode, float frame=ModificationContext::current_frame, bool layer_value=false)
float	frame () const
	Returns the frame at which the value should be set. More...
bool	is_current_frame () const
	Returns true if the modification is done at the current frame. More...

Static Public Member Functions
static SetValueMode	lower (SetValueMode a, SetValueMode b)
static SetValueMode	higher (SetValueMode a, SetValueMode b)

Public Attributes
SetValueMode	set_value_mode
	The mode to set the value. More...
bool	layer_value
	If true, the value is a layer value, it means, it has to be stored direclty in the layer. If false, the value is a final plug value, the layer value could be different. Non-layer values are supported only by the Bool, Int and Float types. More...

Static Public Attributes
static const ModificationContext	animated
	Set values which must have an animation. More...
static const ModificationContext	layer
	Set values in the active layer but do not require to be animated. More...
static const ModificationContext	undoable
	Set undoable values but do not require to be done in a layer. More...
static const ModificationContext	no_undo
	Set values directly in the plugs, without possible undo. More...
static const float	current_frame

Member Enumeration Documentation

SetValueMode

enum maquina::ModificationContext::SetValueMode

strong

Enumerator
no_undo	Set values directly in the plugs, without possible undo.
undoable	Set undoable values but do not require to be done in a layer.
layer	Set values in the active layer but do not require to be animated.
animated	Set values which must have an animation.

Constructor & Destructor Documentation

ModificationContext()

maquina::ModificationContext::ModificationContext	(	SetValueMode	set_value_mode,
		float	frame = ModificationContext::current_frame,
		bool	layer_value = false
	)

Member Function Documentation

frame()

float maquina::ModificationContext::frame

(

)

const

Returns the frame at which the value should be set.

higher()

static SetValueMode maquina::ModificationContext::higher ( SetValueMode  a, SetValueMode  b  )

static

is_current_frame()

bool maquina::ModificationContext::is_current_frame ( ) const

inline

Returns true if the modification is done at the current frame.

lower()

static SetValueMode maquina::ModificationContext::lower ( SetValueMode  a, SetValueMode  b  )

static

Member Data Documentation

animated

const ModificationContext maquina::ModificationContext::animated

static

Set values which must have an animation.

current_frame

const float maquina::ModificationContext::current_frame

static

layer

const ModificationContext maquina::ModificationContext::layer

static

Set values in the active layer but do not require to be animated.

layer_value

bool maquina::ModificationContext::layer_value

If true, the value is a layer value, it means, it has to be stored direclty in the layer. If false, the value is a final plug value, the layer value could be different. Non-layer values are supported only by the Bool, Int and Float types.

no_undo

const ModificationContext maquina::ModificationContext::no_undo

static

Set values directly in the plugs, without possible undo.

set_value_mode

SetValueMode maquina::ModificationContext::set_value_mode

The mode to set the value.

undoable

const ModificationContext maquina::ModificationContext::undoable

static

Set undoable values but do not require to be done in a layer.

---

The documentation for this class was generated from the following file:

• include/Maquina/ModificationContext.h