Detailed Description

A node used for animation playback.

Inheritance diagram for AnimationPlayer:

Classes
struct	Playback

Public Member Functions
	AnimationPlayer (const string &name=TypeNames[ANIMATION_PLAYER])

const auto &	getCurrentLibrary () const

const auto &	getCurrentAnimation () const

void	setCurrentLibrary (const string &name)

void	setCurrentAnimation (const string &name)

auto	add (const string &name, const shared_ptr< AnimationLibrary > &library)

shared_ptr< Animation >	getAnimation ()

auto	getLibrary ()

void	play (const string &name="")

void	seek (float duration)

void	playBackwards (const string &name="")

void	stop (bool keepState=false)

auto	isPlaying () const

auto	setAutoStart (const bool autoStart)

auto	setTarget (Node &target)

void	setTarget (Node *target)

Public Member Functions inherited from Node
	Node (const Node &orig)

	Node (const string &nodeName="Node", Type type=NODE)

virtual void	onReady ()

virtual void	onEnterScene ()

virtual void	onExitScene ()

virtual void	onProcess (const float alpha)

virtual void	onPhysicsProcess (const float delta)

virtual bool	onInput (InputEvent &inputEvent)

const mat4 &	getTransformLocal () const

const mat4 &	getTransformGlobal () const

vec3	toGlobal (vec3 local) const

vec3	toLocal (vec3 global) const

virtual void	setPosition (vec3 position)

vec3	getPosition () const

void	translate (const vec3 &localOffset)

virtual void	setPositionGlobal (const vec3 &position)

vec3	getPositionGlobal () const

void	rotate (quat quaternion)

void	rotateTowards (const quat &targetRotation, float maxAngle)

void	rotateX (float angle)

void	rotateY (float angle)

void	rotateZ (float angle)

void	setRotation (const quat &quater)

void	setRotationGlobal (const quat &quater)

void	setRotation (const vec3 &rot)

void	setRotationX (float angle)

void	setRotationY (float angle)

void	setRotationZ (float angle)

vec3	getRotation () const

vec3	getRotationGlobal () const

quat	getRotationQuaternion () const

quat	getRotationQuaternionGlobal () const

float	getRotationX () const

float	getRotationY () const

float	getRotationZ () const

virtual void	setScale (const vec3 &scale)

void	setScale (float scale)

vec3	getScale () const

vec3	getScaleGlobal () const

ProcessMode	getProcessMode () const

void	setProcessMode (const ProcessMode mode)

bool	isProcessed () const

Node *	getParent () const

bool	addChild (shared_ptr< Node > child, bool async=false)

bool	removeChild (const shared_ptr< Node > &child, bool async=false)

void	removeAllChildren (bool async=false)

bool	haveChild (const shared_ptr< Node > &child, bool recursive) const

template<typename T = Node>
shared_ptr< T >	getChild (const string &name) const

template<typename T = Node>
shared_ptr< T >	getChildByPath (const string &path) const

template<typename T = Node>
shared_ptr< T >	findFirstChild (const string &name) const

void	printTree (int tab=0) const

string	toString () const override

id_t	getId () const

shared_ptr< Node >	duplicate (bool recursiveFilter=false) const

template<typename T = Node>
shared_ptr< T >	makeFrom ()

template<typename T >
shared_ptr< T >	findFirstChild (const bool recursive=true) const

template<typename T >
list< shared_ptr< T > >	findAllChildren (const bool recursive=true) const

template<typename T = Node>
list< shared_ptr< T > >	findAllChildrenByGroup (const string &groupName, const bool recursive=true) const

vec3	getRightVector () const

vec3	getLeftVector () const

vec3	getFrontVector () const

vec3	getBackVector () const

vec3	getUpVector () const

vec3	getDownVector () const

template<typename T >
shared_ptr< Tween >	createPropertyTween (PropertyTween< T >::Setter set, T initial, T final, float duration, const TransitionType ttype=TransitionType::LINEAR, const Tween::Callback &callback=nullptr)

void	killTween (const shared_ptr< Tween > &tween)

virtual void	setProperty (const string &property, const string &value)

void	setName (const string &nodeName)

const list< shared_ptr< Node > > &	getChildren () const

Type	getType () const

const string &	getName () const

string	getPath () const

const list< string > &	getGroups () const

void	addToGroup (const string &group)

void	removeFromGroup (const string &group)

bool	isInGroup (const string &group) const

bool	isVisible () const

virtual void	setVisible (bool visible=true)

bool	isInsideTree () const

void	setCastShadows (bool castShadows)

Public Member Functions inherited from Object
void	connect (const Signal::signal &name, const Signal::Handler &handler)

void	connect (const Signal::signal &name, const function< void ()> &handler)

void	emit (const Signal::signal &name, void *params=nullptr)

Static Public Attributes
static const Signal::signal	on_playback_start = "on_playback_start"
	Signal emitted when an animation began playing.

static const Signal::signal	on_playback_finish = "on_playback_finish"
	Signal emitted when an animation stop playing.

Additional Inherited Members
Public Types inherited from Node
enum	Type
	Node type.

Constructor & Destructor Documentation

AnimationPlayer ( const string & name = TypeNames[ANIMATION_PLAYER] )

inlineexplicit

Creates an AnimationLibrary

Parameters

name	resource name.

Member Function Documentation

auto add	(	const string &	name,
		const shared_ptr< AnimationLibrary > &	library
	)

inline

Adds a library accessible by the name.

shared_ptr<Animation> getAnimation ( )

nodiscard

Returns the current animation, if any

const auto& getCurrentAnimation ( ) const

nodiscardinline

Returns the current animation name

const auto& getCurrentLibrary ( ) const

nodiscardinline

Returns the current library name

auto getLibrary ( )

nodiscardinline

Returns the current animation library, if any

auto isPlaying ( ) const

nodiscardinline

Returns true if the animation is currently playing

void play ( const string & name = "" )

Starts an animation by its name

void playBackwards ( const string & name = "" )

Starts an animation by its name, playing it backwards

void seek ( float duration )

Seeks the animation to the seconds point in time (in seconds).

auto setAutoStart ( const bool autoStart )

inline

Sets the auto start property.

void setCurrentAnimation ( const string & name )

Sets the current animation name (does not start the animation, only useful with auto-starting)

void setCurrentLibrary ( const string & name )

Sets the current library name

auto setTarget ( Node & target )

inline

Sets the node target on which to apply animations

void setTarget ( Node * target )

Sets the node target on which to apply animations

void stop ( bool keepState = false )

Stops the currently playing animation

Detailed Description

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation