Skip to main content
Version: 4.16

Gauge

A gauge is a graphical element that shows a needle on a dial, often a speedometer or similar. Much like a progress indicator, the minimum and maximum value of the Gauge, as well as steps can be set. For more information on this, consult the documentation on ProgressIndicators.

A Gauge has a needle and optionally an arc that follows the needle.

Inherits from: AbstractProgressIndicator, Container, Drawable

Public Functions#

Gauge()
Initializes a new instance of the Gauge class.
virtual uint8_tgetAlpha() const
Gets the current alpha value of the widget.
Circle &getArc()
Gets a reference to the arc (Circle).
virtual voidgetCenter(int & x, int & y) const
Gets the texture mapper center coordinates.
virtual intgetEndAngle() const
Gets end angle.
virtual intgetStartAngle() const
Gets start angle for the needle (and arc).
voidputArcOnTop(bool arcOnTop =true)
Shows the arc on top of the needle.
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
voidsetArcPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets arc position inside the Gauge.
voidsetArcVisible(bool show =true)
Allow the arc to be shown or hidden.
voidsetBackgroundOffset(int16_t offsetX, int16_t offsetY)
Sets background offset inside the Gauge.
virtual voidsetCenter(int x, int y)
Sets the center of the texture mapper and the arc inside the Gauge.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
voidsetMovingNeedleRenderingAlgorithm(TextureMapper::RenderingAlgorithm algorithm)
Sets rendering algorithm used when the needle is moving during an animation.
voidsetNeedle(const BitmapId bitmapId, int16_t rotationCenterX, int16_t rotationCenterY)
Sets a bitmap for the needle and the rotation point in the needle bitmap.
virtual voidsetStartEndAngle(int startAngle, int endAngle)
Sets start and end angle for the needle and arc.
voidsetSteadyNeedleRenderingAlgorithm(TextureMapper::RenderingAlgorithm algorithm)
Sets rendering algorithm used when the needle is steady (after an animation).
virtual voidsetValue(int value)
Sets the current value in the range (min..max) set by setRange().
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.

Protected Functions#

virtual voidsetProgressIndicatorPosition(int16_t x, int16_t y, int16_t width, int16_t height)
This function has no effect on a Gauge.
voidsetupNeedleTextureMapper()
Sets up the needle texture mapper.

Protected Attributes#

TextureMapper::RenderingAlgorithmalgorithmMoving
The algorithm used when the needle is moving.
TextureMapper::RenderingAlgorithmalgorithmSteady
The algorithm used when the needle is steady.
Circlearc
The arc.
int16_tgaugeCenterX
The x coordinate of the rotation point of the hands.
int16_tgaugeCenterY
The y coordinate of the rotation point of the hands.
TextureMapperneedle
The textureMapper.
int16_tneedleCenterX
The x coordinate of the rotation point of the hands.
int16_tneedleCenterY
The y coordinate of the rotation point of the hands.
intneedleEndAngle
The end angle.
intneedleStartAngle
The start angle.

Additional inherited members#

Public Functions inherited from AbstractProgressIndicator#

AbstractProgressIndicator()
Initializes a new instance of the AbstractProgressIndicator class with a default range 0-100.
virtual uint16_tgetProgress(uint16_t range =100) const
Gets the current progress based on the range set by setRange() and the value set by setValue().
virtual int16_tgetProgressIndicatorHeight() const
Gets progress indicator height.
virtual int16_tgetProgressIndicatorWidth() const
Gets progress indicator width.
virtual int16_tgetProgressIndicatorX() const
Gets progress indicator x coordinate.
virtual int16_tgetProgressIndicatorY() const
Gets progress indicator y coordinate.
virtual voidgetRange(int & min, int & max) const
Gets the range set by setRange().
virtual voidgetRange(int & min, int & max, uint16_t & steps) const
Gets the range set by setRange().
virtual voidgetRange(int & min, int & max, uint16_t & steps, uint16_t & minStep) const
Gets the range set by setRange().
virtual intgetValue() const
Gets the current value set by setValue().
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual voidsetBackground(const Bitmap & bitmapBackground)
Sets the background image.
virtual voidsetEasingEquation(EasingEquation easingEquation)
Sets easing equation to be used in updateValue.
virtual voidsetRange(int min, int max, uint16_t steps =0, uint16_t minStep =0)
Sets the range for the progress indicator.
voidsetValueSetAction(GenericCallback< const AbstractProgressIndicator & > & callback)
Sets callback that will be triggered every time a new value is assigned to the progress indicator.
voidsetValueUpdatedAction(GenericCallback< const AbstractProgressIndicator & > & callback)
Sets callback that will be triggered when updateValue has finished animating to the final value.
virtual voidupdateValue(int value, uint16_t duration)
Update the current value in the range (min..max) set by setRange().

Protected Attributes inherited from AbstractProgressIndicator#

intanimationDuration
Duration of the animation.
intanimationEndValue
The animation end value.
intanimationStartValue
The animation start value.
intanimationStep
The current animation step.
Imagebackground
The background image.
intcurrentValue
The current value.
EasingEquationequation
The equation used in updateValue()
ContainerprogressIndicatorContainer
The container that holds the actual progress indicator.
intrangeMax
The range maximum.
intrangeMin
The range minimum.
uint16_trangeSteps
The range steps.
uint16_trangeStepsMin
The range steps minimum.
GenericCallback< const AbstractProgressIndicator & > *valueSetCallback
New value assigned Callback.
GenericCallback< const AbstractProgressIndicator & > *valueUpdatedCallback
Animation ended Callback.

Public Functions inherited from Container#

virtual voidadd(Drawable & d)
Adds a Drawable instance as child to this Container.
Container()
virtual boolcontains(const Drawable & d)
Query if a given Drawable has been added directly to this Container.
virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
virtual voidforEachChild(GenericCallback< Drawable & > * function)
Executes the specified callback function for each child in the Container.
virtual Drawable *getFirstChild()
Obtain a pointer to the first child of this container.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last)
Gets the last child in the list of children in this Container.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual voidinsert(Drawable * previous, Drawable & d)
Inserts a Drawable after a specific child node.
virtual voidremove(Drawable & d)
Removes a Drawable from the container by removing it from the linked list of children.
virtual voidremoveAll()
Removes all children in the Container by resetting their parent and sibling pointers.
virtual voidunlink()
Removes all children by unlinking the first child.

Protected Functions inherited from Container#

virtual RectgetContainedArea() const
Gets a rectangle describing the total area covered by the children of this container.
virtual voidmoveChildrenRelative(int16_t deltaX, int16_t deltaY)
Calls moveRelative on all children.

Protected Attributes inherited from Container#

Drawable *firstChild
Pointer to the first child of this container. Subsequent children can be found through firstChild's nextSibling.

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

Gauge#

Initializes a new instance of the Gauge class.

getAlpha#

virtual uint8_t getAlpha()const

Gets the current alpha value of the widget.

The alpha value is in range 255 (solid) to 0 (invisible).

Returns:

The current alpha value.

See also:

getArc#

Circle & getArc()

Gets a reference to the arc (Circle).

This allows for setting radius, line width, painter, etc. on the arc (Circle).

Returns:

The arc (Circle).

getCenter#

virtual void getCenter(int &x ,const
int &yconst
)const

Gets the texture mapper center coordinates.

Parameters:
xThe x coordinate of the center of the texture mapper.
yThe y coordinate of the center of the texture mapper.
See also:

getEndAngle#

virtual int getEndAngle()const

Gets end angle.

Beware that the value returned is not related to the current progress of the texture mapper but rather the end point of the Gauge when it is at max value.

Returns:

The end angle.

See also:

getStartAngle#

virtual int getStartAngle()const

Gets start angle for the needle (and arc).

Returns:

The start angle.

See also:

putArcOnTop#

void putArcOnTop(boolarcOnTop =true)

Shows the arc on top of the needle.

By default the needle is drawn on top of the arc.

Parameters:
arcOnTop(Optional) True to put the arc on top of the needle (default), false to put the needle on top of the arc.

setAlpha#

virtual void setAlpha(uint8_tnewAlpha)

Sets the opacity (alpha value).

This can be used to fade it away by gradually decreasing the alpha value from 255 (solid) to 0 (invisible).

Parameters:
newAlphaThe new alpha value. 255=solid, 0=invisible.
Note

The user code must call invalidate() in order to update the display.

See also:

setArcPosition#

void setArcPosition(int16_tx ,
int16_ty ,
int16_twidth ,
int16_theight
)

Sets arc position inside the Gauge.

This is especially useful if the arc is using a bitmap painter. If the center has previously been set, the arc center will be updated to be at the same offset relative to the top left corner of the Gauge.

Parameters:
xThe x coordinate.
yThe y coordinate.
widthThe width.
heightThe height.
See also:

setArcVisible#

void setArcVisible(boolshow =true)

Allow the arc to be shown or hidden.

Parameters:
show(Optional) True to show, false to hide. Default is to show the arc.

setBackgroundOffset#

void setBackgroundOffset(int16_toffsetX ,
int16_toffsetY
)

Sets background offset inside the Gauge.

If the dial is smaller than the size needed for the Gauge to show the needle, the background image can be moved inside the Gauge.

Parameters:
offsetXThe offset x coordinate.
offsetYThe offset y coordinate.
See also:

setCenter#

virtual void setCenter(intx ,
inty
)

Sets the center of the texture mapper and the arc inside the Gauge.

Parameters:
xThe x coordinate of the center of the texture mapper.
yThe y coordinate of the center of the texture mapper.
See also:

setHeight#

virtual void setHeight(int16_theight)

Sets the height of this drawable.

Parameters:
heightThe new height.
Note

For most Drawable widgets, changing this does normally not automatically yield a redraw.

Reimplements: touchgfx::Drawable::setHeight

setMovingNeedleRenderingAlgorithm#

Sets rendering algorithm used when the needle is moving during an animation.

For better performance, this can be set to TextureMapper::NEAREST_NEIGHBOR. For nicer graphics, it should be set to TextureMapper::BILINEAR_INTERPOLATION (this is the default behavior).

Parameters:
algorithmThe algorithm.
See also:

setNeedle#

void setNeedle(const BitmapIdbitmapId ,
int16_trotationCenterX ,
int16_trotationCenterY
)

Sets a bitmap for the needle and the rotation point in the needle bitmap.

Parameters:
bitmapIdIdentifier for the bitmap.
rotationCenterXThe rotation center x coordinate.
rotationCenterYThe rotation center y coordinate.

setStartEndAngle#

virtual void setStartEndAngle(intstartAngle ,
intendAngle
)

Sets start and end angle for the needle and arc.

By swapping end and start angles, these can progress backwards.

Parameters:
startAngleThe start angle.
endAngleThe end angle.

setSteadyNeedleRenderingAlgorithm#

Sets rendering algorithm used when the needle is steady (after an animation).

For better performance, this can be set to TextureMapper::NEAREST_NEIGHBOR. For nicer graphics, it should be set to TextureMapper::BILINEAR_INTERPOLATION (this is the default behavior).

Parameters:
algorithmThe algorithm.
See also:

setValue#

virtual void setValue(intvalue)

Sets the current value in the range (min..max) set by setRange().

Values lower than min are mapped to min, values higher than max are mapped to max. If a callback function has been set using setValueSetAction, that callback will be called (unless the new value is the same as the current value).

Parameters:
valueThe value.
Note

if value is equal to the current value, nothing happens, and the callback will not be called.

See also:

Reimplements: touchgfx::AbstractProgressIndicator::setValue

setWidth#

virtual void setWidth(int16_twidth)

Sets the width of this drawable.

Parameters:
widthThe new width.
Note

For most Drawable widgets, changing this does normally not automatically yield a redraw.

Reimplements: touchgfx::Drawable::setWidth

Protected Functions Documentation#

setProgressIndicatorPosition#

virtual void setProgressIndicatorPosition(int16_tx ,
int16_ty ,
int16_twidth ,
int16_theight
)

This function has no effect on a Gauge.

Parameters:
xunused
yunused
widthunused
heightunused

Reimplements: touchgfx::AbstractProgressIndicator::setProgressIndicatorPosition

setupNeedleTextureMapper#

Sets up the needle texture mapper.

Protected Attributes Documentation#

algorithmMoving#

The algorithm used when the needle is moving.

algorithmSteady#

The algorithm used when the needle is steady.

arc#

Circle arc

The arc.

gaugeCenterX#

int16_t gaugeCenterX

The x coordinate of the rotation point of the hands.

gaugeCenterY#

int16_t gaugeCenterY

The y coordinate of the rotation point of the hands.

needle#

The textureMapper.

needleCenterX#

int16_t needleCenterX

The x coordinate of the rotation point of the hands.

needleCenterY#

int16_t needleCenterY

The y coordinate of the rotation point of the hands.

needleEndAngle#

int needleEndAngle

The end angle.

needleStartAngle#

int needleStartAngle

The start angle.