Guiliani  Version 2.4 revision 5970 (build 3)
CGUIAnimatable Class Reference

Base interface for animation callbacks. More...

#include <GUIAnimatable.h>

Inheritance diagram for CGUIAnimatable:

Public Member Functions

virtual ~CGUIAnimatable ()
 Destructor. Removes all existing animation callbacks.
 
virtual void DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
 
virtual eC_Bool IsAnimating () const
 
virtual void StartAnimation ()
 
virtual void StopAnimation ()
 

Detailed Description

Base interface for animation callbacks.

When registering a timer callback for an animatable by calling CGUITimer::AddAnimationCallback the GUITimer uses this interface when the callback time expires.

Typically, the implementation of CGUIAnimation adds the animation callback when starting the animation.

Member Function Documentation

◆ DoAnimate()

virtual void CGUIAnimatable::DoAnimate ( const eC_Value &  vTimes = eC_FromInt(1))
inlinevirtual

Called when the timer of an animation callback belonging to this animatable has expired.

Parameters
vTimesThe factor of the registered callback time in relation to the actually elapsed time. For example, the elapsed time is 80ms, and the standard time is 50ms, then vTimes is 1.6. If the given time in GETTIMER.AddAnimationCallback is 0, It will be set to -1.

Reimplemented in CGUIDialogManager::PopupDescription, CGUIMultiLineEdit, CGUIEdit, CGUITouchScrollView, CGUIAbstractBar, CGUIProgressBar, CGUIScrollView, CGUIWheel, CGUIExpandingComposite, CGUIClock, CGUIAnimationChain, CGUIGauge, CGUIBlendButton, CGUIImageStack, CGUIScrollBar, CGUIVideo, CGUICarousel, CGUIAnimatedImage, CGUIScrollingText, CGUIFramerate, CGUIPageContainer, CGUICenterFocusContainer, CGUIWheelContainer, CGUIAnimation, CGUITransitionBase, CGUIMouseCursor, CGUIAutoRepeatBehaviour, CGUIPlot, and CGUIMemProfile.

◆ IsAnimating()

virtual eC_Bool CGUIAnimatable::IsAnimating ( ) const
inlinevirtual

Checks if the animatable is currently animating.

Returns
True if an animation callback is registered, otherwise False.

Reimplemented in CGUIAnimationChain.

◆ StartAnimation()

virtual void CGUIAnimatable::StartAnimation ( )
inlinevirtual

Start the animation. This function typically registers a timer callback. The base class just defines the interface and does nothing.

See also
CGUIAnimation

Reimplemented in CGUIAnimationChain, CGUIImageStack, CGUIAnimatedImage, and CGUIAnimation.

◆ StopAnimation()

virtual void CGUIAnimatable::StopAnimation ( )
inlinevirtual

Stop the animation. This function typically removes a timer callback. The base class just defines the interface and does nothing.

See also
CGUIAnimation

Reimplemented in CGUIAnimationChain, CGUIImageStack, CGUIAnimation, and CGUIAnimatedImage.


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