Dali 3D User Interface Engine
List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
Dali::Internal::AnimationPlaylist Class Reference

AnimationPlaylist provides notifications to applications when animations are finished. More...

#include <animation-playlist.h>

Inheritance diagram for Dali::Internal::AnimationPlaylist:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::AnimationPlaylist:
Collaboration graph
[legend]

Public Member Functions

virtual ~AnimationPlaylist ()
 Virtual destructor. More...
 
void AnimationCreated (Animation &animation)
 Called when an animation is constructed. More...
 
void AnimationDestroyed (Animation &animation)
 Called when an animation is destroyed. More...
 
void OnPlay (Animation &animation)
 Called when an animation is playing. More...
 
void OnClear (Animation &animation)
 Called when an animation is cleared. More...
 

Static Public Member Functions

static AnimationPlaylistNew ()
 Create an AnimationPlaylist. More...
 

Private Member Functions

 AnimationPlaylist ()
 Create an AnimationPlaylist. More...
 
 AnimationPlaylist (const AnimationPlaylist &)
 
AnimationPlaylistoperator= (const AnimationPlaylist &rhs)
 
virtual void NotifyCompleted ()
 This method is called by Notification Manager. More...
 

Private Attributes

Dali::Vector< Animation * > mAnimations
 All existing animations (not owned) More...
 
std::vector< Dali::AnimationmPlaylist
 The currently playing animations (owned through handle) More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dali::Internal::CompleteNotificationInterface
 CompleteNotificationInterface ()
 Constructor, not to be directly instantiated. More...
 
virtual ~CompleteNotificationInterface ()
 Virtual destructor as this is an interface, no deletion through this interface though. More...
 

Detailed Description

AnimationPlaylist provides notifications to applications when animations are finished.

It reference-counts playing animations, to allow "fire and forget" behaviour.

Definition at line 39 of file animation-playlist.h.

Constructor & Destructor Documentation

Dali::Internal::AnimationPlaylist::~AnimationPlaylist ( )
virtual

Virtual destructor.

Definition at line 43 of file animation-playlist.cpp.

Dali::Internal::AnimationPlaylist::AnimationPlaylist ( )
private

Create an AnimationPlaylist.

Definition at line 39 of file animation-playlist.cpp.

Referenced by New().

Here is the caller graph for this function:

Dali::Internal::AnimationPlaylist::AnimationPlaylist ( const AnimationPlaylist )
private

Member Function Documentation

void Dali::Internal::AnimationPlaylist::AnimationCreated ( Animation animation)

Called when an animation is constructed.

Definition at line 47 of file animation-playlist.cpp.

References mAnimations, and Dali::Vector< T, IsTrivialType >::PushBack().

Referenced by Dali::Internal::Animation::Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Internal::AnimationPlaylist::AnimationDestroyed ( Animation animation)

Called when an animation is destroyed.

Definition at line 52 of file animation-playlist.cpp.

References Dali::Vector< T, IsTrivialType >::Begin(), DALI_ASSERT_ALWAYS, Dali::Vector< T, IsTrivialType >::End(), mAnimations, and Dali::Vector< T, IsTrivialType >::Remove().

Referenced by Dali::Internal::Animation::~Animation().

Here is the call graph for this function:

Here is the caller graph for this function:

AnimationPlaylist * Dali::Internal::AnimationPlaylist::New ( )
static

Create an AnimationPlaylist.

Returns
A newly allocated animation playlist.

Definition at line 34 of file animation-playlist.cpp.

References AnimationPlaylist().

Here is the call graph for this function:

void Dali::Internal::AnimationPlaylist::NotifyCompleted ( )
privatevirtual
void Dali::Internal::AnimationPlaylist::OnClear ( Animation animation)

Called when an animation is cleared.

Postcondition
The animation will no longer be referenced by AnimationPlaylist.

Definition at line 65 of file animation-playlist.cpp.

References mPlaylist.

Referenced by Dali::Internal::Animation::Clear().

Here is the caller graph for this function:

void Dali::Internal::AnimationPlaylist::OnPlay ( Animation animation)

Called when an animation is playing.

Postcondition
The animation will be referenced by AnimationPlaylist, until the "Finished" signal is emitted.

Definition at line 60 of file animation-playlist.cpp.

References mPlaylist.

Referenced by Dali::Internal::Animation::Play(), and Dali::Internal::Animation::PlayFrom().

Here is the caller graph for this function:

AnimationPlaylist& Dali::Internal::AnimationPlaylist::operator= ( const AnimationPlaylist rhs)
private

Member Data Documentation

Dali::Vector< Animation* > Dali::Internal::AnimationPlaylist::mAnimations
private

All existing animations (not owned)

Definition at line 98 of file animation-playlist.h.

Referenced by AnimationCreated(), AnimationDestroyed(), and NotifyCompleted().

std::vector< Dali::Animation > Dali::Internal::AnimationPlaylist::mPlaylist
private

The currently playing animations (owned through handle)

Definition at line 99 of file animation-playlist.h.

Referenced by NotifyCompleted(), OnClear(), and OnPlay().


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali