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

This control can be used to draw multiple function-graphs. Attributes for both axis and the visualization of data can be set. More...

#include <GUIGraph.h>

Inheritance diagram for CGUIGraph:

Public Member Functions

 CGUIGraph (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIGraph ()
 Default constructor.
 
 CGUIGraph (const CGUIGraph &kToBeCopied)
 
virtual eC_Bool DoDoubleClick (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 DoDraw ()
 
eC_UInt GetAxisColor () const
 
eC_Value GetAxisLineWidth () const
 
void GetAxisStyle (CGUICommonEnums::AxisStyle_t &eAxisStyleX, CGUICommonEnums::AxisStyle_t &eAxisStyleY) const
 
FontResource_t GetFontID () const
 
CGUICommonEnums::AxisAlignment_t GetHelperLines () const
 
eC_UInt GetHelperLinesColor () const
 
eC_Value GetHelperLineWidth () const
 
eC_Bool GetInteractive () const
 
void GetLabelSpacing (eC_UInt &uiLabelSpacingX, eC_UInt &uiLabelSpacingY) const
 
eC_UInt GetLineColor (const eC_UInt &uiIndex) const
 
eC_Value GetLineWidth () const
 
void GetLogBase (eC_UInt &uiLogBaseX, eC_UInt &uiLogBaseY)
 
void GetOffset (eC_Value &vOffsetX, eC_Value &vOffsetY) const
 
void GetScaling (eC_Value &vScalingX, eC_Value &vScalingY) const
 
eC_UInt GetValueSpacing () const
 
virtual eC_Bool IsHighlightable () const
 
CGUIGraphoperator= (const CGUIGraph &kSource)
 
virtual void ReadFromStream ()
 
void SetAxisColor (const eC_UInt &uiAxisColor)
 
void SetAxisColor (const GlobalProperty_t &eAxisColor)
 
void SetAxisLineWidth (const eC_Value &vAxisLineWidth)
 
void SetAxisStyle (const CGUICommonEnums::AxisStyle_t &eAxisStyleX, const CGUICommonEnums::AxisStyle_t &eAxisStyleY)
 
void SetFontID (const FontResource_t &eFontID)
 
void SetFunction (const eC_UInt &uiIndex, CGUIGraphFunction *pkFunction)
 
void SetHelperLines (const CGUICommonEnums::AxisAlignment_t &eHelperLines)
 
void SetHelperLinesColor (const eC_UInt &uiHelperLinesColor)
 
void SetHelperLinesColor (const GlobalProperty_t &eHelperLinesColor)
 
void SetHelperLineWidth (const eC_Value &vHelperLineWidth)
 
void SetInteractive (const eC_Bool &bInteractive)
 
void SetLabelSpacing (const eC_UInt &uiLabelSpacingX, const eC_UInt &uiLabelSpacingY)
 
void SetLineColor (const eC_UInt &uiIndex, const eC_UInt &uiLineColor)
 
void SetLineColor (const eC_UInt &uiIndex, const GlobalProperty_t &eLineColor)
 
void SetLineWidth (const eC_Value &vLineWidth)
 
void SetLogBase (const eC_UInt &uiLogBaseX, const eC_UInt &uiLogBaseY)
 
void SetOffset (const eC_Value &vOffsetX, const eC_Value &vOffsetY)
 
void SetScaling (const eC_Value &vScalingX, const eC_Value &vScalingY)
 
void SetValueSpacing (const eC_UInt &uiValueSpacing)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIObject
 CGUIObject (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (CGUICompositeObject *const pParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject ()
 
 CGUIObject (const CGUIObject &kSource)
 
virtual ~CGUIObject ()
 
void AddValueObserver (CGUIObserver *pObserver)
 
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 DoDrawSnapshot ()
 
virtual void EnableSnapshotDrawing ()
 
virtual CGUIObjectFindObject (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
 
CGUIBehaviourDecoratorGetBehaviour ()
 
const CGUIBehaviourDecoratorGetBehaviour () const
 
GUIBitmapPlaneID_t GetBitmapID () const
 
CGUIBitmapPlaneGetBitmapPlane () 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
 
CDataPoolConnectorGetDataPoolConnector ()
 
eC_Value GetDistanceBottom () const
 
eC_Value GetDistanceRight () const
 
eC_Value GetHalfHeight () const
 
eC_Value GetHalfWidth () const
 
eC_Value GetHeight () const
 
ObjectHandle_t GetID () const
 
CGUILayouterGetLayouter ()
 
const CGUILayouterGetLayouter () const
 
ObjectHandle_t GetNeighborBottomID () const
 
ObjectHandle_t GetNeighborLeftID () const
 
ObjectHandle_t GetNeighborRightID () const
 
ObjectHandle_t GetNeighborTopID () const
 
CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)
 
const CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const
 
CGUIRect GetOriginRect () const
 
CGUICompositeObjectGetParent ()
 
const CGUICompositeObjectGetParent () 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
 
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)
 
CGUIObjectoperator= (const CGUIObject &kSource)
 
virtual void RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
 
void RemoveValueObserver (CGUIObserver *pObserver)
 
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 *pBehaviour)
 
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 pParent)
 
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 (const CGUIValue &rkValue)
 
virtual eC_Bool SetValue (CDataPoolEntry &rkValue)
 
virtual void SetWidth (const eC_Value &vX)
 
- 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 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 DoButtonDown (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoButtonUp (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDragEnd (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseEnter (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseLeave (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual void GetFocus ()
 
virtual void LoseFocus ()
 
virtual eC_Bool Decrease ()
 
virtual eC_Bool Increase ()
 
virtual eC_Bool DoKeyDown (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoKeyUp (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool 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
 
void SetXMLTag (const eC_String &kXMLTag)
 
- 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 ()
 
- Public Member Functions inherited from CGUIColorPropertyObserver
 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.
 
void RemoveColorProperty (const eC_UInt &uiIndex)
 
void SetColorProperty (const eC_UInt &uiIndex, const eC_UInt &uiColorValue)
 
void SetColorProperty (const eC_UInt &uiIndex, const GlobalProperty_t &eColorProperty)
 
void SetColorProperty (const eC_UInt &uiIndex, const ColorValue_t &kColorValue)
 
- Public Member Functions inherited from CGUIObserver
 CGUIObserver ()
 Default constructor.
 
virtual ~CGUIObserver ()
 Default destructor. Notifies all subjects of destruction.
 
const eC_TListDoubleLinked< CGUISubject * > & GetSubjectList () const
 
virtual void OnNotification (const eC_String &kMessage)
 
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)
 
void SetAutoDelete (const eC_Bool bAutoDelete)
 

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 [] = "Alpha"
 XML tag to be used writing alpha-value into a stream.
 
static const eC_Char XMLTAG_CLICKTHROUGH [] = "ClickThrough"
 XML tag to be used writing clickthrough-state into a stream.
 
static const eC_Char XMLTAG_CONTROLCLASSID [] = "ControlClassID"
 XML tag to be used when writing a control class ID into a stream.
 
static const eC_Char XMLTAG_DISABLED [] = "Disabled"
 XML tag to be used writing disabled-state into a stream.
 
static const eC_Char XMLTAG_FOCUSSABLE [] = "Focussable"
 XML tag to be used writing focussable-state into a stream.
 
static const eC_Char XMLTAG_GRAYEDOUT [] = "GrayedOut"
 XML tag to be used writing grayedout-state into a stream.
 
static const eC_Char XMLTAG_HEIGHT [] = "Height"
 XML tag to be used writing height into a stream.
 
static const eC_Char XMLTAG_INVISIBLE [] = "Invisible"
 XML tag to be used writing invisible-state into a stream.
 
static const eC_Char XMLTAG_OBJECTID [] = "ObjectID"
 XML tag to be used writing object id into a stream.
 
static const eC_Char XMLTAG_OVERRIDDENNEIGHBORS [] = "OverriddenNeighbors"
 XML tag to be used writing overridden neighbors into a stream.
 
static const eC_Char XMLTAG_WIDTH [] = "Width"
 XML tag to be used writing width into a stream.
 
static const eC_Char XMLTAG_XPOS [] = "XPos"
 XML tag to be used writing x-position into a stream.
 
static const eC_Char XMLTAG_YPOS [] = "YPos"
 XML tag to be used writing y-position into a stream.
 
- Static Public Attributes inherited from CGUIBehaviour
static const eC_Char XMLTAG_BEHAVIOURCLASSID [] = "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 [] = "ClassVersion"
 
- Protected Member Functions inherited from CGUIObject
virtual eC_Bool CreateBitmapPlane ()
 
virtual eC_Bool FourWayNext (FourWayFocus_t eFocusDirection)
 
- Protected Member Functions inherited from CGUIStreamableObject
eC_UInt ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const
 
void WriteStreamingFooter (const eC_Bool &bWriteClassID) const
 
void WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const
 
- Protected Member Functions inherited from CGUIObserver
virtual void AddSubject (CGUISubject *pSubjectToAdd)
 
virtual void RemoveSubject (CGUISubject *pSubjectToRemove)
 

Detailed Description

This control can be used to draw multiple function-graphs. Attributes for both axis and the visualization of data can be set.

With SetFunction() the corresponding functions can be set which will be called when redrawing the graphs.

The functions must implement CGUIGraphFunction.

Constructor & Destructor Documentation

◆ CGUIGraph() [1/2]

CGUIGraph::CGUIGraph ( CGUICompositeObject *const  pParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const ObjectHandle_t eID = NO_HANDLE 
)

Constructor.

Parameters
pParentPointer to the designated parent object.
vXX-position relative to its parent object, i.e. the x-offset from the left border of the parent object
vYY-position relative to its parent object, i.e. the y-offset from the upper border of the parent object
vWidthWidth of the object
vHeightHeight of the object
eIDObject identifier of this object (choose NO_HANDLE if none is required).

◆ CGUIGraph() [2/2]

CGUIGraph::CGUIGraph ( const CGUIGraph kToBeCopied)

Copy constructor

Parameters
kToBeCopied

Member Function Documentation

◆ DoDoubleClick()

eC_Bool CGUIGraph::DoDoubleClick ( const eC_Value &  vAbsX,
const eC_Value &  vAbsY 
)
virtual

Called when an object is clicked twice within a given time span.

See also
CGUIEventHandler::SetDoubleClickTime()
Note
DoDoubleClick() 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 two clicks were done relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().
Parameters
vAbsXX-position in screen coordinates where the click occurred
vAbsYY-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()

eC_Bool CGUIGraph::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
vDeltaXrelative movement in x-direction since the last call of DoDrag/ButtonDown
vDeltaYrelative movement in y-direction since the last call of DoDrag/ButtonDown
vAbsXcurrent X-position in screen coordinates of the mouse
vAbsYcurrent Y-position in screen coordinates of the mouse
Returns
True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoDraw()

eC_Bool CGUIGraph::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.

◆ GetAxisColor()

eC_UInt CGUIGraph::GetAxisColor ( ) const

Return the color for the axis as a value

Returns
color of axis

◆ GetAxisLineWidth()

eC_Value CGUIGraph::GetAxisLineWidth ( ) const

Return the line-width for the axis

Returns
line-width

◆ GetAxisStyle()

void CGUIGraph::GetAxisStyle ( CGUICommonEnums::AxisStyle_t eAxisStyleX,
CGUICommonEnums::AxisStyle_t eAxisStyleY 
) const

Get the axis-style of the y-axis

Parameters
eAxisStyleX
eAxisStyleY

◆ GetFontID()

FontResource_t CGUIGraph::GetFontID ( ) const

Return the font used for the labels

Returns
font-id

◆ GetHelperLines()

CGUICommonEnums::AxisAlignment_t CGUIGraph::GetHelperLines ( ) const

Return alignment of helper-lines

Returns
alignment

◆ GetHelperLinesColor()

eC_UInt CGUIGraph::GetHelperLinesColor ( ) const

Return the color for the helper-lines as a value

Returns
color of helper-lines

◆ GetHelperLineWidth()

eC_Value CGUIGraph::GetHelperLineWidth ( ) const

Return the line-width for the helper-lines

Returns
line-width

◆ GetInteractive()

eC_Bool CGUIGraph::GetInteractive ( ) const

Get interactive-mode

Returns
true if interactive-mode is set, else false

◆ GetLabelSpacing()

void CGUIGraph::GetLabelSpacing ( eC_UInt &  uiLabelSpacingX,
eC_UInt &  uiLabelSpacingY 
) const

Return current spacing for y-axis

Parameters
uiLabelSpacingXspacing for x-axis in pixels
uiLabelSpacingYspacing for y-axis in pixels

◆ GetLineColor()

eC_UInt CGUIGraph::GetLineColor ( const eC_UInt &  uiIndex) const

Return the color for graph at specified index

Parameters
uiIndexindex of graph
Returns
color as value

◆ GetLineWidth()

eC_Value CGUIGraph::GetLineWidth ( ) const

Return the line-width for the plotted graph

Returns
line-width

◆ GetLogBase()

void CGUIGraph::GetLogBase ( eC_UInt &  uiLogBaseX,
eC_UInt &  uiLogBaseY 
)

Return base for logarithmic scale

Parameters
uiLogBaseXbase for x-axis
uiLogBaseYbase for y-axis

◆ GetOffset()

void CGUIGraph::GetOffset ( eC_Value &  vOffsetX,
eC_Value &  vOffsetY 
) const

Return the offset for Y-axis

Parameters
vOffsetXoffset in pixels for x-axis
vOffsetYoffset in pixels for y-axis

◆ GetScaling()

void CGUIGraph::GetScaling ( eC_Value &  vScalingX,
eC_Value &  vScalingY 
) const

Return the currently active scaling

Parameters
vScalingX
vScalingY

◆ GetValueSpacing()

eC_UInt CGUIGraph::GetValueSpacing ( ) const

Return current value-spacing for y-axis

Returns
uiValueSpacingX value-spacing in pixels

◆ IsHighlightable()

virtual eC_Bool CGUIGraph::IsHighlightable ( ) const
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:

  • invisible
  • grayed-out
  • disabled if so the return value will be true. NOTE: when an object is not highlightable, it will never receive DoMouseEnter and DoMouseLeave-events
    Returns
    True if highlightable, False otherwise

Reimplemented from CGUIObject.

◆ operator=()

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

Assignment constructor

Parameters
kSource
Returns
copy

◆ ReadFromStream()

void CGUIGraph::ReadFromStream ( )
virtual

Reads all object 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.

◆ SetAxisColor() [1/2]

void CGUIGraph::SetAxisColor ( const eC_UInt &  uiAxisColor)

Set the color for the axis as a value

Parameters
uiAxisColor

◆ SetAxisColor() [2/2]

void CGUIGraph::SetAxisColor ( const GlobalProperty_t eAxisColor)

Set the color for the axis as a property

Parameters
eAxisColor

◆ SetAxisLineWidth()

void CGUIGraph::SetAxisLineWidth ( const eC_Value &  vAxisLineWidth)

Set the width for the axis-lines

Parameters
vAxisLineWidthline-width

◆ SetAxisStyle()

void CGUIGraph::SetAxisStyle ( const CGUICommonEnums::AxisStyle_t eAxisStyleX,
const CGUICommonEnums::AxisStyle_t eAxisStyleY 
)

Set the axis-style for the y-axis

Parameters
eAxisStyleX
eAxisStyleY

◆ SetFontID()

void CGUIGraph::SetFontID ( const FontResource_t eFontID)

Set the font used for labeling the axis

Parameters
eFontID

◆ SetFunction()

void CGUIGraph::SetFunction ( const eC_UInt &  uiIndex,
CGUIGraphFunction pkFunction 
)

Set function for graph at specified index

Parameters
uiIndexindex of graph
pkFunctionfunction for graph

◆ SetHelperLines()

void CGUIGraph::SetHelperLines ( const CGUICommonEnums::AxisAlignment_t eHelperLines)

Set visibility of helper-lines

Parameters
eHelperLines

◆ SetHelperLinesColor() [1/2]

void CGUIGraph::SetHelperLinesColor ( const eC_UInt &  uiHelperLinesColor)

Set the color for the helper-lines as a value

Parameters
uiHelperLinesColor

◆ SetHelperLinesColor() [2/2]

void CGUIGraph::SetHelperLinesColor ( const GlobalProperty_t eHelperLinesColor)

Set the color for the helper-lines as a property

Parameters
eHelperLinesColor

◆ SetHelperLineWidth()

void CGUIGraph::SetHelperLineWidth ( const eC_Value &  vHelperLineWidth)

Set the width for the helper-lines

Parameters
vHelperLineWidthline-width

◆ SetInteractive()

void CGUIGraph::SetInteractive ( const eC_Bool &  bInteractive)

Set interactive-mode. If true it will be possible to move the area of the control currently displayed by dragging the mouse. a double-click will reset to the center of the view.

Parameters
bInteractive

◆ SetLabelSpacing()

void CGUIGraph::SetLabelSpacing ( const eC_UInt &  uiLabelSpacingX,
const eC_UInt &  uiLabelSpacingY 
)

Set spacing for the labels in pixels

Parameters
uiLabelSpacingXspacing for x-axis in pixels
uiLabelSpacingYspacing for y-axis in pixels

◆ SetLineColor() [1/2]

void CGUIGraph::SetLineColor ( const eC_UInt &  uiIndex,
const eC_UInt &  uiLineColor 
)

Set the color for graph at specified index to color

Parameters
uiIndexindex of graph
uiLineColorcolor as value

◆ SetLineColor() [2/2]

void CGUIGraph::SetLineColor ( const eC_UInt &  uiIndex,
const GlobalProperty_t eLineColor 
)

Set the color for graph at specified index to color

Parameters
uiIndexindex of graph
eLineColorcolor as property

◆ SetLineWidth()

void CGUIGraph::SetLineWidth ( const eC_Value &  vLineWidth)

Set the width for the plotted graph

Parameters
vLineWidthline-width

◆ SetLogBase()

void CGUIGraph::SetLogBase ( const eC_UInt &  uiLogBaseX,
const eC_UInt &  uiLogBaseY 
)

Set base for logarithmic scale

Parameters
uiLogBaseXbase for x-axis
uiLogBaseYbase for y-axis

◆ SetOffset()

void CGUIGraph::SetOffset ( const eC_Value &  vOffsetX,
const eC_Value &  vOffsetY 
)

Set offset for Y-axis This is the number of pixels the center is moved in horizontal/vertical direction.

Parameters
vOffsetXoffset in pixels for x-axis
vOffsetYoffset in pixels for y-axis

◆ SetScaling()

void CGUIGraph::SetScaling ( const eC_Value &  vScalingX,
const eC_Value &  vScalingY 
)

Set the scaling for the axis in pixels per value A setting of 10.0 will plot a value every 10 pixels. A setting below 1.0 for the x-axis is not accepted. The scaling for the x-axis is also used to display the scale

Parameters
vScalingXscaling for x-axis
vScalingYscaling for y-axis

◆ SetValueSpacing()

void CGUIGraph::SetValueSpacing ( const eC_UInt &  uiValueSpacing)

Set spacing for the values in pixels The spacing will be used avoid calculating every value for the function. Instead the calculation will only be done in intervals of this value in pixels

Parameters
uiValueSpacingvalue spacing in pixels

◆ WriteToStream()

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

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

Parameters
bWriteClassIDThis flag is used to select if writing of ControlID, leading and trailing tags is performed.

Reimplemented from CGUIObject.


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