#include <CUActionManager.h>

Public Member Functions
	ActionManager ()

	~ActionManager ()

void	dispose ()

bool	init ()

bool	isActive (std::string key) const

bool	activate (std::string key, const std::shared_ptr< Action > &action, const std::shared_ptr< Node > &target)

bool	activate (std::string key, const std::shared_ptr< Action > &action, const std::shared_ptr< Node > &target, std::function< float(float)> easing)

bool	remove (std::string key)

void	update (float dt)

bool	isPaused (std::string key)

void	pause (std::string key)

void	unpause (std::string key)

void	clearAllActions (const std::shared_ptr< Node > &target)

void	pauseAllActions (const std::shared_ptr< Node > &target)

void	unpauseAllActions (const std::shared_ptr< Node > &target)

std::vector< std::string >	getAllActions (const std::shared_ptr< Node > &target) const

Static Public Member Functions
static std::shared_ptr< ActionManager >	alloc ()

Protected Attributes
std::unordered_map< Node *, std::unordered_set< std::string > >	_keys

std::unordered_map< std::string, ActionInstance * >	_actions

Detailed Description

This class provides an action manager for instantiating animations.

To create an animation, the manager attaches an action to a scene graph node via a key. This key allows the user to pause an animation or query when it is complete. Each update frame, the manager moves the animation further along until it is complete.

An action manager is not implemented as a singleton. However, you typically only need one manager per application.

Constructor & Destructor Documentation

◆ ActionManager()

cugl::ActionManager::ActionManager ( )

inline

Creates a new degenerate ActionManager on the stack.

NEVER USE A CONSTRUCTOR WITH NEW. If you want to allocate an object on the heap, use one of the static constructors instead.

◆ ~ActionManager()

cugl::ActionManager::~ActionManager ( )

inline

Deletes this action manager, disposing all resources

Member Function Documentation

◆ activate() [1/2]

bool cugl::ActionManager::activate	(	std::string	key,
		const std::shared_ptr< Action > &	action,
		const std::shared_ptr< Node > &	target
	)

inline

Actives an animation with the given target and action

This method will fail if the provided key is already in use.

Parameters

key	The identifying key
action	The action to animate with
target	The node to animate on

Returns: true if the animation was successfully started

◆ activate() [2/2]

bool cugl::ActionManager::activate	(	std::string	key,
		const std::shared_ptr< Action > &	action,
		const std::shared_ptr< Node > &	target,
		std::function< float(float)>	easing
	)

Actives an animation with the given target and action

The easing function allows for effects like bouncing or elasticity in the linear interpolation. If null, the animation will use the standard linear easing.

This method will fail if the provided key is already in use.

Parameters

key	The identifying key
action	The action to animate with
target	The node to animate on
easing	The easing (interpolation) function

Returns: true if the animation was successfully started

◆ alloc()

static std::shared_ptr<ActionManager> cugl::ActionManager::alloc ( )

inlinestatic

Returns a newly allocated action manager.

Returns: a newly allocated action manager.

◆ clearAllActions()

void cugl::ActionManager::clearAllActions ( const std::shared_ptr< Node > & target )

Removes all animations for the given target.

If the target has no associated animations, this method does nothing.

Parameters

target The node to stop animating

◆ dispose()

void cugl::ActionManager::dispose ( )

Disposes all of the resources used by this action manager.

A disposed action manager can be safely reinitialized. Any animations owned by this action manager will immediately stop and be released.

◆ getAllActions()

std::vector<std::string> cugl::ActionManager::getAllActions ( const std::shared_ptr< Node > & target ) const

Returns the keys for all active animations of the given target

The returned vector is a copy of the keys. Modifying it has no affect on the underlying animation.

Parameters

target The node to query animations

Returns: the keys for all active animations of the given target

◆ init()

bool cugl::ActionManager::init ( )

inline

Initializes an action manager.

Returns: true if initialization was successful.

◆ isActive()

bool cugl::ActionManager::isActive ( std::string key ) const

Returns true if the given key represents an active animation

Parameters

key	The identifying key

Returns: true if the given key represents an active animation

◆ isPaused()

bool cugl::ActionManager::isPaused ( std::string key )

Returns true if the animation for the given key is paused

This method will return false if there is no active animation with the given key.

Parameters

key	The identifying key

Returns: true if the animation for the given key is paused

◆ pause()

void cugl::ActionManager::pause ( std::string key )

Pauses the animation for the given key.

If there is no active animation for the given key, or if it is already paused, this method does nothing.

Parameters

key	The identifying key

◆ pauseAllActions()

void cugl::ActionManager::pauseAllActions ( const std::shared_ptr< Node > & target )

Pauses all animations for the given target.

If the target has no associated animations, or if all of its animations are already paused, this method does nothing.

Parameters

target The node to pause animating

◆ remove()

bool cugl::ActionManager::remove ( std::string key )

Removes the animation for the given key.

This act will immediately stop the animation. The animated node will continue to have whatever state it had when the animation stopped.

If there is no animation for the give key (e.g. the animation is complete) this method will return false.

Parameters

key	The identifying key

Returns: true if the animation was successfully removed

◆ unpause()

void cugl::ActionManager::unpause ( std::string key )

Unpauses the animation for the given key.

If there is no active animation for the given key, or if it is not currently paused, this method does nothing.

Parameters

key	The identifying key

◆ unpauseAllActions()

void cugl::ActionManager::unpauseAllActions ( const std::shared_ptr< Node > & target )

Unpauses all animations for the given target.

If the target has no associated animations, or if none of its animations are currenly paused, this method does nothing.

Parameters

target The node to pause animating

◆ update()

void cugl::ActionManager::update ( float dt )

Updates all non-paused animations by dt seconds

Each animation is moved forward by dt second. If this causes an animation to reach its duration, the animation is removed and the key is once again available.

Parameters

dt	The number of seconds to animate

Member Data Documentation

◆ _actions

std::unordered_map<std::string, ActionInstance*> cugl::ActionManager::_actions

protected

A map that associates keys with animations

◆ _keys

std::unordered_map<Node*, std::unordered_set<std::string> > cugl::ActionManager::_keys

protected

A map that associates nodes with their (multiple) animations

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

include/cugl/2d/actions/CUActionManager.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ActionManager()

◆ ~ActionManager()

Member Function Documentation

◆ activate() [1/2]

◆ activate() [2/2]

◆ alloc()

◆ clearAllActions()

◆ dispose()

◆ getAllActions()

◆ init()

◆ isActive()

◆ isPaused()

◆ pause()

◆ pauseAllActions()

◆ remove()

◆ unpause()

◆ unpauseAllActions()

◆ update()

Member Data Documentation

◆ _actions

◆ _keys