Displays a wheel in the GUI. More...
#include <GUIWheel.h>
Classes | |
struct | NodeInfo |
Contains information about one node. More... | |
Public Types | |
typedef eC_TListDoubleLinked< NodeInfo > | NodeList |
Type used for the nodes. | |
![]() | |
enum | FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN } |
Public Member Functions | |
CGUIWheel () | |
Default constructor. | |
CGUIWheel (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) | |
CGUIWheel (const CGUIWheel &kToBeCopied) | |
virtual void | AdaptWheel () |
virtual void | AddEntry (const eC_String &kEntry, eC_Bool bSort=false) |
void | DeInit () |
virtual void | DeleteAllEntries () |
virtual void | DeleteEntry (const eC_String &kEntry) |
virtual void | DoAnimate (const eC_Value &vTimes=eC_FromInt(1)) |
virtual eC_Bool | DoButtonDown (const eC_Value &vAbsX, const eC_Value &vAbsY) |
virtual eC_Bool | DoClick (const eC_Value &vAbsX, const eC_Value &vAbsY) |
virtual eC_Bool | DoDrag (const eC_Value &vDeltaX, const eC_Value &vDeltaY, const eC_Value &vAbsX, const eC_Value &vAbsY) |
virtual eC_Bool | DoDragEnd (const eC_Value &vAbsX, const eC_Value &vAbsY) |
virtual eC_Bool | DoDraw () |
eC_Bool | GetAnimatedUpdate () const |
virtual eC_UInt | GetCurrentIndex () |
virtual const eC_String & | GetCurrentValue () |
CGUICommonEnums::Orientation_t | GetDirection () const |
eC_UInt | GetEntriesColor () const |
FontResource_t | GetEntriesFont () const |
eC_UInt | GetFocussedEntryColor () const |
FontResource_t | GetFocussedEntryFont () const |
eC_Int | GetMaxValue () |
eC_Int | GetMinValue () |
CGUINinePatch & | GetNinePatch () |
eC_UInt | GetNumberOfEntries () |
eC_Int | GetStepSize () const |
void | Init () |
eC_Bool | IsCyclic () const |
virtual eC_Bool | IsHighlightable () const |
eC_Bool | IsUsingRange () const |
virtual void | NormalizeEntry (eC_String &kEntry) |
virtual void | OnColorPropertyChange () |
CGUIWheel & | operator= (const CGUIWheel &kSource) |
virtual void | ReadFromStream () |
virtual void | ScrollTo (const eC_String &kNodeText) |
virtual void | ScrollTo (eC_UInt uiNodeIndex) |
virtual void | ScrollToAnimated (const eC_String &kNodeText) |
virtual void | ScrollToAnimated (eC_UInt uiNodeIndex) |
virtual eC_Int | SearchEntry (const eC_String &kNodeText) |
void | SetAnimatedUpdate (const eC_Bool &bAnimatedUpdate) |
void | SetCyclic (eC_Bool bCyclic) |
void | SetDirection (CGUICommonEnums::Orientation_t eDirection) |
void | SetEntriesColor (const eC_UInt &uiEntriesColor) |
void | SetEntriesColor (const GlobalProperty_t &eEntriesColor) |
void | SetEntriesFont (const FontResource_t &eFontID) |
void | SetFocussedEntryColor (const eC_UInt &uiFocussedEntryColor) |
void | SetFocussedEntryColor (const GlobalProperty_t &eFocussedEntryColor) |
void | SetFocussedEntryFont (const FontResource_t &eFontID) |
virtual void | SetHeight (const eC_Value &vHeight) |
void | SetMaxValue (eC_Int iMaxValue) |
void | SetMinValue (eC_Int iMinValue) |
void | SetPostfixString (const eC_String &kPostfixString) |
void | SetStepSize (eC_Int iStepSize) |
void | SetUseRange (eC_Bool bUseRange) |
virtual eC_Bool | SetValue (const CGUIValue &rkValue) |
virtual void | SetWidth (const eC_Value &vWidth) |
virtual void | WriteToStream (const eC_Bool bWriteClassID=false) |
![]() | |
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) |
![]() | |
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 | 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 | DoButtonUp (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) |
![]() | |
const eC_String & | GetXMLTag () const |
virtual void | ReadFromStream () |
void | SetXMLTag (const eC_String &kXMLTag) |
virtual void | WriteToStream (const eC_Bool bWriteClassID=false) |
![]() | |
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 () |
![]() | |
CGUIColorPropertyObserver () | |
default-constructor | |
~CGUIColorPropertyObserver () | |
destructor | |
eC_UInt | AddColorProperty (const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty) |
void | AddColorProperty (const eC_UInt &uiIndex, const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty) |
ColorValue_t | GetColorProperty (const eC_UInt &uiIndex) const |
eC_UInt | GetColorValue (const eC_UInt &uiIndex) const |
virtual void | OnColorPropertyChange () |
virtual void | OnNotification () |
Called by CGUISubject whenever an observed object triggers an update. More... | |
void | RemoveColorProperty (const eC_UInt &uiIndex) |
void | SetColorProperty (const eC_UInt &uiIndex, const ColorValue_t &kColorValue) |
void | SetColorProperty (const eC_UInt &uiIndex, const eC_UInt &uiColorValue) |
void | SetColorProperty (const eC_UInt &uiIndex, const GlobalProperty_t &eColorProperty) |
![]() | |
CGUIObserver () | |
Default constructor. | |
virtual | ~CGUIObserver () |
Default destructor. Notifies all subjects of destruction. | |
const eC_TListDoubleLinked< CGUISubject * > & | GetSubjectList () const |
virtual void | OnNotification () |
Called by CGUISubject whenever an observed object triggers an update. More... | |
virtual void | OnNotification (const CGUIObject *const pkUpdatedObject) |
virtual void | OnNotification (const CGUIValue &kObservedValue, const CGUIObject *const pkUpdatedObject, const eC_UInt uiX=0, const eC_UInt uiY=0) |
virtual void | OnNotification (const eC_String &kMessage) |
void | SetAutoDelete (const eC_Bool bAutoDelete) |
Protected Member Functions | |
virtual void | AdjustCurrentScrollPosAndNode (eC_Value vDragDelta) |
virtual void | AdjustNodesRelativePositions () |
virtual void | AdjustNodesRelativePositionsCyclic () |
virtual void | AdjustNodesRelativePositionsNotCyclic () |
virtual void | AdjustSize () |
virtual void | CreateNodesFromRange () |
virtual eC_UInt | GetCurrentNode () |
virtual NodeList::SafeIterator | GetCurrentNodeSafeIter () |
virtual eC_Value | GetCurrentScrollPosForCurrentDirection () |
virtual eC_Value | GetDefaultNodeSizeCurrentDirection () |
virtual NodeList::Iterator | GetNextNodeCyclic (NodeList::Iterator kIter) |
virtual eC_UInt | GetNodeIndexFromIter (const NodeList::Iterator &kNodeIter) |
virtual void | GetNodeIndexInRelPos (eC_Value vOffset, eC_Int &iIndex, eC_Int &iCycle, eC_Value &vScrollPos) |
NodeList & | GetNodes () |
virtual NodeList::Iterator | GetPreviousNodeCyclic (NodeList::Iterator kIter) |
virtual eC_Value | IndexCycleOffsetToPixel (eC_Int iIndex, eC_Int iCycle, eC_Value vOffset) |
virtual void | PixelToIndexCycleOffset (eC_Value vPixel, eC_Int &iIndex, eC_Int &iCycle, eC_Value &vOffset) |
virtual void | SetCurrentNode (eC_UInt uiNodeIndex) |
virtual void | SetCurrentNodeSafeIter (const NodeList::SafeIterator &kNodeSafeIter) |
virtual void | SetCurrentScrollPosForCurrentDirection (eC_Value vCurrentScrollPos) |
virtual void | SetDefaultNodeSize (eC_Value vWidth, eC_Value vHeight) |
virtual void | StartScrollingAnimation () |
virtual void | StopScrollingAnimation () |
![]() | |
virtual eC_Bool | CreateBitmapPlane () |
virtual eC_Bool | FourWayNext (FourWayFocus_t eFocusDirection) |
![]() | |
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 |
![]() | |
virtual void | AddSubject (CGUISubject *pSubjectToAdd) |
virtual void | RemoveSubject (CGUISubject *pSubjectToRemove) |
Protected Attributes | |
eC_Bool | m_bAnimatedUpdate |
if updates should animate to value, rather than jump | |
eC_Bool | m_bCyclic |
True if wheel is cyclic. False if non-cyclic. The wheel then stops at begin/end of entries. | |
eC_Bool | m_bFillFromBegin |
If true entries will be filled in front of entry, if false at end. | |
eC_Bool | m_bUseRange |
If true entries will be automatically generated with the use of below values. | |
eC_UInt | m_CurrentNodeIndex |
Index of current node. | |
NodeList::SafeIterator | m_CurrentNodeSafeIter |
Iterator pointing to the current node/entry. | |
ImageResource_t | m_eBGImage |
Used background image. | |
CGUICommonEnums::Orientation_t | m_eDirection |
Direction of the wheel. Either horizontal or vertical. | |
CGUIEasing::EasingType_t | m_eEasingTypeBack |
Easing for non-cyclic wheel if dragged further then wheel size. | |
CGUIEasing::EasingType_t | m_eEasingTypeCurrent |
EasingType used for kinetic animation. More... | |
CGUIEasing::EasingType_t | m_eEasingTypeNormal |
Easing used for all animations which will not go further then the wheel end. | |
FontResource_t | m_eEntriesFont |
Font of all non focused entries. | |
FontResource_t | m_eFocussedEntryFont |
Font of the focused entry. | |
eC_Int | m_iAniStartNodeCycle |
Animation start node cycle. | |
eC_Int | m_iAniStartNodeIndex |
Animation start node index. | |
eC_Int | m_iAniTargetNodeCycle |
Animation target node cycle. | |
eC_Int | m_iAniTargetNodeIndex |
Animation target node. | |
eC_Int | m_iMaxValue |
Biggest generated entry. | |
eC_Int | m_iMinDigitNumber |
Minimal number of digits. | |
eC_Int | m_iMinValue |
Smallest generated entry. | |
eC_Int | m_iStepSize |
Step size used for entry generation. | |
CGUIPoint | m_kDragStart |
Holds the start point of a drag. | |
eC_String | m_kFillupString |
String will be used to fill up missing digits. | |
eC_String | m_kFocussedValue |
Current focused value. | |
CGUINinePatch | m_kNinePatch |
used ninepatch | |
NodeList | m_kNodes |
List containing all nodes/entries. | |
eC_String | m_kPostfixString |
String will be place behind of entry. Can be used for example for units etc. | |
eC_String | m_kPrefixString |
String will be place in front of entry. | |
eC_UInt | m_uiDragStarted |
Holds the time when the last drag was started. Used to calculate the drag speed. | |
eC_UInt | m_uiDragTimeStamp |
Time at start of animation and Timestamp of last received DoDrag()-Event. | |
eC_UInt | m_uiNumOfVisibleNodes |
Number of visible nodes of the wheel. | |
eC_Value | m_vAdditionalSpace |
Used for positioning in DoDraw. | |
eC_Value | m_vAniStartScrollPos |
Animation start scrolling position. | |
eC_Value | m_vAniTargetScrollPos |
Animation target scrolling position. | |
eC_Value | m_vCurrentScrollPosX |
Scrolling position of current node (offset in pixels (0-m_vNodeDefaultWidth)). | |
eC_Value | m_vCurrentScrollPosY |
Scrolling position of current node (offset in pixels (0-m_vNodeDefaultHeight)). | |
eC_Value | m_vEasingDurationBack |
Easing duration for non-cyclic wheel if dragged further then wheel size. | |
eC_Value | m_vEasingDurationCurrent |
Duration of easing animation for kinetic scrolling. More... | |
eC_Value | m_vEasingDurationNormal |
Easing duration used for all animations which will not go further then the wheel end. | |
eC_Value | m_vNodeDefaultHeight |
Entry height in pixels. Has to be > 0. | |
eC_Value | m_vNodeDefaultWidth |
Entry width in pixels. Has to be > 0. | |
eC_Value | m_vNodeX |
Node horizontal feed rate for the gui text positions. | |
eC_Value | m_vNodeY |
Node vertical feed rate for the gui text positions. | |
eC_Value | m_vRemainingSpaceX |
If the nodes are not fitting exactly this is the rest space. | |
eC_Value | m_vRemainingSpaceY |
If the nodes are not fitting exactly this is the rest space. | |
eC_Value | m_vTargetPos |
Target position in pixels for animation. | |
![]() | |
UUID_t | m_kUUID |
UUID of object. | |
Static Protected Attributes | |
static const eC_UInt | INDEX_COLOR_ENTRY |
index for entry-color | |
static const eC_UInt | INDEX_COLOR_FOCUSSEDENTRY |
index for focussed entry color | |
Additional Inherited Members | |
![]() | |
static UUID_t | GenerateUUID () |
![]() | |
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 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 const eC_Char | XMLTAG_CLASSVERSION [] |
Displays a wheel in the GUI.
![]() | The "wheel" control is used to display a wheel. The position and dimension of the image can be set freely. The scaling of the background image is arbitrary in x and y dimension - so the aspect ratio can be changed. The "wheel" control is typically used to select a value out of a small number of elements e.g., temperatures. The "wheel" can by endless (means: cyclic). |
This control displays a wheel containing a range of values.
Example:
CGUIWheel::CGUIWheel | ( | 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 |
||
) |
Constructor
pkParent | Pointer to the parent object of this image. |
vX | The x coordinate of the upper left corner of this image. |
vY | The y coordinate of the upper left corner of this image. |
vWidth | The width of this image. |
vHeight | The height of this image. |
eID | This wheel's object ID. |
CGUIWheel::CGUIWheel | ( | const CGUIWheel & | kToBeCopied | ) |
Copy constructor
kToBeCopied |
|
virtual |
Adapt the wheel to its current parameters. Call this after updating the range of values.
|
virtual |
Adds a new entry to the wheel.
kEntry | Value of new entry. |
bSort | True if wheel should be sorted after adding entry. |
|
protectedvirtual |
Adjusts all the current node and scrolling position dependent of the DragDelta.
vDragDelta | The offset to which the text positions should be adjusted. |
|
protectedvirtual |
Adjusts all nodes GUIText to reflect the current position
|
protectedvirtual |
Adjusts all nodes GUIText to reflect the current position. Used for cyclic wheels.
|
protectedvirtual |
Adjusts all nodes GUIText to reflect the current position. Used for non-cyclic wheels.
|
protectedvirtual |
Adjusts the sizes of remaining space, number of visible nodes and default height.
|
protectedvirtual |
If m_bUseRange is true this method creates nodes between m_iMinValue and m_iMaxValue using m_iStepSize as step size.
void CGUIWheel::DeInit | ( | ) |
De initializes members.
|
virtual |
Deletes all entries from the wheel.
|
virtual |
Deletes an entry from the wheel.
kEntry | Value of entry which will be deleted. |
|
virtual |
Called when the timer of an animation callback belonging to this animatable has expired.
vTimes | The 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 from CGUIAnimatable.
|
virtual |
Called when the mouse button or finger is pressed down over an object.
vAbsX | X-position in screen coordinates where the click occurred |
vAbsY | Y-position in screen coordinates where the click occurred |
Reimplemented from CGUIBehaviour.
|
virtual |
Called when the object receives a click event. A click can e.g., be the result of a mouse click, a finger press/release sequence on touchscreens, or be triggered by a GK_ACTION keyboard event.
vAbsX | X-position in screen coordinates where the click occurred |
vAbsY | Y-position in screen coordinates where the click occurred |
Reimplemented from CGUIBehaviour.
|
virtual |
Called when the object receives a Drag event. Drags are typically created if the mouse is being used while a mouse-button is being pressed, or if the user moves his finger over a touchscreen.
vDeltaX | relative movement in x-direction since the last call of DoDrag/ButtonDown |
vDeltaY | relative movement in y-direction since the last call of DoDrag/ButtonDown |
vAbsX | current X-position in screen coordinates of the mouse |
vAbsY | current Y-position in screen coordinates of the mouse |
Reimplemented from CGUIBehaviour.
|
virtual |
Called on the dragged object (=the object on which the initial ButtonDown-event occurred) when the mouse button is released after a drag event.
vAbsX | current X-position in screen coordinates of the mouse |
vAbsY | current Y-position in screen coordinates of the mouse |
Reimplemented from CGUIBehaviour.
|
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.
Reimplemented from CGUIObject.
eC_Bool CGUIWheel::GetAnimatedUpdate | ( | ) | const |
get if updates will trigger animations
|
virtual |
GetCurrentIndex returns the current focused entry value.
|
protectedvirtual |
Retrieves the current node index.
|
protectedvirtual |
Retrieves an iterator pointing to the current node.
|
protectedvirtual |
Gets the current scrolling position dependent of direction.
|
virtual |
GetCurrentValue returns the current focused entry value.
|
protectedvirtual |
Retrieves the node size dependent to the direction of the wheel.
CGUICommonEnums::Orientation_t CGUIWheel::GetDirection | ( | ) | const |
Get currently set direction of wheel
eC_UInt CGUIWheel::GetEntriesColor | ( | ) | const |
returns the curently used color for entries
FontResource_t CGUIWheel::GetEntriesFont | ( | ) | const |
Get the font-id for entries
eC_UInt CGUIWheel::GetFocussedEntryColor | ( | ) | const |
returns the curently used color for the foccused entry
FontResource_t CGUIWheel::GetFocussedEntryFont | ( | ) | const |
Get the font-id for focussed entries
eC_Int CGUIWheel::GetMaxValue | ( | ) |
Get the maximum allowed value of the wheel
eC_Int CGUIWheel::GetMinValue | ( | ) |
Get the minimum allowed value of the wheel
|
protectedvirtual |
Retrieves an iterator pointing to the next node.
kIter | Iterator pointing to double linked list. |
|
inline |
Get the nine-patch which is used to draw the background of the wheel
|
protectedvirtual |
Retrieves the index pointing to the current node.
kNodeIter | Iterator pointing to the position to which the index should be returned. |
|
protectedvirtual |
Retrieves the node index specified via an offset in pixels.
vOffset | Offset in pixels to the current position. |
iIndex | Resulting index. |
iCycle | Resulting cycle. |
vScrollPos | Resulting scrolling position. |
|
protected |
Returns a reference to the internal list of nodes.
eC_UInt CGUIWheel::GetNumberOfEntries | ( | ) |
Returns the total number of entries in the wheel.
|
protectedvirtual |
Retrieves an iterator pointing to the previous node.
kIter | Iterator pointing to double linked list. |
eC_Int CGUIWheel::GetStepSize | ( | ) | const |
Get the stepsize between two values within the wheel.
|
protectedvirtual |
Calculates the position in pixels out of entry index, cycle and offset (scrolling position).
iIndex | index |
iCycle | cycle |
vOffset |
void CGUIWheel::Init | ( | ) |
initializes members.
eC_Bool CGUIWheel::IsCyclic | ( | ) | const |
Returns whether the wheel is in Cyclic mode (Nodes continue from the beginning, when scrolling past the end).
|
inlinevirtual |
This method checks if an object is highlightable. This refers to whether it can be highlighted via the event handler. If true the event handler may mark this object as the currently highlighted one. Thus, there is no special flag in CGUIObject that determines if an object is highlightable. The default determination is that the control is in none of the following states:
Reimplemented from CGUIObject.
eC_Bool CGUIWheel::IsUsingRange | ( | ) | const |
Returns whether the wheel is using the given min/max/stepsize values to automatically generate its entries.
|
virtual |
Prefixes the given entry with the contents of the FillupString until it reaches the defined minimum length. This also prefixes the entry with m_kPrefixString and appends m_kPostfixString
kEntry | Text which will be extended to the minimum length and get pre-/postfixed |
|
virtual |
called when a color-property was changed
Reimplemented from CGUIColorPropertyObserver.
Assignment constructor
kSource |
|
protectedvirtual |
Calculates the index, cycle and offset (scrolling position) out of a pixel position.
vPixel | pixel-position |
iIndex | calculated index |
iCycle | calculated cycle |
vOffset | pixel-offset |
|
virtual |
Reads all attributes from streaming file. This method is called by CGUIFactoryManager after one of the registered factories has created an instance of this class.
Reimplemented from CGUIObject.
|
virtual |
Scrolls to the given entry/node value.
kNodeText | Value of entry/node. |
|
virtual |
Scrolls to the given entry/node index.
uiNodeIndex | Index of entry/node. |
|
virtual |
Scrolls using animations to the given entry/node value.
kNodeText | Value of entry/node. |
|
virtual |
Scrolls using animations to the given entry/node value.
uiNodeIndex | Index of entry/node. |
|
virtual |
SearchEntry returns the index of an existing entry value. If the given value is not part of the list -1 is returned.
kNodeText | Value of entry/node which is searched for. |
void CGUIWheel::SetAnimatedUpdate | ( | const eC_Bool & | bAnimatedUpdate | ) |
sets if updates will trigger animations
bAnimatedUpdate | true or false |
|
protectedvirtual |
Sets the current node index via index.
uiNodeIndex | The current node index to set. |
|
protectedvirtual |
Set the current wheel position via Iterator.
kNodeSafeIter | Iterator pointing to the new position. |
|
protectedvirtual |
Sets the scrolling position dependent to the direction of the wheel.
vCurrentScrollPos | New scrolling position horizontal or vertical. |
void CGUIWheel::SetCyclic | ( | eC_Bool | bCyclic | ) |
Specifies whether the wheel is in Cyclic mode (Nodes continue from the beginning, when scrolling past the end).
bCyclic | True if wheel shall be cyclic, False otherwise. |
|
protectedvirtual |
Sets the node/entry size.
vWidth | Value of new node/entry width. |
vHeight | Value of new node/entry height. |
void CGUIWheel::SetDirection | ( | CGUICommonEnums::Orientation_t | eDirection | ) |
Sets direction of wheel
eDirection |
void CGUIWheel::SetEntriesColor | ( | const eC_UInt & | uiEntriesColor | ) |
Sets the color which is used for non-focussed entries
uiEntriesColor | color |
void CGUIWheel::SetEntriesColor | ( | const GlobalProperty_t & | eEntriesColor | ) |
Sets the color which is used for non-focussed entries
eEntriesColor | color-property |
void CGUIWheel::SetEntriesFont | ( | const FontResource_t & | eFontID | ) |
Set font-id for entries
eFontID | font-id |
void CGUIWheel::SetFocussedEntryColor | ( | const eC_UInt & | uiFocussedEntryColor | ) |
Sets the color which is used for the focussed entry
uiFocussedEntryColor | color |
void CGUIWheel::SetFocussedEntryColor | ( | const GlobalProperty_t & | eFocussedEntryColor | ) |
Sets the color which is used for the focussed entry
eFocussedEntryColor | color-property |
void CGUIWheel::SetFocussedEntryFont | ( | const FontResource_t & | eFontID | ) |
Set font-id for focussed entry
eFontID | font-id |
|
virtual |
Sets this object's height to a new value.
vY | the new height |
Reimplemented from CGUIObject.
void CGUIWheel::SetMaxValue | ( | eC_Int | iMaxValue | ) |
Set the maximum allowed value of the wheel
iMaxValue | new maximum value |
void CGUIWheel::SetMinValue | ( | eC_Int | iMinValue | ) |
Set the minimum allowed value of the wheel
iMinValue | new minimum value |
void CGUIWheel::SetPostfixString | ( | const eC_String & | kPostfixString | ) |
Set the string which will be appended as a postfix to each entry in the wheel-
kPostfixString | Postfix which will be appended to each item in the wheel. |
void CGUIWheel::SetStepSize | ( | eC_Int | iStepSize | ) |
Set the stepsize between two values within the wheel.
iStepSize | stepsize/distance of values in the wheel |
void CGUIWheel::SetUseRange | ( | eC_Bool | bUseRange | ) |
Specifies whether the wheel is using the given min/max/stepsize values to automatically generate its entries. Instead of automatically generating entries from the given range, you can manually add entries via the AddEntry() method.
bUseRange | True if range values are used to automatically generate content, False otherwise. |
|
virtual |
Generic interface for setting object values. The SetValue() API enables you to forward any data of type CGUIValue to any object. How this value finally gets interpreted is up to the receiving object's implementation.
This concept is particularly useful for linking GUI-objects to an external data source. You can for instance forward an integer value as a CGUIValue object to a GUIObject without the need to know whether it is a CGUITextField, or a CGUIProgressBar, or something completely different. The receiving object will interpret the value in the most sensible way. In the given example the integer will be displayed as a string in the Textfield, while it will cause the ProgressBar to fill up to the respective value.
rkValue | DataPoolEntry containing the value to be handed over to the object on which SetValue was called. |
Reimplemented from CGUIObject.
|
virtual |
|
protectedvirtual |
Start animation.
|
protectedvirtual |
Stop animation.
|
virtual |
Writes all attributes to the streaming file. A CGUIStreamWriter has to be initialized first.
bWriteClassID | This flag is used to select if writing of control class ID, leading and trailing tags is performed. |
Reimplemented from CGUIObject.
|
protected |
EasingType used for kinetic animation.
Current active easing.
|
protected |
Duration of easing animation for kinetic scrolling.
Current active easing duration.