CGUICircularSlider Class Reference

This class represents a circular slider. More...

#include <GUICircularSlider.h>

Inheritance diagram for CGUICircularSlider:

Public Member Functions
	CGUICircularSlider ()
	CGUICircularSlider (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_Value &vRadius, const eC_Value &vStartAngle, const eC_Value &vEndAngle, const eC_Int &iValue, const eC_Int &iMin, const eC_Int &iMax, const eC_UInt &uiStepSize, const CGUIRange::Base_t &eBase=CGUIRange::BASE_AT_MINIMUM, const ObjectHandle_t &eID=NO_HANDLE)
void	CalculateKnobRect (const eC_Int &iValue)
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_Value	GetAngle (const eC_Value &vAbsX, const eC_Value &vAbsY)
eC_Value	GetEndAngle () const
eC_Value	GetKnobSize () const
eC_Value	GetRadius () const
eC_Bool	GetSmoothControl () const
eC_Value	GetStartAngle () const
virtual void	ReadFromStream ()
void	SetEndAngle (const eC_Value &vEndAngle)
void	SetImages (const ImageResource_t &eSldBG, const ImageResource_t &eSldKnobNormal, const ImageResource_t &eSldKnobHighlighted, const ImageResource_t &eSldKnobPressed, const ImageResource_t &eSldKnobGrayedOut=DUMMY_IMAGE)
void	SetKnobSize (const eC_Value &vKnobSize)
void	SetRadius (const eC_Value &vRadius)
void	SetRange (const eC_Int &iMin, const eC_Int &iMax)
void	SetSmoothControl (const eC_Bool &bSmoothControl)
void	SetStandardImages ()
	sets all images to standart images
void	SetStartAngle (const eC_Value &vStartAngle)
virtual eC_Bool	SetValue (const CGUIValue &rkValue)
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUIAbstractBar
void	AnimateToValue (const eC_Int iTargetValue)
eC_Bool	Decrease ()
virtual void	DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
eC_UInt	GetAnimationInterval () const
eC_UInt	GetAnimationSpeed () const
const CGUIRange &	GetRange () const
eC_Bool	Increase ()
virtual eC_Bool	OnValueChange ()
void	SetAnimationInterval (const eC_UInt &ruiAnimationInterval)
void	SetAnimationSpeed (const eC_UInt &ruiAnimationSpeed)
void	SetBase (CGUIRange::Base_t eBase)
void	SetLevel (eC_Value vPercent)
void	SetLevelPercentage (eC_UInt uiPercentage)
void	SetMaximumLevelIsAlwaysValid (eC_Bool bNotOnlyMultiplesOfStepSize)
void	SetMaxValue (eC_Int iMaxValue)
void	SetMinValue (eC_Int iMinValue)
void	SetRange (eC_Int iMinValue, eC_Int iMaxValue)
void	SetStepSize (eC_UInt uiIntValues)
void	SetStepSizeLevel (eC_Value vPercent)
void	SetStepSizeLevelPercentage (eC_UInt uiPercentage)
virtual eC_Bool	SetValue (const CGUIValue &rkValue)
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
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)
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	DoUserEvent (CGUIEvent *const pEvent)
virtual void	OnCreate ()
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	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	DoScrollUp (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoScrollDown (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoScrollLeft (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoScrollRight (const eC_Value &vAbsX, const eC_Value &vAbsY)
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 ()

Additional Inherited Members
Public Types inherited from CGUIObject
enum	FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }
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_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 Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []
Protected Member Functions inherited from CGUIAbstractBar
	CGUIAbstractBar ()
	CGUIAbstractBar (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIAbstractBar (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)
	CGUIAbstractBar (const CGUIAbstractBar &kSource)
CGUIAbstractBar &	operator= (const CGUIAbstractBar &kSource)
virtual void	ReadFromStream ()
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
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

This class represents a circular slider.

Like a normal slider this control has a background-image and several different images for the handle. A Start- and Ending-Angle can be defined where 0 is sitting in the middle pointing up.

The Radius is used to define the distance where the handle is displayed around the center of the control.

The Attribute "SmoothControl" can be used to display the handle in a smooth way, and not exactly where the calculated values are.

Constructor & Destructor Documentation

CGUICircularSlider() [1/2]

CGUICircularSlider::CGUICircularSlider	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const eC_Value &	vRadius,
		const eC_Value &	vStartAngle,
		const eC_Value &	vEndAngle,
		const eC_Int &	iValue,
		const eC_Int &	iMin,
		const eC_Int &	iMax,
		const eC_UInt &	uiStepSize,
		const CGUIRange::Base_t &	eBase = CGUIRange::BASE_AT_MINIMUM,
		const ObjectHandle_t &	eID = NO_HANDLE
	)

Constructor Please use the SetImages method to set the correct images.

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the slider
vHeight	Height of the slider
vRadius	Radius of the slider
vStartAngle	StartAngle of the slider
vEndAngle	EndAngle of the slider
iValue	Current value of the slider
iMin	Minimum value of the slider
iMax	Maximum value of the slider
uiStepSize	The step size in units of the range
eBase	Steps are based at minimum or maximum.
eID	Object identifier of this slider (chose NO_HANDLE if none is required)

CGUICircularSlider() [2/2]

CGUICircularSlider::CGUICircularSlider

(

)

Standard constructor. Only to be called by factory. No user code should call this constructor, not even in streaming mode (that is, when GUILIANI_STREAM_GUI is defined)!

See also

CGUICircularSlider()

Member Function Documentation

CalculateKnobRect()

void CGUICircularSlider::CalculateKnobRect

(

const eC_Int &

iValue

)

alculates the position of the knob based on its value Has no return. Just changes m_kKnobRect.

Parameters

iValue

value of our slider from Range class

DoButtonDown()

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

DoClick()

virtual eC_Bool CGUICircularSlider::DoClick ( const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

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.

Note

DoClick() 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 an object in a newer and probably intermediate state that he currently does not see. Thus, to calculate the relative position (where the mouse button was pressed and released at the same position for in a certain time span, 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 it always returns False.

Reimplemented from CGUIBehaviour.

DoDrag()

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

GetAngle()

eC_Value CGUICircularSlider::GetAngle	(	const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)

Gets angle of any x and y coordinates

Parameters

vAbsX	X-position in screen coordinates
vAbsY	Y-position in screen coordinates

Returns

vAngle

GetEndAngle()

eC_Value CGUICircularSlider::GetEndAngle

(

)

const

Returns the Angle at witch our slider ends.

Returns

m_vEndAngle.

GetKnobSize()

eC_Value CGUICircularSlider::GetKnobSize

(

)

const

gets the knobsize

Returns

knob-size

GetRadius()

eC_Value CGUICircularSlider::GetRadius

(

)

const

Returns the Circle radius.

Returns

m_vRadius.

GetSmoothControl()

eC_Bool CGUICircularSlider::GetSmoothControl

(

)

const

Return if smooth-control is set

Returns

True if smooth-control is active

GetStartAngle()

eC_Value CGUICircularSlider::GetStartAngle

(

)

const

Returns the Angle at witch our slider starts.

Returns

m_vStartAngle.

ReadFromStream()

virtual void CGUICircularSlider::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 CGUIAbstractBar.

SetEndAngle()

void CGUICircularSlider::SetEndAngle

(

const eC_Value &

vEndAngle

)

Sets End Angle of our slider track. Also calls - SetSliderTrackDistance();

Parameters

vEndAngle

the end angle of our slider starting from down middle and going left

SetImages()

void CGUICircularSlider::SetImages	(	const ImageResource_t &	eSldBG,
		const ImageResource_t &	eSldKnobNormal,
		const ImageResource_t &	eSldKnobHighlighted,
		const ImageResource_t &	eSldKnobPressed,
		const ImageResource_t &	eSldKnobGrayedOut = DUMMY_IMAGE
	)

SetImages Method to change the images used for the slider representation. The sizes of the knob images may differ. If the knob size varies from the supplied image's size, the image will automatically split into three portions. These are either a left/middle/right part for horizontal, or a top/middle/bottom part for vertical sliders. The left/top images will be constructed from the left/top half of the original image. Analogue, The right/bottom images will be constructor from the right/bottom half of the original image. The pixel row/column in the middle of the original image will be stretched to fill up the space, if the knob is to be displayed bigger than the original image.

Parameters

eSldBG	ID of background image
eSldKnobNormal	ID of image used to represent the normal state of the slider
eSldKnobHighlighted	ID of image used to represent the highlighted slider
eSldKnobPressed	ID of image used to represent the pressed slider
eSldKnobGrayedOut	ID of image used to represent the grayed out slider (compat: set to DUMMY_IMAGE)

SetKnobSize()

void CGUICircularSlider::SetKnobSize

(

const eC_Value &

vKnobSize

)

sets knob size

Parameters

vKnobSize

knob-size

SetRadius()

void CGUICircularSlider::SetRadius

(

const eC_Value &

vRadius

)

Sets Radius of our circle. Also calls - SetSliderTrackDistance();

Parameters

vRadius

the radius of our circular slider. must be equal or smaller than the half of the height or width of our object

SetRange()

void CGUICircularSlider::SetRange	(	const eC_Int &	iMin,
		const eC_Int &	iMax
	)

Sets the Range of CGUIAbstractBar class.

Parameters

iMin	minimal value
iMax	maximal value

SetSmoothControl()

void CGUICircularSlider::SetSmoothControl

(

const eC_Bool &

bSmoothControl

)

Sets smooth-control

Parameters

bSmoothControl

if true knob-position is not neccessarily set to values

SetStartAngle()

void CGUICircularSlider::SetStartAngle

(

const eC_Value &

vStartAngle

)

Sets Start Angle of our slider track. If start angle is bigger than EndAngle then slider will be in reverse

Parameters

vStartAngle

the starting angle of our slider beginning from down middle and going left

SetValue()

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

virtual

Sets Slider Value. Overrides SetValue function from Range class. may only be used outside of this class.

Parameters

rkValue

altrought the input parameter can be eC_Value(float) it is later converted to the int.

Returns

boolean

Reimplemented from CGUIAbstractBar.

WriteToStream()

virtual void CGUICircularSlider::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

bWriteClassID

This 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 CGUIAbstractBar.

---

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

• GUICircularSlider.h