You.i Engine
CYIAnimation::Listener Class Reference

Detailed Description

Base class used to listen to one or more CYIAnimations as they update over time.

This class can be used to create an animation programatically. It listens to a CYIAnimation and recieves callbacks as the animation updates over time. Extend this class and implement OnAnimate to perform the animation over time.

See also
CYIAnimation

#include <animation/YiAnimation.h>

Inheritance diagram for CYIAnimation::Listener:

Public Member Functions

virtual ~Listener ()
 
virtual void OnAnimate (CYIAnimation *pAnim, float dataPosition)
 
virtual void OnAnimationBegin (CYIAnimation *pAnimation)
 
virtual void OnAnimationEnd (CYIAnimation *pAnimation)
 

Constructor & Destructor Documentation

◆ ~Listener()

virtual CYIAnimation::Listener::~Listener ( )
inlinevirtual

Member Function Documentation

◆ OnAnimate()

void CYIAnimation::Listener::OnAnimate ( CYIAnimation pAnim,
float  dataPosition 
)
inlinevirtual

Called each time the frame time for the animation pAnim is updated along with the current position of the animation dataPosition.

Reimplemented in CYIScrollController, CYISceneNode::PropertyAnimation, and CYISpriteSceneNode.

◆ OnAnimationBegin()

void CYIAnimation::Listener::OnAnimationBegin ( CYIAnimation pAnimation)
inlinevirtual

Called when the animation pAnimation begins to play.

See also
CYIAnimation::Start

Reimplemented in CYIScrollController, and CYISpriteSceneNode.

◆ OnAnimationEnd()

void CYIAnimation::Listener::OnAnimationEnd ( CYIAnimation pAnimation)
inlinevirtual

Called when the animation pAnimation ends.

See also
CYIAnimation::Terminate

Reimplemented in CYIScrollController, CYISceneNode::PropertyAnimation, and CYISpriteSceneNode.


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