Inheritance diagram for Osp::Ui::Animations::AnimationBase:

Since:: 2.0

The AnimationBase class defines the basic animation properties, such as the interpolator to be used, the duration of the animation in milliseconds, the delay before the animation is started in milliseconds, and the repeat count.

List of all members.

Public Member Functions
result	GetBezierControlPoints (float &time1, float &value1, float &time2, float &value2) const
long	GetDelay (void) const
long	GetDuration (void) const
AnimationInterpolatorType	GetInterpolatorType (void) const
int	GetKeyFrameCount (void) const
Osp::Base::String	GetName (void) const
long	GetOffset (void) const
long	GetRepeatCount (void) const
float	GetScaleRatio (void) const
virtual AnimationType	GetType (void) const =0
bool	IsAutoReverseEnabled (void) const
bool	IsHoldEndEnabled (void) const
void	SetAutoReverseEnabled (bool autoReverse)
result	SetBezierControlPoints (float time1, float value1, float time2, float value2)
result	SetDelay (long milliseconds)
result	SetDuration (long milliseconds)
void	SetHoldEndEnabled (bool holdEnd)
void	SetInterpolatorType (AnimationInterpolatorType interpolatorType)
void	SetName (const Osp::Base::String &name)
result	SetOffset (long milliseconds)
result	SetRepeatCount (long count)
result	SetScaleRatio (float scaleRatio)
virtual	~AnimationBase (void)

Constructor & Destructor Documentation

virtual Osp::Ui::Animations::AnimationBase::~AnimationBase ( void ) [virtual]

This is the destructor for this class.

Since:: 2.0

Member Function Documentation

result Osp::Ui::Animations::AnimationBase::GetBezierControlPoints	(	float &	time1,
		float &	value1,
		float &	time2,
		float &	value2
	)		const

Gets the control points of the Bezier interpolator.
This method is supported only if the interpolator is ANIMATION_INTERPOLATOR_BEZIER. 0 is returned for the other interpolators.

Since:: 2.0

Returns:: An error code

Parameters:

[out]	time1	The control point 1 - Time The default value of control point 1 is `0.0`.
[out]	value1	The control point 1 - Value The default value of control point 1 is `0.0`.
[out]	time2	The control point 2 - Time The default value of control point 2 is `0.0`.
[out]	value2	The control point 2 - Value The default value of control point 2 is `0.0`.

Exceptions:

E_SUCCESS	The method is successful.
E_INVALID_STATE	This instance has not been properly constructed as yet.
E_INVALID_OPERATION	This method is not supported for the interpolator set of this instance.

long Osp::Ui::Animations::AnimationBase::GetDelay ( void ) const

Gets the delay value in milliseconds before the animation starts.

Since:: 2.0

Returns:: The delay value in milliseconds
The default value of the delay is 0.

long Osp::Ui::Animations::AnimationBase::GetDuration ( void ) const

Gets the duration of the animation in milliseconds.

Since:: 2.0

Returns:: The duration value of the animation

AnimationInterpolatorType Osp::Ui::Animations::AnimationBase::GetInterpolatorType ( void ) const

Gets the interpolator type.

Since:: 2.0

Returns:: The interpolator type of an animation
The default interpolator type is ANIMATION_INTERPOLATOR_LINEAR.

int Osp::Ui::Animations::AnimationBase::GetKeyFrameCount ( void ) const

Gets the count of key frames added to this animation.

Since:: 2.0

Returns:: The key frame count

Osp::Base::String Osp::Ui::Animations::AnimationBase::GetName ( void ) const

Gets the name of the animation.

Since:: 2.0

Returns:: The name of the animation
The default value of the name is an empty string.

long Osp::Ui::Animations::AnimationBase::GetOffset ( void ) const

Gets the offset value in milliseconds after the animation starts.

Since:: 2.0

Returns:: The offset value of the animation in milliseconds
The default value of the offset is 0.

long Osp::Ui::Animations::AnimationBase::GetRepeatCount ( void ) const

Gets the repeat count value of the animation.

Since:: 2.0

Returns:: The repeat count value of the animation
The default value of the repeat count is 1.

float Osp::Ui::Animations::AnimationBase::GetScaleRatio ( void ) const

Gets the scale ratio value of the animation.

Since:: 2.0

Returns:: The scale ratio value of the animation
The default value of scale ratio is 1.0f

virtual AnimationType Osp::Ui::Animations::AnimationBase::GetType ( void ) const [pure virtual]

Gets the type information of this instance.

Since:: 2.0

Returns:: The type information of this instance

Implemented in Osp::Ui::Animations::DimensionAnimation, Osp::Ui::Animations::FloatAnimation, Osp::Ui::Animations::IntegerAnimation, Osp::Ui::Animations::PointAnimation, Osp::Ui::Animations::RectangleAnimation, and Osp::Ui::Animations::RotateAnimation.

bool Osp::Ui::Animations::AnimationBase::IsAutoReverseEnabled ( void ) const

Checks whether the auto reverse is enabled.

Since:: 2.0

Returns:: true if the auto reverse is enabled,
else false
The default auto reverse value is false.

bool Osp::Ui::Animations::AnimationBase::IsHoldEndEnabled ( void ) const

Checks whether the hold end value of the animation is enabled.

Since:: 2.0

Returns:: true if the hold end value is enabled,
else false
The default hold end value is true.

void Osp::Ui::Animations::AnimationBase::SetAutoReverseEnabled ( bool autoReverse )

Sets the AutoReverse property of the animation.
If enabled, the forward and backward animation can also be played.

Since:: 2.0

Parameters:

[in] autoReverse Set to true to enable the AutoReverse property of the animation,
else false

Remarks:: If autoReverseset is set to true, the duration of the animation is doubled. If the repeat count is more than 1,
autoReverse is applied to each iteration. Note that if autoReverse is set to true, one forward animation play and one backward animation play is one iteration.

result Osp::Ui::Animations::AnimationBase::SetBezierControlPoints	(	float	time1,
		float	value1,
		float	time2,
		float	value2
	)

Sets the control points for Bezier interpolator.
This method is supported only if the interpolator is ANIMATION_INTERPOLATOR_BEZIER.

Since:: 2.0

Returns:: An error code

Parameters:

[in]	time1	The control point 1 - Time The time should be in the range `0.0` to `1.0`. The time value is scaled relative to the duration of the animation.
[in]	value1	The control point 1 - Value The value should be in the range `0.0` to `1.0`. The value is scaled relative to the start and end value of the animation.
[in]	time2	The control point 2 - Time The time should be in the range `0.0` to `1.0`. The time value is scaled relative to the duration of the animation.
[in]	value2	The control point 2 - Value The time should be in the range `0.0` to `1.0`. The value is scaled relative to the start and end value of the animation.

Exceptions:

E_SUCCESS	The method is successful.
E_INVALID_STATE	This instance has not been properly constructed as yet.
E_INVALID_OPERATION	This method is not supported for the interpolator set of this instance.
E_INVALID_ARG	A specified input parameter is invalid.

Remarks:: time1 can be greater than time2 and vice versa.

result Osp::Ui::Animations::AnimationBase::SetDelay ( long milliseconds )

Sets the delay for the animation.
The animation starts after the duration of delay has passed.

Since:: 2.0

Returns:: An error code

Parameters:

[in] milliseconds The delay for the animation to start in milliseconds

Exceptions:

E_SUCCESS	The method is successful.
E_INVALID_ARG	The value of the specified parameter is negative.
E_INVALID_STATE	This instance has not been properly constructed.

Remarks:: This method does not alter the start, end, and duration values of the animation.

result Osp::Ui::Animations::AnimationBase::SetDuration ( long milliseconds )

Sets the duration of the animation.

Since:: 2.0

Returns:: An error code

Parameters:

[in] milliseconds The duration of the animation in milliseconds

Exceptions:

E_SUCCESS	The method is successful.
E_INVALID_ARG	The value of the specified parameter is negative.
E_INVALID_STATE	This instance has not been properly constructed.

void Osp::Ui::Animations::AnimationBase::SetHoldEndEnabled ( bool holdEnd )

Sets the hold end value of the animation.
This method retains the end values of an animation or goes to the start value of an animation.

Since:: 2.0

Parameters:

[in] holdEnd Set to true to hold the end values of the animation,
else false

void Osp::Ui::Animations::AnimationBase::SetInterpolatorType ( AnimationInterpolatorType interpolatorType )

Sets the interpolator type.

Since:: 2.0

Parameters:

[in] interpolatorType The interpolator type used for the animation

void Osp::Ui::Animations::AnimationBase::SetName ( const Osp::Base::String & name )

Sets the name of the animation.

Since:: 2.0

Parameters:

[in] name The name of the animation

result Osp::Ui::Animations::AnimationBase::SetOffset ( long milliseconds )

Sets the offset value of the animation.
Additionally, this method alters the start value and duration for which an animation is played.

Since:: 2.0

Returns:: An error code

Parameters:

[in] milliseconds The offset of the animation in milliseconds

Exceptions:

E_SUCCESS	The method is successful.
E_INVALID_ARG	The value of the specified parameter is negative or greater than the duration of the animation.
E_INVALID_STATE	This instance has not been properly constructed.

Remarks:: If the start value of the animation is 0.0, the end value is 1.0, the duration is 100 ms and the offset value is 20 ms, the actual animation starts at 0th ms and plays for 80 ms with a start value of 0.2.
If autoReverseset is set to true, the Backward animation plays for 100ms, from 1.0 to 0.0.

result Osp::Ui::Animations::AnimationBase::SetRepeatCount ( long count )

Sets the repeat count for the animation.
Repeats an animation for the specified number of times.

Since:: 2.0

Returns:: An error code

Parameters:

[in] count The number of times the animation has to be repeated

Exceptions:

E_SUCCESS	The method is successful.
E_INVALID_ARG	The value of the specified parameter is negative.
E_INVALID_STATE	This instance has not been properly constructed.

Remarks:: A delay and offset is applied to an animation only when the animation is played for the first time.

result Osp::Ui::Animations::AnimationBase::SetScaleRatio ( float scaleRatio )

Sets the scale ratio of the animation.
This method multiplies the duration, offset, and delay using the scale ratio.

Since:: 2.0

Returns:: An error code

Parameters:

[in] scaleRatio The scale ratio property of the animation

Exceptions:

E_SUCCESS	The method is successful.
E_INVALID_ARG	The value of the specified parameter is negative.
E_INVALID_STATE	This instance has not been properly constructed.

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

FUiAnimAnimationBase.h

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation