MultiWidgets::Animation Class Reference

This class acts as the controller for multiple AnimationClips. More...

#include <MultiWidgets/Animation.hpp>

Inheritance diagram for MultiWidgets::Animation:

Public Types
enum	StopFlag { STOP_ALL, DO_NOT_STOP }
	These flags defines how other animations are treated when a new animation clip is started. More...

Public Member Functions
bool	addClip (const QString &animationName, const AnimationClip &animation)
	Add animation clip. More...
void	advance (float dt)
	Advance the animations by given time. More...
	Animation (Valuable::Node &node)
	Construct a new animation controller and attach it to the given node. More...
AnimationState &	animationState (const QString &animationName)
	Get the animation state of an animation. More...
const AnimationState &	animationState (const QString &animationName) const
	Get the animation state of an animation. More...
int	clipCount () const
	Get the number of animation clips. More...
bool	hasClip (const QString &animationName) const
	Check if the animation controller contains the given clip. More...
bool	isPlaying (const QString &animationName) const
	Check if the given animation is playing. More...
void	pause (const QString &animationName)
	Pause the given animation Next time when playing the animation it will continue from the position it was paused. More...
void	pause ()
	Pause all currently playing animations.
bool	play (const QString &animationName, StopFlag stopFlag=DO_NOT_STOP)
	Play the given animation. More...
void	removeClip (const QString &animationName)
	Remove the given animation clip. More...
void	sample ()
	Compute the interpolated animation values and apply them to the target node. More...
void	stop (bool stopPaused=true)
	Stop all animations. More...
void	stop (const QString &animationName)
	Stop the given animation. More...
virtual void	update (MultiWidgets::Widget &w, const MultiWidgets::FrameInfo &frameInfo)
	Perform animation logic. More...
	~Animation ()
	Destructor.
Public Member Functions inherited from MultiWidgets::Operator
virtual void	added (MultiWidgets::Widget &w)
	Called when the operator is added to a widget. More...
virtual OperatorPtr	clone () const
	Creates a copy of the operator. More...
virtual void	input (MultiWidgets::Widget &w, MultiWidgets::GrabManager &gm, const MultiWidgets::TrackedObjects &trackedObjects, float dt)
	Perform the operator logic on input. More...
virtual void	interactionBegin (MultiWidgets::Widget &w, MultiWidgets::GrabManager &gm)
	This function gets called when the Widget::interactionBegin is called for the widget this operator is attached to. More...
virtual void	interactionEnd (MultiWidgets::Widget &w, MultiWidgets::GrabManager &gm)
	This function gets called when the Widget::interactionEnd is called for the widget this operator is attached to. More...
virtual bool	isActive () const
	Returns true if the operator is currently active. More...
bool	isDone () const
	Is the operator done (i.e. More...
	Operator ()
	Default constructor.
virtual void	removed (MultiWidgets::Widget &w)
	Called when the operator is removed from the widget or the widget is deleted. More...
virtual void	reset ()
	Resets the state of the operator. More...
virtual QByteArray	type () const
	Returns the type id of the Operator. More...
virtual	~Operator ()
	Destructor.
Public Member Functions inherited from Stylish::Styleable
void	addCSSClass (const QString &s)
	Adds the Styleable to CSS class s. More...
void	addCSSClasses (const QStringList &classes)
	Adds the Styleable to given CSS classes. More...
QString	attributeSource (const QByteArray &name) const
	Gets CSS declaration source location based on the attribute name For example if this object has "size" attribute that is set from a CSS file, attributeSource("size") would return "filename.css:line". More...
const Style &	childStyle () const
	Cached style that should be applied to all children of this object.
const Radiant::ArraySet < QByteArray > &	cssClasses () const
	Get the CSS classes of the Styleable in lowercase.
const QString &	cssClassStr () const
	Get the CSS classes of the Styleable as a space separated string. More...
QString	cssId () const
	Get the CSS id of the Styleable. More...
const QByteArray &	cssType () const
	Get the CSS type of the Styleable.
bool	hasCSSClass (const QByteArray &s) const
	Does the Styleable belong to given CSS class. More...
bool	match (const SimpleSelector &ss, int *specificityOut=nullptr) const
	Checks if SimpleSelector matches this object. More...
bool	pseudoClass (const QByteArray &name) const
	Query if the Styleable has pseudo class called name.
void	removeCSSClass (const QString &s)
	Remove the Styleable from CSS class s. More...
void	setCSSClasses (const QString &s)
	Set the CSS classes as a space separated list You almost always want to use addCSSClass instead of this one. More...
void	setCSSId (const QString &s)
	Set the CSS id of the Styleable. More...
void	setCSSType (const QByteArray &s)
	Set the CSS type of the Styleable.
virtual bool	setProperty (Valuable::Attribute &var, const Valuable::StyleValue &value, Layer layer)
	Converts the given Stylish::Value to Valuable::Attribute.
void	setPseudoClass (const QByteArray &name, bool state)
	Disable or enable pseudo class.
virtual bool	setStyle (const Style &style)
	Applies a style to the object. More...
QString	simpleSelector (bool includePseudoClasses=true) const
	Returns a CSS simple selector that matches this Styleable.
const Style &	style () const
	Returns the style for this object.
	Styleable (const QByteArray &name="Styleable")
	Constructor for Styleable. More...
Public Member Functions inherited from Valuable::Node
bool	acceptsEvent (const QByteArray &messageId) const
	Returns true if this object accepts event 'id' in eventProcess.
bool	addAttribute (Attribute *const attribute)
	Adds a new Attribute to the list of attribute objects. More...
bool	addAttribute (const QByteArray &name, Attribute *const attribute)
	Adds a new Attribute to the list of attribute objects.
template<typename Widget >
bool	addAttribute (const QByteArray &name, const Radiant::IntrusivePtr< Widget > &attribute)
	Adds a new Attribute to the list of attribute objects. More...
long	addListener (const QByteArray &attribute, v8::Persistent< v8::Function > func, int role=Attribute::CHANGE_ROLE)
	Add a JavaScript attribute listener to attribute belonging this Node. More...
virtual Attribute *	attribute (const QByteArray &name) const
	Gets an Attribute with the given name. More...
template<typename T >
AttributeT< T > *	attribute (const QByteArray &name) const
	Gets an Attribute with the given name. More...
const container &	attributes () const
void	clearValues (Layer layer)
	Clears all Attribute values of the given layer. More...
void	debugDump ()
	Prints the contents of this Attribute to the terminal.
virtual bool	deserialize (const ArchiveElement &element)
	De-serializes this object (and its children) from a DOM node.
void	eventAddDeprecated (const QByteArray &deprecatedId, const QByteArray &newId)
	Register a deprecated event that is automatically converted to new event id and a warning is issued when it is used. More...
void	eventAddIn (const QByteArray &messageId)
	Registers a new event that this class handles in eventProcess.
template<typename Widget >
long	eventAddListener (const QByteArray &eventId, const QByteArray &messageId, Radiant::IntrusivePtr< Widget > &listener, ListenerType listenerType=DIRECT, const Radiant::BinaryData *defaultData=0)
	Add an event listener to this object. More...
long	eventAddListener (const QByteArray &eventId, const QByteArray &messageId, Valuable::Node *listener, ListenerType listenerType=DIRECT, const Radiant::BinaryData *defaultData=0)
	Add an event listener to this object. More...
long	eventAddListener (const QByteArray &eventId, ListenerFuncVoid func, ListenerType listenerType=DIRECT)
	Add an event listener to this object. More...
long	eventAddListener (const QByteArray &eventId, Node *dstNode, ListenerFuncVoid func, ListenerType listenerType=DIRECT)
long	eventAddListenerBd (const QByteArray &eventId, Node *dstNode, ListenerFuncBd func, ListenerType listenerType=DIRECT)
long	eventAddListenerBd (const QByteArray &eventId, ListenerFuncBd func, ListenerType listenerType=DIRECT)
	Add an event listener to this object. More...
void	eventAddOut (const QByteArray &eventId)
	Registers a new event this class can send with eventSend.
const QSet< QByteArray > &	eventInNames () const
	Returns set of all registered IN events.
unsigned	eventListenerCount () const
	Returns the number of event listeners.
const QSet< QByteArray > &	eventOutNames () const
	Returns set of all registered OUT events.
void	eventPassingEnable (bool enable)
	Control whether events are passed.
template<typename Widget >
int	eventRemoveListener (Radiant::IntrusivePtr< Widget > &listener)
	Removes all events from this object to given listener. More...
template<typename Widget >
int	eventRemoveListener (const QByteArray &eventId=QByteArray(), const QByteArray &messageId=QByteArray(), Radiant::IntrusivePtr< Widget > &listener=Radiant::IntrusivePtr< Widget >())
	Removes events from this object that match the parameters. More...
int	eventRemoveListener (const QByteArray &eventId=QByteArray(), const QByteArray &messageId=QByteArray(), Valuable::Node *listener=0)
	Removes event listeners from this object. More...
int	eventRemoveListener (Valuable::Node *listener)
	Removes all events from this object to given listener. More...
bool	eventRemoveListener (long listenerId)
	Removes event listener with given id. More...
void	eventSend (const QByteArray &eventId, Radiant::BinaryData &bd)
	Sends an event and bd to all listeners on this eventId.
void	eventSend (const QByteArray &eventId)
	Sends an event to all listeners on this eventId.
template<typename P1 >
void	eventSend (const QByteArray &eventId, const P1 &p1)
	Sends an event to all listeners on this eventId. More...
template<typename P1 , typename P2 >
void	eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2)
	Sends an event to all listeners on this eventId. More...
template<typename P1 , typename P2 , typename P3 >
void	eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2, const P3 &p3)
	Sends an event to all listeners on this eventId. More...
template<typename P1 , typename P2 , typename P3 , typename P4 >
void	eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2, const P3 &p3, const P4 &p4)
	Sends an event to all listeners on this eventId. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 >
void	eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2, const P3 &p3, const P4 &p4, const P5 &p5)
	Sends an event to all listeners on this eventId. More...
unsigned	eventSourceCount () const
	Returns the number of event sources.
Uuid	id () const
	Returns the unique id.
bool	isBeingDestroyed () const
	Returns true if we are about to delete this object. More...
bool	loadFromFileXML (const QString &filename)
	Reads this object (and its children) from an XML file.
bool	loadFromMemoryXML (const QByteArray &buffer)
	Reads this object (and its children) from a memory buffer.
	Node (Node *host, const QByteArray &name="", bool transit=false)
	Constructs a new Node and adds it under the given host. More...
	Node (Node &&node)
	Moves a node, including all its attributes, events etc. More...
Node &	operator= (Node &&node)
	Moves a node, replacing this. More...
virtual bool	readElement (const ArchiveElement &element)
	Handles a serialization element that lacks automatic handlers. More...
void	removeAttribute (Attribute *const attribute)
	Removes an Attribute from the list of attribute objects.
bool	saveToFileXML (const QString &filename, unsigned int opts=SerializationOptions::DEFAULTS) const
	Saves this object (and its children) to an XML file.
bool	saveToMemoryXML (QByteArray &buffer, unsigned int opts=SerializationOptions::DEFAULTS) const
	Saves this object (and its children) to binary data buffer.
virtual ArchiveElement	serialize (Archive &doc) const
	Serializes this object (and its children) to a DOM node.
virtual void	setAsDefaults ()
	Sets the current USER attribute value as the default value and clears the USER value. More...
void	setId (Uuid newId)
	Sets the unique id. More...
template<class T >
bool	setValue (const QByteArray &name, const T &v)
	Uses a query string to find a Attribute, and sets a new value to that if found. More...
bool	setValue (const QByteArray &name, v8::Handle< v8::Value > v)
	Set attribute value from JavaScript. More...
Public Member Functions inherited from Valuable::Attribute
long	addListener (ListenerFunc func, int role=CHANGE_ROLE)
	Adds a listener that is invoked whenever the value is changed. More...
long	addListener (Node *listener, ListenerFunc func, int role=CHANGE_ROLE)
	Adds a listener that is invoked whenever the value is changed. More...
long	addListener (v8::Persistent< v8::Function > func, int role=CHANGE_ROLE)
	Adds a JavaScript listener that is invoked whenever the value is changed. More...
virtual float	asFloat (bool *const ok=0, Layer layer=LAYER_CURRENT) const
	Converts the value object in a floating point number. More...
virtual int	asInt (bool *const ok=0, Layer layer=LAYER_CURRENT) const
	Converts the value object in an integer. More...
virtual QString	asString (bool *const ok=0, Layer layer=LAYER_CURRENT) const
	Converts the value object to a string. More...
	Attribute (const Attribute &o)
	Create a copy of the given Attribute WITHOUT the link to host, listeners, or the attribute name. More...
	Attribute (Node *host, const QByteArray &name, bool transit=false)
	Constructs a new value object and attaches it to its host. More...
virtual void	clearValue (Layer layer)
	Unsets the value from a specific layer. More...
virtual void	emitChange ()
	Invokes the change valueChanged function of all listeners.
virtual void	eventProcess (const QByteArray &id, Radiant::BinaryData &data)
	Process a message. More...
void	eventProcessFloat (const char *id, float v)
	Utility function for sending a float message to the object.
void	eventProcessInt (const char *id, int v)
	Utility function for sending an int message to the object.
void	eventProcessString (const char *id, const QString &str)
	Utility function for sending string message to the object.
void	eventProcessString (const char *id, const char *str)
	Utility function for sending string message to the object.
void	eventProcessVector2 (const char *id, Nimble::Vector2)
	Utility function for sending a Nimble::Vector2f message to the object.
void	eventProcessVector3 (const char *id, Nimble::Vector3)
	Utility function for sending a Vector3 message to the object.
void	eventProcessVector4 (const char *id, Nimble::Vector4)
	Utility function for sending a Vector4 message to the object.
virtual bool	handleShorthand (const Valuable::StyleValue &value, Radiant::ArrayMap< Valuable::Attribute *, Valuable::StyleValue > &expanded)
	If attribute supports shorthand properties, this should be used to parse those. More...
Node *	host () const
	The host object of the value object (is any). More...
virtual bool	isChanged () const
virtual bool	isValueDefinedOnLayer (Layer layer) const
	Check if the given layer defines a value. More...
bool	layerForSerialization (SerializationOptions flags, Layer &layer) const
const QByteArray &	name () const
	Returns the name of the object.
const Attribute &	operator= (const Attribute &)
	Create a copy of the given Attribute WITHOUT the link to host, listeners, or the attribute name. More...
Attribute *	ownerShorthand () const
QByteArray	path () const
	Returns the path (separated by '/'s) from the root.
void	removeHost ()
	Sets the host pointer to zero and removes this object from the host. More...
bool	removeListener (Node *listener, int role=ALL_ROLES)
	Removes a listener from the listener list. More...
bool	removeListener (long id)
	Removes a listener from the listener list. More...
void	removeListeners (int role=ALL_ROLES)
	Removes listeners from the listener list.
virtual bool	set (float v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
	Sets the value of the object.
virtual bool	set (int v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
	Sets the value of the object.
virtual bool	set (const QString &v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
	Sets the value of the object.
virtual bool	set (const Nimble::Vector2f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
	Sets the value of the object.
virtual bool	set (const Nimble::Vector3f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
	Sets the value of the object.
virtual bool	set (const Nimble::Vector4f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
	Sets the value of the object.
virtual bool	set (const StyleValue &value, Layer layer=USER)
	Sets the value of the object.
void	setName (const QByteArray &s)
	Sets the name of the object.
void	setOwnerShorthand (Attribute *owner)
Public Member Functions inherited from Valuable::Serializable
virtual bool	deserializeXML (const DOMElement &element)
	Deserializes (reads) this object from an XML element. More...
bool	isSerializable () const
void	setSerializable (bool v)

Additional Inherited Members
Valuable Attributes inherited from MultiWidgets::Operator
bool	done = false
	Is the operator done (i.e. More...
Node Events inherited from Stylish::Styleable
[OUT]	pseudo-class-changed (QString name, bool state)
	Pseudo class name was added (state == true) or removed (state == false)
Static Public Member Functions inherited from MultiWidgets::Operator
static OperatorPtr	create (const Valuable::ArchiveElement &element)
	Creates an operator by deserializing it from the archive.
Protected Member Functions inherited from MultiWidgets::Operator
void	setDone (bool done=true)
	Mark the Operator as done. More...
Protected Attributes inherited from Stylish::Styleable
Style	m_childStyle
	Cached style that should be applied to all children of this object.
Valuable::AttributeString	m_cssClass
	CSS class of the object as a space separated list.
Valuable::AttributeString	m_cssId
	CSS id of the object.
QByteArray	m_cssType
	CSS type of the object.
Style	m_style
	Currently applied style.

Detailed Description

This class acts as the controller for multiple AnimationClips.

It acts as a container for the AnimationClip objects and provides an API to to play, stop, pause and access the current state of running animations. Each widget has its own instance of this class used to control widget animations. This API is under development and is subject to change.

See Also

AnimationClip, AnimationCurve, Widget::animation

Member Enumeration Documentation

enum MultiWidgets::Animation::StopFlag

These flags defines how other animations are treated when a new animation clip is started.

Enumerator
STOP_ALL	Stop all other animations.
DO_NOT_STOP	Do not stop other animations.

Constructor & Destructor Documentation

MultiWidgets::Animation::Animation ( Valuable::Node &  node )

explicit

Construct a new animation controller and attach it to the given node.

Parameters

node	node whose parameters to animate

Member Function Documentation

bool MultiWidgets::Animation::addClip	(	const QString &	animationName,
		const AnimationClip &	animation
	)

Add animation clip.

Parameters

animationName	name used to reference the animation clip
animation	animation clip to add

Returns

false if an animation with the given name already exists; otherwise true

void MultiWidgets::Animation::advance

(

float

dt

)

Advance the animations by given time.

Parameters

dt	time to advance in seconds

AnimationState& MultiWidgets::Animation::animationState

(

const QString &

animationName

)

Get the animation state of an animation.

Parameters

animationName

name of the animation

Returns

state of the requested animation

const AnimationState& MultiWidgets::Animation::animationState

(

const QString &

animationName

)

const

Get the animation state of an animation.

Parameters

animationName

name of the animation

Returns

state of the requested animation

int MultiWidgets::Animation::clipCount

(

)

const

Get the number of animation clips.

Returns

number of animation clips

bool MultiWidgets::Animation::hasClip

(

const QString &

animationName

)

const

Check if the animation controller contains the given clip.

Parameters

animationName

name fo the animation clip

Returns

true if the given animation already exists; otherwise false

bool MultiWidgets::Animation::isPlaying

(

const QString &

animationName

)

const

Check if the given animation is playing.

Parameters

animationName

name of the animation to check

Returns

true if the animation is playing; false if stopped or paused

void MultiWidgets::Animation::pause

(

const QString &

animationName

)

Pause the given animation Next time when playing the animation it will continue from the position it was paused.

Parameters

animationName

bool MultiWidgets::Animation::play	(	const QString &	animationName,
		StopFlag	stopFlag = DO_NOT_STOP
	)

Play the given animation.

Parameters

animationName	name of the animation to play
stopFlag	flag to indicate what to do with other currently running animations

Returns

true if the animation exists; otherwise false

void MultiWidgets::Animation::removeClip

(

const QString &

animationName

)

Remove the given animation clip.

Parameters

animationName

name of the animation to remove

void MultiWidgets::Animation::sample

(

)

Compute the interpolated animation values and apply them to the target node.

void MultiWidgets::Animation::stop

(

bool

stopPaused = true

)

Stop all animations.

Parameters

stopPaused

Are the paused animations stopped as well

void MultiWidgets::Animation::stop

(

const QString &

animationName

)

Stop the given animation.

Parameters

animationName

name of the animation to stop

virtual void MultiWidgets::Animation::update ( MultiWidgets::Widget &  w, const MultiWidgets::FrameInfo &  frameInfo  )

virtual

Perform animation logic.

This function gets called from when the widget is updated

Parameters

w	The widget that is the target of the operator
frameInfo	frame information

Reimplemented from MultiWidgets::Operator.