Tizen Native API  4.0
Public Member Functions | Static Public Member Functions
Dali::KeyFrames Class Reference
Animation

A set of key frames for a property that can be animated using Dali::Animation::AnimateBetween(). More...

Inheritance diagram for Dali::KeyFrames:
Dali::BaseHandle

Public Member Functions

 KeyFrames ()
 Creates an uninitialized KeyFrame handle.
 ~KeyFrames ()
 Destructor.
 KeyFrames (const KeyFrames &handle)
 This copy constructor is required for (smart) pointer semantics.
KeyFrames & operator= (const KeyFrames &rhs)
 This assignment operator is required for (smart) pointer semantics.
Property::Type GetType () const
 Gets the type of the key frame.
void Add (float progress, Property::Value value)
 Adds a key frame.
void Add (float progress, Property::Value value, AlphaFunction alpha)
 Adds a key frame.

Static Public Member Functions

static KeyFrames New ()
 Creates an initialized KeyFrames handle.
static KeyFrames DownCast (BaseHandle handle)
 Downcasts a handle to KeyFrames handle.

Detailed Description

A set of key frames for a property that can be animated using Dali::Animation::AnimateBetween().

This allows the generation of key frame objects from individual Property::Values. The type of the key frame is specified by the type of the first value to be added. Adding key frames with a different Property::Value type will result in a run time assert.

Since:
3.0, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::KeyFrames::KeyFrames ( )

Creates an uninitialized KeyFrame handle.

This can be initialized with KeyFrame::New(). Calling member functions with an uninitialized KeyFrames handle is not allowed.

Since:
3.0, DALi version 1.0.0
Dali::KeyFrames::~KeyFrames ( )

Destructor.

This is non-virtual since derived Handle types must not contain data or virtual methods.

Since:
3.0, DALi version 1.0.0
Dali::KeyFrames::KeyFrames ( const KeyFrames &  handle)

This copy constructor is required for (smart) pointer semantics.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]handleA reference to the copied handle

Member Function Documentation

void Dali::KeyFrames::Add ( float  progress,
Property::Value  value 
)

Adds a key frame.

The key frames should be added in time order.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]progressA progress value between 0.0 and 1.0
[in]valueA value
void Dali::KeyFrames::Add ( float  progress,
Property::Value  value,
AlphaFunction  alpha 
)

Adds a key frame.

The key frames should be added in time order.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]progressA progress value between 0.0 and 1.0
[in]valueA value
[in]alphaThe alpha function used to blend to the next keyframe
static KeyFrames Dali::KeyFrames::DownCast ( BaseHandle  handle) [static]

Downcasts a handle to KeyFrames handle.

If handle points to a KeyFrames object, the downcast produces valid handle. If not, the returned handle is left uninitialized.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]handleHandle to an object
Returns:
Handle to a KeyFrames object or an uninitialized handle
Property::Type Dali::KeyFrames::GetType ( ) const

Gets the type of the key frame.

If no key frames have been added, this returns Property::NONE.

Since:
3.0, DALi version 1.0.0
Returns:
The key frame property type
static KeyFrames Dali::KeyFrames::New ( ) [static]

Creates an initialized KeyFrames handle.

Since:
3.0, DALi version 1.0.0
Returns:
A handle to a newly allocated Dali resource
KeyFrames& Dali::KeyFrames::operator= ( const KeyFrames &  rhs)

This assignment operator is required for (smart) pointer semantics.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]rhsA reference to the copied handle
Returns:
A reference to this