Skip to main content
Version: 4.16

AbstractGraphElement

An abstract graph element. Declares a couple of useful functions to help subclasses which use CWR (CanvasWidget Renderer).

Inherits from: CanvasWidget, Widget, Drawable

Inherited by: AbstractGraphElementNoCWR, GraphElementArea, GraphElementDiamonds, GraphElementDots, GraphElementLine

Public Functions#

AbstractGraphElement()
intgetScale() const
Gets the scaling factor set using setScale.
virtual voidinvalidateGraphPointAt(int16_t index) =0
Invalidate the point at the given index.
voidsetScale(int scale)
Sets a scaling factor to be multiplied on each added element.

Protected Functions#

intconvertToGraphScale(const AbstractDataGraph * graph, int value, int scale) const
Converts a number with one scale to a number that has the same scale as the graph.
AbstractDataGraph *getGraph() const
Gets a pointer to the the graph containing the GraphElement.
intgetGraphRangeYMaxScaled(const AbstractDataGraph * graph) const
Gets maximum y coordinate for the graph.
intgetGraphRangeYMinScaled(const AbstractDataGraph * graph) const
Gets minimum y coordinate for the graph.
intgetGraphXAxisOffsetScaled(const AbstractDataGraph * graph) const
Get x axis offset as a scaled value.
intgetGraphXAxisScaleScaled(const AbstractDataGraph * graph) const
Get x axis scale as a scaled value.
CWRUtil::Q5indexToScreenXQ5(const AbstractDataGraph * graph, int16_t index) const
Gets screen x coordinate for a specific data point added to the graph.
CWRUtil::Q5indexToScreenYQ5(const AbstractDataGraph * graph, int16_t index) const
Gets screen y coordinate for a specific data point added to the graph.
boolisCenterInvisible(const AbstractDataGraph * graph, int16_t index) const
Query if the center of a given data point index is visible inside the graph area.
RectrectAround(CWRUtil::Q5 xQ5, CWRUtil::Q5 yQ5, CWRUtil::Q5 diameterQ5) const
Find the screen rectangle around a given point with the specified diameter.
RectrectFromQ5Coordinates(CWRUtil::Q5 screenXminQ5, CWRUtil::Q5 screenYminQ5, CWRUtil::Q5 screenXmaxQ5, CWRUtil::Q5 screenYmaxQ5) const
Find the screen rectangle containing the Q5 screen rectangle by rounding the coordinates up/down.
CWRUtil::Q5roundQ5(CWRUtil::Q5 q5) const
Round the given CWRUtil::Q5 to the nearest integer and return it as a CWRUtil::Q5 instead of an integer.
CWRUtil::Q5valueToScreenXQ5(const AbstractDataGraph * graph, int x) const
Gets graph screen x for x value.
CWRUtil::Q5valueToScreenYQ5(const AbstractDataGraph * graph, int y) const
Gets graph screen y for y value.
boolxScreenRangeToIndexRange(int16_t xLow, int16_t xHigh, int16_t & elementLow, int16_t & elementHigh) const
Gets graph element range for screen x coordinate range.

Protected Attributes#

intdataScale
The scaling factor.

Additional inherited members#

Public Functions inherited from CanvasWidget#

CanvasWidget()
virtual voiddraw(const Rect & invalidatedArea) const
Draws the given invalidated area.
virtual booldrawCanvasWidget(const Rect & invalidatedArea) const =0
Draw canvas widget for the given invalidated area.
virtual uint8_tgetAlpha() const
Gets the current alpha value of the widget.
virtual RectgetMinimalRect() const
Gets minimal rectangle containing the shape drawn by this widget.
virtual AbstractPainter &getPainter() const
Gets the current painter for the CanvasWidget.
virtual RectgetSolidRect() const
Gets the largest solid (non-transparent) rectangle.
virtual voidinvalidate() const
Invalidates the area covered by this CanvasWidget.
voidresetMaxRenderLines()
Resets the maximum render lines.
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
virtual voidsetPainter(AbstractPainter & painter)
Sets a painter for the CanvasWidget.

Public Functions inherited from Widget#

virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last)
Since a Widget is only one Drawable, Widget::getLastChild simply yields itself as result, but only if the Widget isVisible and isTouchable.

Public Functions inherited from Drawable#

virtual voidchildGeometryChanged()
This function can be called on parent nodes to signal that the size or position of one or more of its children has changed.
virtual voiddraw(const Rect & invalidatedArea) const =0
Draw this drawable.
Drawable()
Initializes a new instance of the Drawable class.
voiddrawToDynamicBitmap(BitmapId id)
Render the Drawable object into a dynamic bitmap.
RectgetAbsoluteRect() const
Helper function for obtaining the rectangle this Drawable covers, expressed in absolute coordinates.
virtual Drawable *getFirstChild()
Function for obtaining the first child of this drawable if any.
int16_tgetHeight() const
Gets the height of this Drawable.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last) =0
Function for obtaining the the last child of this drawable that intersects with the specified point.
Drawable *getNextSibling()
Gets the next sibling node.
Drawable *getParent() const
Returns the parent node.
const Rect &getRect() const
Gets the rectangle this Drawable covers, in coordinates relative to its parent.
virtual RectgetSolidRect() const =0
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual RectgetSolidRectAbsolute()
Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual voidgetVisibleRect(Rect & rect) const
Function for finding the visible part of this drawable.
int16_tgetWidth() const
Gets the width of this Drawable.
int16_tgetX() const
Gets the x coordinate of this Drawable, relative to its parent.
int16_tgetY() const
Gets the y coordinate of this Drawable, relative to its parent.
virtual voidhandleClickEvent(const ClickEvent & evt)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & evt)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & evt)
Defines the event handler interface for GestureEvents.
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual voidinvalidate() const
Tell the framework that this entire Drawable needs to be redrawn.
virtual voidinvalidateRect(Rect & invalidatedArea) const
Request that a region of this drawable is redrawn.
boolisTouchable() const
Gets whether this Drawable receives touch events or not.
boolisVisible() const
Gets whether this Drawable is visible.
virtual voidmoveRelative(int16_t x, int16_t y)
Moves the drawable.
virtual voidmoveTo(int16_t x, int16_t y)
Moves the drawable.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
voidsetPosition(const Drawable & drawable)
Sets the position of the Drawable to the same as the given Drawable.
voidsetPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the size and position of this Drawable, relative to its parent.
voidsetTouchable(bool touch)
Controls whether this Drawable receives touch events or not.
voidsetVisible(bool vis)
Controls whether this Drawable should be visible.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
voidsetWidthHeight(const Bitmap & bitmap)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Drawable & drawable)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Rect & rect)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(int16_t width, int16_t height)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual voidsetX(int16_t x)
Sets the x coordinate of this Drawable, relative to its parent.
voidsetXY(const Drawable & drawable)
Sets the x and y coordinates of this Drawable.
voidsetXY(int16_t x, int16_t y)
Sets the x and y coordinates of this Drawable, relative to its parent.
virtual voidsetY(int16_t y)
Sets the y coordinate of this Drawable, relative to its parent.
virtual voidtranslateRectToAbsolute(Rect & r) const
Helper function for converting a region of this Drawable to absolute coordinates.
virtual ~Drawable()
Finalizes an instance of the Drawable class.

Protected Attributes inherited from Drawable#

Drawable *nextSibling
Pointer to the next Drawable.
Drawable *parent
Pointer to this drawable's parent.
Rectrect
The coordinates of this Drawable, relative to its parent.
booltouchable
True if this drawable should receive touch events.
boolvisible
True if this drawable should be drawn.

Public Functions Documentation#

AbstractGraphElement#

getScale#

int getScale()const

Gets the scaling factor set using setScale.

Returns:

The scaling factor.

See also:

invalidateGraphPointAt#

virtual void invalidateGraphPointAt(int16_tindex)

setScale#

void setScale(intscale)

Sets a scaling factor to be multiplied on each added element.

Since only integer values are stored internally, it is possible to set a scale to e.g. 1000 and make elements work as if there are three digits of precision.

By setting the scale to 1 it is possible to simply use integer values for the graph.

Parameters:
scaleThe scaling factor.
Note

Calling setScale should be done as the first thing as any new scaling factor will not be applied to already set scaled values.

See also:

Protected Functions Documentation#

convertToGraphScale#

int convertToGraphScale(const AbstractDataGraph *graph ,const
intvalue ,const
intscaleconst
)const

Converts a number with one scale to a number that has the same scale as the graph.

Parameters:
valueThe value to convert.
scaleThe scale.
graphThe graph.
Returns:

The given data converted to the graph scale.

Note

For internal use.

getGraph#

AbstractDataGraph * getGraph()const

Gets a pointer to the the graph containing the GraphElement.

Returns:

A pointer to the graph.

getGraphRangeYMaxScaled#

Gets maximum y coordinate for the graph.

Parameters:
graphThe graph.
Returns:

The maximum y coordinate.

Note

The returned value is left scaled.For internal use.

See also:

getGraphRangeYMinScaled#

Gets minimum y coordinate for the graph.

Parameters:
graphThe graph.
Returns:

The minimum y coordinate.

Note

The returned value is left scaled.For internal use.

See also:

getGraphXAxisOffsetScaled#

Get x axis offset as a scaled value.

Parameters:
graphThe graph.
Returns:

The x axis offset (left scaled).

Note

For internal use.

getGraphXAxisScaleScaled#

Get x axis scale as a scaled value.

Parameters:
graphThe graph.
Returns:

The x axis scale (left scaled).

Note

For internal use.

indexToScreenXQ5#

CWRUtil::Q5 indexToScreenXQ5(const AbstractDataGraph *graph ,const
int16_tindexconst
)const

Gets screen x coordinate for a specific data point added to the graph.

Parameters:
graphThe graph.
indexThe index of the element to get the x coordinate for.
Returns:

The screen x coordinate for the specific data point.

indexToScreenYQ5#

CWRUtil::Q5 indexToScreenYQ5(const AbstractDataGraph *graph ,const
int16_tindexconst
)const

Gets screen y coordinate for a specific data point added to the graph.

Parameters:
graphThe graph.
indexThe index of the element to get the y coordinate for.
Returns:

The screen x coordinate for the specific data point.

isCenterInvisible#

bool isCenterInvisible(const AbstractDataGraph *graph ,const
int16_tindexconst
)const

Query if the center of a given data point index is visible inside the graph area.

Parameters:
graphThe graph.
indexThe data point index.
Returns:

True if center invisible, false if not.

rectAround#

Rect rectAround(CWRUtil::Q5xQ5 ,const
CWRUtil::Q5yQ5 ,const
CWRUtil::Q5diameterQ5const
)const

Find the screen rectangle around a given point with the specified diameter.

Parameters:
xQ5The screen x coordinate (in Q5).
yQ5The screen y coordinate (in Q5).
diameterQ5The diameter (in Q5).
Returns:

A Rect containing the point (and diameter).

rectFromQ5Coordinates#

Rect rectFromQ5Coordinates(CWRUtil::Q5screenXminQ5 ,const
CWRUtil::Q5screenYminQ5 ,const
CWRUtil::Q5screenXmaxQ5 ,const
CWRUtil::Q5screenYmaxQ5const
)const

Find the screen rectangle containing the Q5 screen rectangle by rounding the coordinates up/down.

Parameters:
screenXminQ5The minimum screen x coordinate (in Q5).
screenYminQ5The maximum screen y coordinate (in Q5).
screenXmaxQ5The minimum screen x coordinate (in Q5).
screenYmaxQ5The maximum screen y coordinate (in Q5).
Returns:

A Rect containing the Q5 rectangle.

roundQ5#

CWRUtil::Q5 roundQ5(CWRUtil::Q5q5)

Round the given CWRUtil::Q5 to the nearest integer and return it as a CWRUtil::Q5 instead of an integer.

Parameters:
q5The CWRUtil::Q5 value to round.
Returns:

The nearest integer as a CWRUtil::Q5 value.

valueToScreenXQ5#

CWRUtil::Q5 valueToScreenXQ5(const AbstractDataGraph *graph ,const
intxconst
)const

Gets graph screen x for x value.

Parameters:
graphThe graph.
xThe x value.
Returns:

The graph screen x for value.

valueToScreenYQ5#

CWRUtil::Q5 valueToScreenYQ5(const AbstractDataGraph *graph ,const
intyconst
)const

Gets graph screen y for y value.

Parameters:
graphThe graph.
yThe y value.
Returns:

The graph screen y for value.

xScreenRangeToIndexRange#

bool xScreenRangeToIndexRange(int16_txLow ,const
int16_txHigh ,const
int16_t &elementLow ,const
int16_t &elementHighconst
)const

Gets graph element range for screen x coordinate range.

Parameters:
xLowThe low.
xHighThe high.
elementLowThe element low.
elementHighThe element high.
Returns:

True if it succeeds, false if it fails.

Protected Attributes Documentation#

dataScale#

int dataScale

The scaling factor.