ASPiK SDK
VSTGUI::Animation::Animator Class Reference

Animation runner. More...

#include <animator.h>

Inheritance diagram for VSTGUI::Animation::Animator:
VSTGUI::ReferenceCounted< T > VSTGUI::IReference

Public Member Functions

Adding and removing Animations
void addAnimation (CView *view, IdStringPtr name, IAnimationTarget *target, ITimingFunction *timingFunction, CBaseObject *notificationObject=nullptr)
 
void addAnimation (CView *view, IdStringPtr name, IAnimationTarget *target, ITimingFunction *timingFunction, DoneFunction notification)
 
void removeAnimation (CView *view, IdStringPtr name)
 
void removeAnimations (CView *view)
 
- Public Member Functions inherited from VSTGUI::ReferenceCounted< T >
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0
 
void remember () override
 increase refcount
 
virtual int32_t getNbReference () const
 get refcount
 
virtual void beforeDelete ()
 

Detailed Description

Animation runner.

Member Function Documentation

◆ addAnimation() [1/2]

void VSTGUI::Animation::Animator::addAnimation ( CView view,
IdStringPtr  name,
IAnimationTarget target,
ITimingFunction timingFunction,
CBaseObject notificationObject = nullptr 
)

adds an animation. Animation and timingFunction is now owned by the animator. An already running animation for view with name will be canceled. If a notificationObject is supplied, it will be notified when the animation has finished

See also
FinishedMessage.

◆ addAnimation() [2/2]

void VSTGUI::Animation::Animator::addAnimation ( CView view,
IdStringPtr  name,
IAnimationTarget target,
ITimingFunction timingFunction,
DoneFunction  notification 
)

adds an animation. Animation and timingFunction is now owned by the animator. An already running animation for view with name will be canceled. The notification function will be called when the animation has finished.

◆ removeAnimation()

void VSTGUI::Animation::Animator::removeAnimation ( CView view,
IdStringPtr  name 
)

removes an animation. If animation has the IReference interface forget() will be called otherwise it is deleted. The same will be done with the timingFunction.

◆ removeAnimations()

void VSTGUI::Animation::Animator::removeAnimations ( CView view)

removes all animations for view


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