Guiliani  Version 2.6 revision 7293 (documentation build 12)
Public Member Functions | Protected Attributes | List of all members
CGUIAnimatedImage Class Reference
Controls

Displays an animated image in the GUI. More...

#include <GUIAnimatedImage.h>

Inheritance diagram for CGUIAnimatedImage:
Inheritance graph
[legend]

Public Member Functions

 CGUIAnimatedImage (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_Bool &bStretchBlit=true, const eC_UInt uiMs=100, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIAnimatedImage (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_Bool &bStretchBlit=true, const eC_UInt uiMs=100, const ObjectHandle_t &eID=NO_HANDLE)
 
virtual void DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
 
virtual eC_Bool DoDraw ()
 
eC_Bool GetAutoStart () const
 
eC_UInt GetFrameDelay () const
 
ImageResource_t GetImage (const eC_UInt &uiIndex) const
 
eC_UInt GetIndexOfVisibleImage () const
 
eC_UInt GetNumberOfImages () const
 
eC_Bool GetRepeat () const
 
eC_Bool GetToggle () const
 
virtual void ReadFromStream ()
 
void SetAnimationIndex (const eC_UInt &uiIndex)
 
void SetAutoStart (const eC_Bool &bAutoStart)
 
void SetFrameDelay (const eC_UInt &uiMs)
 
void SetImages (eC_TArray< ImageResource_t > &aImages)
 
void SetRepeat (const eC_Bool &bRepeat)
 
void SetToggle (const eC_Bool &bToggle)
 
virtual eC_Bool SetValue (const CGUIValue &rkValue)
 
void StartAnimation ()
 Starts the animation. More...
 
void StopAnimation ()
 Immediately stops the animation. More...
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIImage
 CGUIImage ()
 
 CGUIImage (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ImageResource_t &eImageID, const eC_Bool &bStretchBlit=true, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIImage (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ImageResource_t &eImageID, const eC_Bool &bStretchBlit=true, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIImage (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const ImageResource_t &eImageID, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIImage (const CGUIImage &kSource)
 
virtual eC_Bool DoDraw ()
 
BlitType_t GetBlitType () const
 
ImageResource_t GetImageID () const
 
CGUINinePatch & GetNinePatch ()
 
eC_Bool GetStretchBlit () const
 
virtual eC_Bool IsHighlightable () const
 
CGUIImage & operator= (const CGUIImage &kSource)
 
virtual void ReadFromStream ()
 
void SetBlitType (const BlitType_t &eBlitType)
 
void SetImage (const ImageResource_t &eImage, const eC_Bool &bFitToImage=false)
 
void SetStretchBlit (eC_Bool bStretchBlit)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIObject
 CGUIObject ()
 
 CGUIObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (const CGUIObject &kSource)
 
virtual ~CGUIObject ()
 
void AddValueObserver (CGUIObserver *pkObserver)
 
eC_Bool CalculateInvalidatedRect (CGUIRect &rRect) const
 
virtual eC_Bool ClaimFocus ()
 
virtual void CreateSnapshot (eC_UInt uiBackColor=0x00)
 
eC_Bool DataPoolConnectorExists () const
 
void DeleteSnapshot ()
 
virtual void DisableSnapshotDrawing (eC_Bool bDeleteSnapshot=true)
 
virtual eC_Bool DoDraw ()
 
virtual eC_Bool DoDrawSnapshot ()
 
virtual void EnableSnapshotDrawing ()
 
virtual CGUIObject * FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool FocusAny ()
 
virtual eC_Bool FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
 
virtual eC_Bool FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
 
CGUIRect GetAbsRect () const
 
eC_Value GetAbsXPos () const
 
eC_Value GetAbsXPosCenter () const
 
eC_Value GetAbsXPosREdge () const
 
eC_Value GetAbsYPos () const
 
eC_Value GetAbsYPosBEdge () const
 
eC_Value GetAbsYPosCenter () const
 
eC_UByte GetAlpha () const
 
CGUIBehaviourDecorator * GetBehaviour ()
 
const CGUIBehaviourDecorator * GetBehaviour () const
 
GUIBitmapPlaneID_t GetBitmapID () const
 
CGUIBitmapPlane & GetBitmapPlane () const
 
CGUIRect GetCurrentAbsRect () const
 
eC_Value GetCurrentAbsXPos () const
 
eC_Value GetCurrentAbsXPosCenter () const
 
eC_Value GetCurrentAbsXPosREdge () const
 
eC_Value GetCurrentAbsYPos () const
 
eC_Value GetCurrentAbsYPosBEdge () const
 
eC_Value GetCurrentAbsYPosCenter () const
 
CDataPoolConnector & GetDataPoolConnector ()
 
eC_Value GetDistanceBottom () const
 
eC_Value GetDistanceRight () const
 
eC_Value GetHalfHeight () const
 
eC_Value GetHalfWidth () const
 
eC_Value GetHeight () const
 
ObjectHandle_t GetID () const
 
CGUILayouter * GetLayouter ()
 
const CGUILayouter * GetLayouter () const
 
ObjectHandle_t GetNeighborBottomID () const
 
ObjectHandle_t GetNeighborLeftID () const
 
ObjectHandle_t GetNeighborRightID () const
 
ObjectHandle_t GetNeighborTopID () const
 
CGUIObject * GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)
 
const CGUIObject * GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const
 
CGUIRect GetOriginRect () const
 
CGUICompositeObject * GetParent ()
 
const CGUICompositeObject * GetParent () const
 
CGUIRect GetRelRect () const
 
eC_Value GetRelXPos () const
 
eC_Value GetRelXPosCenter () const
 
eC_Value GetRelXPosREdge () const
 
eC_Value GetRelYPos () const
 
eC_Value GetRelYPosBEdge () const
 
eC_Value GetRelYPosCenter () const
 
UUID_t GetUUID () const
 
eC_Value GetWidth () const
 
void InvalidateArea ()
 
eC_Bool IsClickable () const
 
eC_Bool IsClickThrough () const
 
virtual eC_Bool IsCompositeObject () const
 
eC_Bool IsDescendantOf (const CGUIObject *const pAncestor) const
 
eC_Bool IsDisabled () const
 
eC_Bool IsDragable () const
 
eC_Bool IsDragged () const
 
eC_Bool IsDrawingSnapshot () const
 
eC_Bool IsFocussable () const
 
eC_Bool IsFocussed () const
 
eC_Bool IsGrayedOut () const
 
virtual eC_Bool IsHighlightable () const
 
eC_Bool IsHighlighted () const
 
eC_Bool IsInvisible () const
 
eC_Bool IsPressed () const
 
eC_Bool IsStopFocus () const
 
void NotifyValueObservers (const CGUIValue &kValue, const eC_UInt uiX=0, const eC_UInt uiY=0)
 
CGUIObject & operator= (const CGUIObject &kSource)
 
virtual void ReadFromStream ()
 
virtual void RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
 
void RemoveValueObserver (CGUIObserver *pkObserver)
 
void RenderToBitmap (eC_UInt uiBitmapID, eC_Value vXOffset=eC_FromInt(0), eC_Value vYOffset=eC_FromInt(0))
 
eC_Bool RequestFocus ()
 
void SetAlpha (eC_UByte ubAlpha)
 
void SetBehaviour (CGUIBehaviourDecorator *pkBehaviour)
 
void SetClickThrough (const eC_Bool &bClickThrough)
 
virtual void SetDisabled (const eC_Bool &bDisabled)
 
virtual void SetFocussable (const eC_Bool &bFocussable)
 
virtual void SetGrayedOut (const eC_Bool &bGrayOut)
 
virtual void SetHeight (const eC_Value &vY)
 
void SetID (const ObjectHandle_t &eID)
 
virtual void SetInvisible (const eC_Bool &bInvisible)
 
void SetLayouter (CGUILayouter *pLayouter)
 
void SetNeighborBottomID (const ObjectHandle_t eNewNeighborBottomID)
 
void SetNeighborIDs (const ObjectHandle_t eNewNeighborLeftID, const ObjectHandle_t eNewNeighborRightID, const ObjectHandle_t eNewNeighborTopID, const ObjectHandle_t eNewNeighborBottomID)
 
void SetNeighborLeftID (const ObjectHandle_t eNewNeighborLeftID)
 
void SetNeighborRightID (const ObjectHandle_t eNewNeighborRightID)
 
void SetNeighborTopID (const ObjectHandle_t eNewNeighborTopID)
 
virtual void SetParent (CGUICompositeObject *const pkParent)
 
void SetRelRect (const CGUIRect &kNewRect)
 
virtual void SetRelXPos (const eC_Value &vX)
 
void SetRelXPosCenter (const eC_Value &vXCenter)
 
void SetRelXPosREdge (const eC_Value &vX)
 
virtual void SetRelYPos (const eC_Value &vY)
 
void SetRelYPosBEdge (const eC_Value &vY)
 
void SetRelYPosCenter (const eC_Value &vYCenter)
 
void SetStopFocus (const eC_Bool &bDontFocusToParent)
 
void SetUUID (const UUID_t &kUUID)
 
virtual eC_Bool SetValue (CDataPoolEntry &rkValue)
 
virtual eC_Bool SetValue (const CGUIValue &rkValue)
 
virtual void SetWidth (const eC_Value &vX)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIBehaviour
virtual eC_Bool DoScale (const eC_Value &vDelta)
 
virtual eC_Bool DoUserEvent (CGUIEvent *const pEvent)
 
virtual void OnCreate ()
 
virtual void OnDataPool (const DataPoolResource_t &eID)
 
virtual void OnDelete ()
 
virtual void OnHide ()
 
virtual void OnShow ()
 
virtual eC_Bool DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoLongClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDoubleClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoButtonDown (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoButtonUp (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDrag (const eC_Value &vDeltaX=eC_FromInt(-1), const eC_Value &vDeltaY=eC_FromInt(-1), const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDragEnd (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseEnter (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseLeave (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual void GetFocus ()
 
virtual void LoseFocus ()
 
virtual eC_Bool Decrease ()
 
virtual eC_Bool Increase ()
 
virtual eC_Bool DoKeyDown (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoKeyUp (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoScroll (const eC_Value &vAbsX, const eC_Value &vAbsY, const eC_Value &vDelta, const eC_Bool &bModifierActive)
 
- Public Member Functions inherited from CGUIStreamableObject
const eC_String & GetXMLTag () const
 
virtual void ReadFromStream ()
 
void SetXMLTag (const eC_String &kXMLTag)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIAnimatable
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 ()
 

Protected Attributes

eC_TArray< ImageResource_t > m_aImageIDs
 Array of image ids within animation.
 
eC_Bool m_bAutoStart
 boolean value for automatically starting the animation
 
eC_Bool m_bForward
 indicate if animation is running forward
 
eC_Bool m_bRepeat
 boolean value indicating whether this object is currently animating
 
eC_Bool m_bToggle
 toggle direction when reaching end of list in loop-mode
 
eC_UInt m_uiFrameDelay
 Time in milliseconds how long a single image of the animation will be displayed.
 
eC_UInt m_uiVisibleImageIndex
 Index of currently displayed image in array of images.
 
- Protected Attributes inherited from CGUIObject
UUID_t m_kUUID
 UUID of object.
 

Additional Inherited Members

- Public Types inherited from CGUIImage
enum  BlitType_t { IBT_CENTER , IBT_STRETCH , IBT_TILED }
 enum for blitting-type More...
 
- Public Types inherited from CGUIObject
enum  FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }
 
- Static Public Member Functions inherited from CGUIStreamableObject
static UUID_t GenerateUUID ()
 
- Static Public Attributes inherited from CGUIObject
static const eC_Char XMLTAG_ALPHA []
 XML tag to be used writing alpha-value into a stream.
 
static const eC_Char XMLTAG_CLICKTHROUGH []
 XML tag to be used writing clickthrough-state into a stream.
 
static const eC_Char XMLTAG_CONTROLCLASSID []
 XML tag to be used when writing a control class ID into a stream.
 
static const eC_Char XMLTAG_DISABLED []
 XML tag to be used writing disabled-state into a stream.
 
static const eC_Char XMLTAG_FOCUSSABLE []
 XML tag to be used writing focussable-state into a stream.
 
static const eC_Char XMLTAG_GRAYEDOUT []
 XML tag to be used writing grayedout-state into a stream.
 
static const eC_Char XMLTAG_HEIGHT []
 XML tag to be used writing height into a stream.
 
static const eC_Char XMLTAG_INVISIBLE []
 XML tag to be used writing invisible-state into a stream.
 
static const eC_Char XMLTAG_OBJECTID []
 XML tag to be used writing object id into a stream.
 
static const eC_Char XMLTAG_OVERRIDDENNEIGHBORS []
 XML tag to be used writing overridden neighbors into a stream.
 
static const eC_Char XMLTAG_UUID []
 XML tag to be used when writing a UUID into a stream.
 
static const eC_Char XMLTAG_WIDTH []
 XML tag to be used writing width into a stream.
 
static const eC_Char XMLTAG_XPOS []
 XML tag to be used writing x-position into a stream.
 
static const eC_Char XMLTAG_YPOS []
 XML tag to be used writing y-position into a stream.
 
- Static Public Attributes inherited from CGUIBehaviour
static const eC_Char XMLTAG_BEHAVIOURCLASSID []
 XML tag to be used when writing a behaviour class ID into a stream.
 
static const eC_Char XMLTAG_BEHAVIOURCOUNT []
 XML tag for count.
 
- Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char XMLTAG_CLASSVERSION []
 
- Protected Member Functions inherited from CGUIObject
virtual eC_Bool CreateBitmapPlane ()
 
virtual eC_Bool FourWayNext (FourWayFocus_t eFocusDirection)
 
- Protected Member Functions inherited from CGUIStreamableObject
eC_UInt ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const
 
void WriteStreamingFooter (const eC_Bool &bWriteClassID) const
 
void WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const
 

Detailed Description

Displays an animated image in the GUI.

The "animated image" control displays an image, which is animated in a flip-book manner. It supports an arbitrary number of images and a free settable animation time. The "animated image" control can be used e.g., for simple animations based on a collection of single images (Class: CGUIAnimatedImage).

This control displays an image which is animated in a flip-book manner. You can add an arbitrary number of images to the animation, choose the speed of animation and whether the animation should loop endlessly or stop after one animation cycle.

Example:

// Create animated image
CGUIAnimatedImage* pImage = new CGUIAnimatedImage(
this,
eC_FromInt(10), eC_FromInt(10),
eC_FromInt(100), eC_FromInt(50)),
false, 80, OBJ_ANIMATED_EXAMPLE_IMAGE);
// Fill array of images
eC_TArray<ImageResource_t> aImages;
aImages6.AddElement(IMG_LOGO1);
aImages6.AddElement(IMG_LOGO2);
aImages6.AddElement(IMG_LOGO3);
aImages6.AddElement(IMG_LOGO4);
aImages6.AddElement(IMG_LOGO5);
// Set images
pImage->SetImages(aImages);
// Do not loop animation
pImage->SetRepeat(false);
CGUIAnimatedImage
Displays an animated image in the GUI.
Definition: GUIAnimatedImage.h:59
CGUIAnimatedImage::SetRepeat
void SetRepeat(const eC_Bool &bRepeat)
CGUIAnimatedImage::SetImages
void SetImages(eC_TArray< ImageResource_t > &aImages)

Constructor & Destructor Documentation

◆ CGUIAnimatedImage() [1/2]

CGUIAnimatedImage::CGUIAnimatedImage ( CGUICompositeObject *const  pkParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const eC_Bool &  bStretchBlit = true,
const eC_UInt  uiMs = 100,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructs a CGUIAnimatedImage object. Note that if the given width and height do not match the actual size of the image it will be stretched when drawing it, resulting in a potential performance loss.

Parameters
pkParentPointer to the parent object of this image.
vXThe x coordinate of the upper left corner of this image.
vYThe y coordinate of the upper left corner of this image.
vWidthThe width of this image.
vHeightThe height of this image.
bStretchBlitIf true image will be stretched to the size of the object, if false image will be centered.
uiMsTime in milliseconds before displaying the next image.
eIDObject Identifier of this object

◆ CGUIAnimatedImage() [2/2]

CGUIAnimatedImage::CGUIAnimatedImage ( CGUICompositeObject *const  pkParent,
const CGUIRect &  kRect,
const eC_Bool &  bStretchBlit = true,
const eC_UInt  uiMs = 100,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructs a CGUIAnimatedImage object. Note that if the given width and height do not match the actual size of the image it will be stretched when drawing it, resulting in a potential performance loss.

Parameters
pkParentPointer to the parent object of this image.
kRectBoundary rectangle of the animated image, relative to parent.
bStretchBlitIf true image will be stretched to the size of the object, if false image will be centered.
uiMsTime in milliseconds before displaying the next image.
eIDObject Identifier of this object

Member Function Documentation

◆ DoAnimate()

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

Animation implementation which cycles through all images within this instance of CGUIAnaimatedImage.

Parameters
vTimesnumber of cycles since last execution

Reimplemented from CGUIAnimatable.

◆ DoDraw()

virtual eC_Bool CGUIAnimatedImage::DoDraw ( )
virtual

Visualizes the object. It is forbidden to call SetRelXPos, SetRelYPos, SetWidth or SetHeight in DoDraw, i.e., it is not allowed to change the layout.

Returns
True if anything was drawn, False otherwise

Reimplemented from CGUIImage.

◆ GetAutoStart()

eC_Bool CGUIAnimatedImage::GetAutoStart ( ) const

Get the autostart-flag

Returns
True if autostart is active

◆ GetFrameDelay()

eC_UInt CGUIAnimatedImage::GetFrameDelay ( ) const

Returns the current frame delay.

Returns
The time in milliseconds between individual images.
See also
SetFrameDelay

◆ GetImage()

ImageResource_t CGUIAnimatedImage::GetImage ( const eC_UInt &  uiIndex) const

Returns the image stored at the given index of the array or DUMMY_IMAGE if index is out of range.

Parameters
uiIndexImage at position to return.
Returns
image stored at the given index of the array or DUMMY_IMAGE if index is out of range.

◆ GetIndexOfVisibleImage()

eC_UInt CGUIAnimatedImage::GetIndexOfVisibleImage ( ) const

Returns the index of the currently visible image within the array of images. See SetImages().

Returns
Index of the currently visible image

◆ GetNumberOfImages()

eC_UInt CGUIAnimatedImage::GetNumberOfImages ( ) const

Returns the number of images currently loaded to determine the framedelay when having a constant cycle-time.

Returns
Number of currently used images

◆ GetRepeat()

eC_Bool CGUIAnimatedImage::GetRepeat ( ) const

Return whether repeat is active

Returns
True if repeat is active

◆ GetToggle()

eC_Bool CGUIAnimatedImage::GetToggle ( ) const

Get if animation toggles direction at the end

Returns
True if toggle is active

◆ ReadFromStream()

virtual void CGUIAnimatedImage::ReadFromStream ( )
virtual

Reads all object attributes from streaming file. Only for use with GUIFactory. GUIStreamingFileReader has to be set in CGUI::Init().

See also
CGUIFactory

Reimplemented from CGUIImage.

◆ SetAnimationIndex()

void CGUIAnimatedImage::SetAnimationIndex ( const eC_UInt &  uiIndex)

Forces the animation to continue with the image at the given index. The index refers to the position of the image in the array which was handed over during the call to SetImages(). Illegal index values will be clipped by a modulo operation to the range of the array.

Parameters
uiIndexIndex of image within the array of images for animation

◆ SetAutoStart()

void CGUIAnimatedImage::SetAutoStart ( const eC_Bool &  bAutoStart)

Set the autostart-flag

Parameters
bAutoStartTrue for autostart

◆ SetFrameDelay()

void CGUIAnimatedImage::SetFrameDelay ( const eC_UInt &  uiMs)

Sets the time in milliseconds before displaying the next image of the animation, thus defining the animation speed.

Parameters
uiMsTime in milliseconds before displaying the next image. (Supplying 0 will halt the animation)

◆ SetImages()

void CGUIAnimatedImage::SetImages ( eC_TArray< ImageResource_t > &  aImages)

Sets the images which will be displayed while animating this control. You can supply any number of images, which will then be shown in a flip-book manner at a configurable speed (

See also
SetFrameDelay). The images will be displayed in the order in which they are present within the array that is being handed over to SetImages. Any formerly set images will be overwritten.
Parameters
aImagesArray of ImageResource identifiers of images.

◆ SetRepeat()

void CGUIAnimatedImage::SetRepeat ( const eC_Bool &  bRepeat)

This enables/disables automatic looping of the animation. Setting "repeat" to true will cause the animation to restart from the first image once the last image has been shown. Setting "repeat" to false will stop the animation once the last image has been shown.

Parameters
bRepeatTurn automatic looping of the animation on/off.

◆ SetToggle()

void CGUIAnimatedImage::SetToggle ( const eC_Bool &  bToggle)

Specify if animation should toggle direction at the end

Parameters
bToggletoggle direction

◆ SetValue()

virtual eC_Bool CGUIAnimatedImage::SetValue ( const CGUIValue &  rkValue)
inlinevirtual

Sets the animation index to the given value.

See also
SetAnimationIndex()
Parameters
rkValueThe CGUIValue containing the new value
Returns
Always True.

Reimplemented from CGUIObject.

◆ StartAnimation()

void CGUIAnimatedImage::StartAnimation ( )
virtual

Starts the animation.

Reimplemented from CGUIAnimatable.

◆ StopAnimation()

void CGUIAnimatedImage::StopAnimation ( )
virtual

Immediately stops the animation.

Reimplemented from CGUIAnimatable.

◆ WriteToStream()

virtual void CGUIAnimatedImage::WriteToStream ( const eC_Bool  bWriteClassID = false)
virtual

Writes all object attributes to the streaming file. StreamWriter has to be initialized. Only for use with GUIStreamWriter.

Parameters
bWriteClassIDThis flag is used to select if writing of ControlID, leading and trailing tags is performed. Only GUIStreamWriter and GUICompositeObject have to set this flag true.
See also
CGUIStreamWriter

Reimplemented from CGUIImage.

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