メイン・コンテンツまでスキップ

LineProgress

touchgfx/containers/progress_indicators/LineProgress.hpp

Using Line from CanvasWidgetRenderer, progress will be rendered as a line. This means that the user must create a painter for painting the circle. The line does not need to horizontal or vertical, but can start at any coordinate and finish at any coordinate.

Note: As LineProgress uses CanvasWidgetRenderer, it is important that a buffer is set up by calling CanvasWidgetRendere::setBuffer().

Inherits from: AbstractProgressIndicator, Container, Drawable

Public Functions

virtual voidgetEnd(int & x, int & y) const
Gets the coordinates of the end point of the line.
virtual Line::LINE_ENDING_STYLEgetLineEndingStyle() const
Gets line ending style.
virtual intgetLineWidth() const
Gets the line width.
virtual voidgetStart(int & x, int & y) const
Gets the coordinates of the starting point of the line.
LineProgress()
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
virtual voidsetEnd(int x, int y)
Sets the end point for the line.
virtual voidsetLineEndingStyle(Line::LINE_ENDING_STYLE lineEndingStyle)
Sets line ending style.
virtual voidsetLineWidth(int width)
Sets the line width.
virtual voidsetPainter(AbstractPainter & painter)
Sets a painter to be used for drawing the line.
virtual voidsetProgressIndicatorPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the position and dimensions of the actual progress indicator relative to the background image.
virtual voidsetStart(int x, int y)
Sets a starting point for the line.
virtual voidsetValue(int value)
Sets the current value in the range (min..max) set by setRange().

Protected Attributes

CWRUtil::Q5endX
The end x coordinate.
CWRUtil::Q5endY
The end y coordinate.
Lineline
The line.
CWRUtil::Q5startX
The start x coordinate.
CWRUtil::Q5startY
The start y coordinate.

Additional inherited members

Public Functions inherited from AbstractProgressIndicator

AbstractProgressIndicator()
Initializes a new instance of the AbstractProgressIndicator class with a default range 0-100.
virtual uint8_tgetAlpha() const
Gets the current alpha value of the widget.
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 voidinvalidateContent() const
Tell the framework that the contents of the Drawable needs to be redrawn.
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.
boolanimationRunning
Is the animation running.
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 voidgetLastChildNear(int16_t x, int16_t y, Drawable * last, int16_t fingerAdjustmentX, int16_t * fingerAdjustmentY)
Works similar to getLastChild() but also considers the current set finger size in HAL.
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

voidcenter()
Centers the Drawable inside its parent.
voidcenterX()
Center the Drawable horizontally inside its parent.
voidcenterY()
Center the Drawable vertically inside its parent.
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.
voidexpand(int margin =0)
Expands the Drawable to have the same size as its parent with a given margin around the edge.
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 & event)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & event)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & event)
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 voidinvalidateContent() const
Tell the framework that the contents of the 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 & other)
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

getEnd

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

Gets the coordinates of the end point of the line.

Beware that this is not the coordinates of the current progress of the line, but the coordinates when the line is at 100%.

Parameters:
xThe x coordinate.
yThe y coordinate.

getLineEndingStyle

virtual Line::LINE_ENDING_STYLE getLineEndingStyle()const

Gets line ending style.

Returns:

The line ending style.

getLineWidth

virtual int getLineWidth()const

Gets the line width.

Returns:

The line width.

getStart

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

Gets the coordinates of the starting point of the line.

Parameters:
xThe x coordinate.
yThe y coordinate.

LineProgress

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:

Reimplements: touchgfx::AbstractProgressIndicator::setAlpha

setEnd

virtual void setEnd(intx ,
inty
)

Sets the end point for the line.

When progress is at 100%, the line will go from the coordinates set by setStart() to the coordinates set by setEnd()

Parameters:
xThe x coordinate of the end point.
yThe y coordinate of the end point.
See also:

setLineEndingStyle

virtual void setLineEndingStyle(Line::LINE_ENDING_STYLElineEndingStyle)

Sets line ending style.

Parameters:
lineEndingStyleThe line ending style.
See also:

setLineWidth

virtual void setLineWidth(intwidth)

Sets the line width.

Parameters:
widthThe width.
See also:

setPainter

virtual void setPainter(AbstractPainter &painter)

Sets a painter to be used for drawing the line.

This can be any Painter, a simple single color painter, a bitmap painter or a custom painter.

Parameters:
painterThe painter.

setProgressIndicatorPosition

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

Sets the position and dimensions of the actual progress indicator relative to the background image.

Parameters:
xThe x coordinate.
yThe y coordinate.
widthThe width of the box progress indicator.
heightThe height of the box progress indicator.
See also:

Reimplements: touchgfx::AbstractProgressIndicator::setProgressIndicatorPosition

setStart

virtual void setStart(intx ,
inty
)

Sets a starting point for the line.

Parameters:
xThe x coordinate of the start point.
yThe y coordinate of the start point.
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

Protected Attributes Documentation

endX

The end x coordinate.

endY

The end y coordinate.

line

Line line

The line.

startX

CWRUtil::Q5 startX

The start x coordinate.

startY

CWRUtil::Q5 startY

The start y coordinate.