#include <GUIWheelContainer.h>

Inheritance diagram for CGUIWheelContainer:

[legend]

Public Member Functions
	CGUIWheelContainer ()
	Default constructor.

	CGUIWheelContainer (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)

	CGUIWheelContainer (const CGUIWheelContainer &kToBeCopied)

virtual void	AdaptWheel ()

virtual eC_Bool	AddObject (CGUIObject *pkObject)

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	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 ()

ImageResource_t	GetBGImage () const

eC_Bool	GetCenterChildren () const

virtual eC_UInt	GetCurrentIndex ()

CGUICommonEnums::Orientation_t	GetDirection () const

void	GetEasing (CGUIEasing::EasingType_t &eEasing, eC_Value &vEasingTime) const

eC_Value	GetMinimumDragDistance () const

CGUINinePatch &	GetNinePatch ()

eC_Value	GetSwipeDistance () const

eC_Value	GetTargetSnappingPosition () const

eC_Bool	IsCyclic () const

CGUIWheelContainer &	operator= (const CGUIWheelContainer &kSource)

virtual void	ReadFromStream ()

virtual void	RemoveObject (CGUIObject *pkObject)

virtual void	ScrollTo (eC_UInt uiNodeIndex)

virtual void	ScrollToAnimated (eC_UInt uiNodeIndex)

void	SetBGImage (const ImageResource_t &eBGImage)

void	SetCenterChildren (const eC_Bool &bCenterChildren)

void	SetCyclic (eC_Bool bCyclic)

void	SetDirection (const CGUICommonEnums::Orientation_t &eDirection)

void	SetEasing (const CGUIEasing::EasingType_t &eEasing, const eC_Value &vEasingTime)

virtual void	SetHeight (const eC_Value &vY)

void	SetMinimumDragDistance (const eC_Value &vMinimumDragDistance)

void	SetSwipeDistance (const eC_Value &vSwipeDistance)

void	SetTargetSnappingPosition (const eC_Value &vTargetSnappingPos)

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 CGUICompositeObject
	CGUICompositeObject ()

	CGUICompositeObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)

	CGUICompositeObject (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)

	CGUICompositeObject (const CGUICompositeObject &kSource)

virtual	~CGUICompositeObject ()
	This destructor is automatically virtual, as the base class destructor is virtual.

virtual eC_Bool	AddObject (CGUIObject *pkObject)

eC_Bool	BringToFront (CGUIObject *pkObject)

eC_Bool	CanBeCyclicFocussed () const

virtual eC_Bool	DoPostDraw ()

void	DrawOnTop (CGUIObject *pkObject)

void	DrawOnTopOf (CGUIObject const pkObject, CGUIObject const pDrawOnTopOf)

virtual CGUIObject *	FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)

void	Flip (const eC_Bool &rbVertical)

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)

CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName)

const CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName) const

CGUIObject *	GetChild (const eC_UInt uIndex)

CGUIObject *	GetChild (const eC_UInt uIndex) const

const ObjectPtrList &	GetChildObjectsList () const

const ObjectPtrList &	GetDrawOrderList () const

eC_Int	GetIndexOfChild (const CGUIObject *pkObject) const

eC_UInt	GetNumberOfChildren () 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

eC_Bool	InsertChildAt (const eC_UInt cuiIndex, CGUIObject *pkChild)

void	InvalidateChildren ()
	Invalidates all chidren, but not this parent.

eC_Bool	IsAncestorOf (const CGUIObject *pkObject) const

virtual eC_Bool	IsCompositeObject () const

eC_Bool	LowerOneLevel (CGUIObject *pkObject)

CGUICompositeObject &	operator= (const CGUICompositeObject &kSource)

eC_Bool	RaiseOneLevel (CGUIObject *pkObject)

virtual void	ReadFromStream ()

virtual void	RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const

void	RemoveAllChildren ()

virtual void	RemoveObject (CGUIObject *pkObject)

void	Rotate (const eC_UInt &ruiDegrees, const eC_Bool &rbFirst=false)

eC_Bool	SendToBack (CGUIObject *pkObject)

virtual void	SetClickThrough (const eC_Bool &bClickThrough)

virtual void	SetClickThrough (const eC_Bool &bClickThrough, const eC_Bool &bChildrenClickThrough)

void	SetCyclicFocus (const eC_Bool &bCyclicFocus)

virtual void	SetDisabled (const eC_Bool &bDisabled)

virtual void	SetDisabled (const eC_Bool &bDisabled, const eC_Bool &bChildrenDisabled)

virtual void	SetFocussable (const eC_Bool &bFocussable)

virtual void	SetFocussable (const eC_Bool &bFocussable, const eC_Bool &bChildrenFocussable)

virtual void	SetGrayedOut (const eC_Bool &bGrayedOut)

virtual void	SetGrayedOut (const eC_Bool &bGrayedOut, const eC_Bool &bChildrenGrayedOut)

virtual void	SetHeight (const eC_Value &vY)

virtual void	SetInvisible (const eC_Bool &bInvisible)

virtual void	SetInvisible (const eC_Bool &bInvisible, const eC_Bool &bChildrenInvisible)

virtual void	SetWidth (const eC_Value &vX)

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	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)

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 Member Functions
virtual void	AdjustCurrentScrollPosAndNode ()

virtual void	AdjustNodesPosition ()

virtual eC_UInt	GetCurrentNode ()

virtual ObjectPtrList::SafeIterator	GetCurrentNodeSafeIter ()

virtual eC_Value	GetCurrentScrollPosForCurrentDirection ()

virtual ObjectPtrList::Iterator	GetNextNodeCyclic (ObjectPtrList::Iterator kIter, eC_Bool &bWrapped)

void	GetNodeIndexForPosition (const eC_Value &vOffset, eC_Int &iIndex, eC_Int &iCycle, eC_Value &vScrollPos)

virtual eC_UInt	GetNodeIndexFromIter (const ObjectPtrList::Iterator &kNodeIter)

eC_Value	GetPositionForNodeIndex (const eC_Int &iIndex, const eC_Int &iCycle, const eC_Value &vScrollPos)

virtual ObjectPtrList::Iterator	GetPreviousNodeCyclic (ObjectPtrList::Iterator kIter)

virtual void	SetCurrentNode (eC_UInt uiNodeIndex)

virtual void	SetCurrentNodeSafeIter (const ObjectPtrList::SafeIterator &kNodeSafeIter)

virtual void	SetCurrentScrollPosForCurrentDirection (eC_Value vCurrentScrollPos)

void	SetScrollPosition (const eC_Value &vScrollPosition)

virtual void	StartScrollingAnimation ()

virtual void	StopScrollingAnimation ()

Protected Member Functions inherited from CGUICompositeObject
virtual eC_Bool	FourWayNext (FourWayFocus_t eFocusDirection)

ObjectPtrList &	GetChildObjectsList ()

virtual void	HandleDraw (const CGUIRect &ClipRect)

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

Additional Inherited Members
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 CGUICompositeObject
static const eC_Char	XMLTAG_CHILDREN []
	XML comment tag to be used before writing children to a stream.

static const eC_Char	XMLTAG_ENDCHILDREN []
	XML comment tag to be used after writing children to a stream.

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 Attributes inherited from CGUIObject
UUID_t	m_kUUID
	UUID of object.

Detailed Description

The Wheel-Container can be used to group elements and to cycle through them by draging. It is suitable if you want to have a number of navigational elements, but don't have enough space.

A specific use-case would be the menu of a smartwatch.

The controls in the Wheel-Container can also be CGUICompositeObjects to allow a wider range of use-cases. The Snapping-Position can be used to place the currently active element on a specific position relative to the upper-left edge of the container. Also a cyclic behaviour is possible where the child-elements are placed on a wheel which does not have any end and repeats itsels over and over again.

Constructor & Destructor Documentation

◆ CGUIWheelContainer() [1/2]

CGUIWheelContainer::CGUIWheelContainer	(	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

Parameters

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.

◆ CGUIWheelContainer() [2/2]

CGUIWheelContainer::CGUIWheelContainer ( const CGUIWheelContainer & kToBeCopied )

Copy constructor

Parameters

kToBeCopied

Member Function Documentation

◆ AdaptWheel()

virtual void CGUIWheelContainer::AdaptWheel ( )

virtual

Adapt the wheel to its current parameters. Call this after updating the range of values.

◆ AddObject()

virtual eC_Bool CGUIWheelContainer::AddObject ( CGUIObject * pkObject )

virtual

Add a new Object to the list of child objects. This will automatically set the child's parent-pointer to this object.

Parameters

pkObject The object to be added

Returns: False if the object is already a child of this control or pkObject is NULL, otherwise true.

Reimplemented from CGUICompositeObject.

◆ AdjustCurrentScrollPosAndNode()

virtual void CGUIWheelContainer::AdjustCurrentScrollPosAndNode ( )

protectedvirtual

Adjusts all the current node and scrolling position dependent of the DragDelta.

◆ AdjustNodesPosition()

virtual void CGUIWheelContainer::AdjustNodesPosition ( )

protectedvirtual

Adjusts all nodes GUIText to reflect the current position. Used for non-cyclic wheels.

◆ DoAnimate()

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

virtual

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

Parameters

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.

◆ DoButtonDown()

virtual eC_Bool CGUIWheelContainer::DoButtonDown	(	const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)

virtual

Called when the mouse button or finger is pressed down over an object.

Note: DoButtonDown() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on the object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the object was pressed relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the click occurred
vAbsY	Y-position in screen coordinates where the click occurred

Returns: True The event has been handled.
False The event has not been handled. In this base implementation always returns False.

Reimplemented from CGUIBehaviour.

◆ DoDrag()

virtual eC_Bool CGUIWheelContainer::DoDrag	(	const eC_Value &	vDeltaX,
		const eC_Value &	vDeltaY,
		const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)

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.

Parameters

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

Returns: True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoDragEnd()

virtual eC_Bool CGUIWheelContainer::DoDragEnd	(	const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)

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.

Parameters

vAbsX	current X-position in screen coordinates of the mouse
vAbsY	current Y-position in screen coordinates of the mouse

Returns: True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoDraw()

virtual eC_Bool CGUIWheelContainer::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 CGUIObject.

◆ GetBGImage()

ImageResource_t CGUIWheelContainer::GetBGImage ( ) const

Get the background-image

Returns: background-image

◆ GetCenterChildren()

eC_Bool CGUIWheelContainer::GetCenterChildren ( ) const

Checks if children are centered

Returns: true if centered

◆ GetCurrentIndex()

virtual eC_UInt CGUIWheelContainer::GetCurrentIndex ( )

virtual

GetCurrentIndex returns the current focused entry value.

Returns: eC_UInt containing the current focused index.

◆ GetCurrentNode()

virtual eC_UInt CGUIWheelContainer::GetCurrentNode ( )

protectedvirtual

Retrieves the current node index.

Returns: The current node index.

◆ GetCurrentNodeSafeIter()

virtual ObjectPtrList::SafeIterator CGUIWheelContainer::GetCurrentNodeSafeIter ( )

protectedvirtual

Retrieves an iterator pointing to the current node.

Returns: The iterator to the current position

◆ GetCurrentScrollPosForCurrentDirection()

virtual eC_Value CGUIWheelContainer::GetCurrentScrollPosForCurrentDirection ( )

protectedvirtual

Gets the current scrolling position dependent of direction.

Returns: Value of the scrolling position.

◆ GetDirection()

CGUICommonEnums::Orientation_t CGUIWheelContainer::GetDirection ( ) const

get the currently set direction

Returns: direction

◆ GetEasing()

void CGUIWheelContainer::GetEasing	(	CGUIEasing::EasingType_t &	eEasing,
		eC_Value &	vEasingTime
	)		const

Get easing-parameters for easing

Parameters

eEasing
vEasingTime

◆ GetMinimumDragDistance()

eC_Value CGUIWheelContainer::GetMinimumDragDistance ( ) const

Returns the minimum distance after which a drag-action is executed

Returns: drag-distance

◆ GetNextNodeCyclic()

virtual ObjectPtrList::Iterator CGUIWheelContainer::GetNextNodeCyclic	(	ObjectPtrList::Iterator	kIter,
		eC_Bool &	bWrapped
	)

protectedvirtual

Retrieves an iterator pointing to the next node.

Parameters

kIter	Iterator pointing to double linked list.
bWrapped	true if iterator was wrapped around

Returns: An iterator to the next node.

◆ GetNinePatch()

CGUINinePatch & CGUIWheelContainer::GetNinePatch ( )

inline

Get the nine-patch which is used to draw the background of the wheel

Returns: nine-patch

◆ GetNodeIndexForPosition()

void CGUIWheelContainer::GetNodeIndexForPosition	(	const eC_Value &	vOffset,
		eC_Int &	iIndex,
		eC_Int &	iCycle,
		eC_Value &	vScrollPos
	)

protected

Calculates the index, cycle and offset (scrolling position) out of a pixel position.

Parameters

vOffset	pixel-offset
iIndex	calculated index
iCycle	calculated cycle
vScrollPos	pixel-position

◆ GetNodeIndexFromIter()

virtual eC_UInt CGUIWheelContainer::GetNodeIndexFromIter ( const ObjectPtrList::Iterator & kNodeIter )

protectedvirtual

Retrieves the index pointing to the current node.

Parameters

kNodeIter Iterator pointing to the position to which the index should be returned.

Returns: The iterator to the current position

◆ GetPositionForNodeIndex()

eC_Value CGUIWheelContainer::GetPositionForNodeIndex	(	const eC_Int &	iIndex,
		const eC_Int &	iCycle,
		const eC_Value &	vScrollPos
	)

protected

Calculates the position in pixels out of entry index, cycle and offset (scrolling position).

Parameters

iIndex	index
iCycle	cycle
vScrollPos	pixel-position

Returns: pixel-offset

◆ GetPreviousNodeCyclic()

virtual ObjectPtrList::Iterator CGUIWheelContainer::GetPreviousNodeCyclic ( ObjectPtrList::Iterator kIter )

protectedvirtual

Retrieves an iterator pointing to the previous node.

Parameters

kIter Iterator pointing to double linked list.

Returns: An iterator to the previous node.

◆ GetSwipeDistance()

eC_Value CGUIWheelContainer::GetSwipeDistance ( ) const

Returns the distance needed for a swipe

Returns: swipe-distance

◆ GetTargetSnappingPosition()

eC_Value CGUIWheelContainer::GetTargetSnappingPosition ( ) const

get the currently set snapping position

Returns: snapping-position

◆ IsCyclic()

eC_Bool CGUIWheelContainer::IsCyclic ( ) const

Returns whether the wheel is in Cyclic mode (Nodes continue from the beginning, when scrolling past the end).

Returns: True if wheel is cyclic, False otherwise.

◆ operator=()

CGUIWheelContainer & CGUIWheelContainer::operator= ( const CGUIWheelContainer & kSource )

Assignment constructor

Parameters

kSource

Returns: copy

◆ ReadFromStream()

virtual void CGUIWheelContainer::ReadFromStream ( )

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 CGUICompositeObject.

◆ RemoveObject()

virtual void CGUIWheelContainer::RemoveObject ( CGUIObject * pkObject )

virtual

Removes an object from the list of child objects. This will not delete the object! If you wish to physically delete an object, you should use the C++ delete operator. The destructor of the object will then remove the object from the child list by calling this method.

Parameters

pkObject The object to be removed

Reimplemented from CGUICompositeObject.

◆ ScrollTo()

virtual void CGUIWheelContainer::ScrollTo ( eC_UInt uiNodeIndex )

virtual

Scrolls to the given entry/node index.

Parameters

uiNodeIndex Index of entry/node.

◆ ScrollToAnimated()

virtual void CGUIWheelContainer::ScrollToAnimated ( eC_UInt uiNodeIndex )

virtual

Scrolls using animations to the given entry/node value.

Parameters

uiNodeIndex Index of entry/node.

◆ SetBGImage()

void CGUIWheelContainer::SetBGImage ( const ImageResource_t & eBGImage )

Set the background-image

Parameters

eBGImage

◆ SetCenterChildren()

void CGUIWheelContainer::SetCenterChildren ( const eC_Bool & bCenterChildren )

Sets the children to centered mode or not

Parameters

bCenterChildren if true the children are centered according to the current orientation

◆ SetCurrentNode()

virtual void CGUIWheelContainer::SetCurrentNode ( eC_UInt uiNodeIndex )

protectedvirtual

Sets the current node index via index.

Parameters

uiNodeIndex The current node index to set.

◆ SetCurrentNodeSafeIter()

virtual void CGUIWheelContainer::SetCurrentNodeSafeIter ( const ObjectPtrList::SafeIterator & kNodeSafeIter )

protectedvirtual

Set the current wheel position via Iterator.

Parameters

kNodeSafeIter Iterator pointing to the new position.

◆ SetCurrentScrollPosForCurrentDirection()

virtual void CGUIWheelContainer::SetCurrentScrollPosForCurrentDirection ( eC_Value vCurrentScrollPos )

protectedvirtual

Sets the scrolling position dependent to the direction of the wheel.

Parameters

vCurrentScrollPos New scrolling position horizontal or vertical.

◆ SetCyclic()

void CGUIWheelContainer::SetCyclic ( eC_Bool bCyclic )

Specifies whether the wheel is in Cyclic mode (Nodes continue from the beginning, when scrolling past the end).

Parameters

bCyclic True if wheel shall be cyclic, False otherwise.

◆ SetDirection()

void CGUIWheelContainer::SetDirection ( const CGUICommonEnums::Orientation_t & eDirection )

Sets the direction for the wheel

Parameters

eDirection

◆ SetEasing()

void CGUIWheelContainer::SetEasing	(	const CGUIEasing::EasingType_t &	eEasing,
		const eC_Value &	vEasingTime
	)

Set easing-parameters for easing

Parameters

eEasing
vEasingTime

◆ SetHeight()

virtual void CGUIWheelContainer::SetHeight ( const eC_Value & vY )

virtual

Overridden SetHeight method. A composite object will call DoLayout() on itself when its width/height is changed if its associated layouter is independent of the parent's size. Afterwards in any case its direct children's DoLayout() of their layouters are called.

Parameters

vY	The new height

Reimplemented from CGUICompositeObject.

◆ SetMinimumDragDistance()

void CGUIWheelContainer::SetMinimumDragDistance ( const eC_Value & vMinimumDragDistance )

Sets the distance in pixels after which a drag-action will be executed

Parameters

vMinimumDragDistance

◆ SetScrollPosition()

void CGUIWheelContainer::SetScrollPosition ( const eC_Value & vScrollPosition )

protected

Set the current scroll-position

Parameters

vScrollPosition scroll position

◆ SetSwipeDistance()

void CGUIWheelContainer::SetSwipeDistance ( const eC_Value & vSwipeDistance )

Sets the distance which needs to be exceeded that a swipe (switch to the next element) is performed

Parameters

vSwipeDistance

◆ SetTargetSnappingPosition()

void CGUIWheelContainer::SetTargetSnappingPosition ( const eC_Value & vTargetSnappingPos )

Set the snapping position

Parameters

vTargetSnappingPos

◆ SetValue()

virtual eC_Bool CGUIWheelContainer::SetValue ( const CGUIValue & rkValue )

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.

Parameters

rkValue DataPoolEntry containing the value to be handed over to the object on which SetValue was called.

Returns: Always False in base class, normally True if value was applied and False in case of error.

Reimplemented from CGUIObject.

◆ SetWidth()

virtual void CGUIWheelContainer::SetWidth ( const eC_Value & vX )

virtual

Overridden SetWidth method. A composite object will call DoLayout() on itself when its width/height is changed if its associated layouter is independent of the parent's size. Afterwards in any case its direct children's DoLayout() of their layouters are called.

Parameters

vX	The new width

Reimplemented from CGUICompositeObject.

◆ StartScrollingAnimation()

virtual void CGUIWheelContainer::StartScrollingAnimation ( )

protectedvirtual

Start animation.

◆ StopScrollingAnimation()

virtual void CGUIWheelContainer::StopScrollingAnimation ( )

protectedvirtual

Stop animation.

◆ WriteToStream()

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

virtual

Writes all attributes to the streaming file. A CGUIStreamWriter has to be initialized first.

Parameters

bWriteClassID This flag is used to select if writing of control class ID, leading and trailing tags is performed.

Reimplemented from CGUICompositeObject.

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

GUIWheelContainer.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUIWheelContainer() [1/2]

◆ CGUIWheelContainer() [2/2]

Member Function Documentation

◆ AdaptWheel()

◆ AddObject()

◆ AdjustCurrentScrollPosAndNode()

◆ AdjustNodesPosition()

◆ DoAnimate()

◆ DoButtonDown()

◆ DoDrag()

◆ DoDragEnd()

◆ DoDraw()

◆ GetBGImage()

◆ GetCenterChildren()

◆ GetCurrentIndex()

◆ GetCurrentNode()

◆ GetCurrentNodeSafeIter()

◆ GetCurrentScrollPosForCurrentDirection()

◆ GetDirection()

◆ GetEasing()

◆ GetMinimumDragDistance()

◆ GetNextNodeCyclic()

◆ GetNinePatch()

◆ GetNodeIndexForPosition()

◆ GetNodeIndexFromIter()

◆ GetPositionForNodeIndex()

◆ GetPreviousNodeCyclic()

◆ GetSwipeDistance()

◆ GetTargetSnappingPosition()

◆ IsCyclic()

◆ operator=()

◆ ReadFromStream()

◆ RemoveObject()

◆ ScrollTo()

◆ ScrollToAnimated()

◆ SetBGImage()

◆ SetCenterChildren()

◆ SetCurrentNode()

◆ SetCurrentNodeSafeIter()

◆ SetCurrentScrollPosForCurrentDirection()

◆ SetCyclic()

◆ SetDirection()

◆ SetEasing()

◆ SetHeight()

◆ SetMinimumDragDistance()

◆ SetScrollPosition()

◆ SetSwipeDistance()

◆ SetTargetSnappingPosition()

◆ SetValue()

◆ SetWidth()

◆ StartScrollingAnimation()

◆ StopScrollingAnimation()

◆ WriteToStream()