Tizen Native API  5.5
Public Types | Public Member Functions
Dali::AlphaFunction Class Reference
Animation

Alpha functions are used in animations to specify the rate of change of the animation parameter over time. More...

Public Types

enum  BuiltinFunction
 Enumeration for built-in alpha functions. More...
enum  Mode
 Enumeration for all possible functioning modes for the alpha function. More...

Public Member Functions

 AlphaFunction ()
 Default constructor. Creates an alpha function object with the default built-in alpha function.
 AlphaFunction (BuiltinFunction function)
 Constructor. Creates an alpha function object with the built-in alpha function passed as a parameter to the constructor.
 AlphaFunction (AlphaFunctionPrototype function)
 Constructor. Creates an alpha function object using a pointer to an alpha function passed as a parameter to the constructor.
 AlphaFunction (const Dali::Vector2 &controlPoint0, const Dali::Vector2 &controlPoint1)
 Constructor.
Vector4 GetBezierControlPoints () const
 Returns the control points of the alpha function.
AlphaFunctionPrototype GetCustomFunction () const
 Returns the pointer to the custom function.
BuiltinFunction GetBuiltinFunction () const
 Returns the built-in function used by the alpha function.
Mode GetMode () const
 Returns the functioning mode of the alpha function.

Detailed Description

Alpha functions are used in animations to specify the rate of change of the animation parameter over time.

Understanding an animation as a parametric function over time, the alpha function is applied to the parameter of the animation before computing the final animation value.

Since:
3.0, DALi version 1.0.0

Member Enumeration Documentation

enum Dali::AlphaFunction::BuiltinFunction

Enumeration for built-in alpha functions.

Since:
3.0, DALi version 1.0.0
Enumerator:
DEFAULT 

Linear.

Since:
3.0, DALi version 1.0.0
LINEAR 

No transformation.

Since:
3.0, DALi version 1.0.0
REVERSE 

Reverse linear.

Since:
3.0, DALi version 1.0.0
EASE_IN_SQUARE 

Speeds up and comes to a sudden stop (Square)

Since:
3.0, DALi version 1.0.0
EASE_OUT_SQUARE 

Sudden start and slows to a gradual stop (Square)

Since:
3.0, DALi version 1.0.0
EASE_IN 

Speeds up and comes to a sudden stop (Cubic)

Since:
3.0, DALi version 1.0.0
EASE_OUT 

Sudden start and slows to a gradual stop (Cubic)

Since:
3.0, DALi version 1.0.0
EASE_IN_OUT 

Speeds up and slows to a gradual stop (Cubic)

Since:
3.0, DALi version 1.0.0
EASE_IN_SINE 

Speeds up and comes to a sudden stop (sinusoidal)

Since:
3.0, DALi version 1.0.0
EASE_OUT_SINE 

Sudden start and slows to a gradual stop (sinusoidal)

Since:
3.0, DALi version 1.0.0
EASE_IN_OUT_SINE 

Speeds up and slows to a gradual stop (sinusoidal)

Since:
3.0, DALi version 1.0.0
BOUNCE 

Sudden start, loses momentum and returns to start position.

Since:
3.0, DALi version 1.0.0
SIN 

Single revolution.

Since:
3.0, DALi version 1.0.0
EASE_OUT_BACK 

Sudden start, exceed end position and return to a gradual stop.

Since:
3.0, DALi version 1.0.0
enum Dali::AlphaFunction::Mode

Enumeration for all possible functioning modes for the alpha function.

Since:
3.0, DALi version 1.0.0
Enumerator:
BUILTIN_FUNCTION 

The user has specified a built-in function.

Since:
3.0, DALi version 1.0.0
CUSTOM_FUNCTION 

The user has provided a custom function.

Since:
3.0, DALi version 1.0.0
BEZIER 

The user has provided the control points of a bezier curve.

Since:
3.0, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::AlphaFunction::AlphaFunction ( )

Default constructor. Creates an alpha function object with the default built-in alpha function.

Since:
3.0, DALi version 1.0.0
Returns:
The alpha function
Dali::AlphaFunction::AlphaFunction ( BuiltinFunction  function)

Constructor. Creates an alpha function object with the built-in alpha function passed as a parameter to the constructor.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]functionOne of the built-in alpha functions
Returns:
The alpha function
Dali::AlphaFunction::AlphaFunction ( AlphaFunctionPrototype  function)

Constructor. Creates an alpha function object using a pointer to an alpha function passed as a parameter to the constructor.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]functionA pointer to an alpha function
Returns:
The alpha function
Dali::AlphaFunction::AlphaFunction ( const Dali::Vector2 &  controlPoint0,
const Dali::Vector2 &  controlPoint1 
)

Constructor.

Creates a bezier alpha function. The bezier will have the first point at (0,0) and the end point at (1,1).

Since:
3.0, DALi version 1.0.0
Parameters:
[in]controlPoint0A Vector2 which will be used as the first control point of the curve
[in]controlPoint1A Vector2 which will be used as the second control point of the curve
Returns:
The alpha function
Note:
The x components of the control points will be clamped to the range [0,1] to prevent non monotonic curves.

Member Function Documentation

Vector4 Dali::AlphaFunction::GetBezierControlPoints ( ) const

Returns the control points of the alpha function.

Since:
3.0, DALi version 1.0.0
Returns:
Vector4 containing the two control points of the curve (xy for the first point and zw for the second)
BuiltinFunction Dali::AlphaFunction::GetBuiltinFunction ( ) const

Returns the built-in function used by the alpha function.

Since:
3.0, DALi version 1.0.0
Returns:
One of the built-in alpha functions. In case no built-in function has been specified, it will return AlphaFunction::DEFAULT
AlphaFunctionPrototype Dali::AlphaFunction::GetCustomFunction ( ) const

Returns the pointer to the custom function.

Since:
3.0, DALi version 1.0.0
Returns:
A pointer to a custom alpha function, or 0 if not defined
Mode Dali::AlphaFunction::GetMode ( ) const

Returns the functioning mode of the alpha function.

Since:
3.0, DALi version 1.0.0
Returns:
The functioning mode of the alpha function