AbstractProgressIndicator

touchgfx/containers/progress_indicators/AbstractProgressIndicator.hpp

The AbstractProgressIndicator declares methods that provides the basic mechanisms and tools to implement a progress indicator. For more specific implementations see classes that inherit from AbstractProgressIndicator.

See: BoxProgress, CircleProgress, ImageProgress, LineProgress, TextProgress

Inherits from: Container, Drawable

Inherited by: AbstractDirectionProgress, CircleProgress, Gauge, LineProgress, TextProgress

Public Functions

	AbstractProgressIndicator()
	Initializes a new instance of the AbstractProgressIndicator class with a default range 0-100.
virtual uint8_t	getAlpha() const
	Gets the current alpha value of the widget.
virtual uint16_t	getProgress(uint16_t range =100) const
	Gets the current progress based on the range set by setRange() and the value set by setValue().
virtual int16_t	getProgressIndicatorHeight() const
	Gets progress indicator height.
virtual int16_t	getProgressIndicatorWidth() const
	Gets progress indicator width.
virtual int16_t	getProgressIndicatorX() const
	Gets progress indicator x coordinate.
virtual int16_t	getProgressIndicatorY() const
	Gets progress indicator y coordinate.
virtual void	getRange(int & min, int & max) const
	Gets the range set by setRange().
virtual void	getRange(int & min, int & max, uint16_t & steps) const
	Gets the range set by setRange().
virtual void	getRange(int & min, int & max, uint16_t & steps, uint16_t & minStep) const
	Gets the range set by setRange().
virtual int	getValue() const
	Gets the current value set by setValue().
virtual void	handleTickEvent()
	Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual void	invalidateContent() const
	Tell the framework that the contents of the Drawable needs to be redrawn.
virtual void	setAlpha(uint8_t newAlpha)
	Sets the opacity (alpha value).
virtual void	setBackground(const Bitmap & bitmapBackground)
	Sets the background image.
virtual void	setEasingEquation(EasingEquation easingEquation)
	Sets easing equation to be used in updateValue.
virtual void	setProgressIndicatorPosition(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 void	setRange(int min, int max, uint16_t steps =0, uint16_t minStep =0)
	Sets the range for the progress indicator.
virtual void	setValue(int value)
	Sets the current value in the range (min..max) set by setRange().
void	setValueSetAction(GenericCallback< const AbstractProgressIndicator & > & callback)
	Sets callback that will be triggered every time a new value is assigned to the progress indicator.
void	setValueUpdatedAction(GenericCallback< const AbstractProgressIndicator & > & callback)
	Sets callback that will be triggered when updateValue has finished animating to the final value.
virtual void	updateValue(int value, uint16_t duration)
	Update the current value in the range (min..max) set by setRange().

Protected Attributes

int	animationDuration
	Duration of the animation.
int	animationEndValue
	The animation end value.
bool	animationRunning
	Is the animation running.
int	animationStartValue
	The animation start value.
int	animationStep
	The current animation step.
Image	background
	The background image.
int	currentValue
	The current value.
EasingEquation	equation
	The equation used in updateValue()
Container	progressIndicatorContainer
	The container that holds the actual progress indicator.
int	rangeMax
	The range maximum.
int	rangeMin
	The range minimum.
uint16_t	rangeSteps
	The range steps.
uint16_t	rangeStepsMin
	The range steps minimum.
GenericCallback< const AbstractProgressIndicator & > *	valueSetCallback
	New value assigned Callback.
GenericCallback< const AbstractProgressIndicator & > *	valueUpdatedCallback
	Animation ended Callback.

Additional inherited members

Public Functions inherited from Container

virtual void	add(Drawable & d)
	Adds a Drawable instance as child to this Container.
	Container()
virtual bool	contains(const Drawable & d)
	Query if a given Drawable has been added directly to this Container.
virtual void	draw(const Rect & invalidatedArea) const
	Draw this drawable.
virtual void	forEachChild(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 void	getLastChild(int16_t x, int16_t y, Drawable ** last)
	Gets the last child in the list of children in this Container.
virtual void	getLastChildNear(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 Rect	getSolidRect() const
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual void	insert(Drawable * previous, Drawable & d)
	Inserts a Drawable after a specific child node.
virtual void	remove(Drawable & d)
	Removes a Drawable from the container by removing it from the linked list of children.
virtual void	removeAll()
	Removes all children in the Container by resetting their parent and sibling pointers.
virtual void	unlink()
	Removes all children by unlinking the first child.

Protected Functions inherited from Container

virtual Rect	getContainedArea() const
	Gets a rectangle describing the total area covered by the children of this container.
virtual void	moveChildrenRelative(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

void	center()
	Centers the Drawable inside its parent.
void	centerX()
	Center the Drawable horizontally inside its parent.
void	centerY()
	Center the Drawable vertically inside its parent.
virtual void	childGeometryChanged()
	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 void	draw(const Rect & invalidatedArea) const =0
	Draw this drawable.
	Drawable()
	Initializes a new instance of the Drawable class.
void	drawToDynamicBitmap(BitmapId id)
	Render the Drawable object into a dynamic bitmap.
void	expand(int margin =0)
	Expands the Drawable to have the same size as its parent with a given margin around the edge.
Rect	getAbsoluteRect() 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_t	getHeight() const
	Gets the height of this Drawable.
virtual void	getLastChild(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 Rect	getSolidRect() const =0
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual Rect	getSolidRectAbsolute()
	Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual void	getVisibleRect(Rect & rect) const
	Function for finding the visible part of this drawable.
int16_t	getWidth() const
	Gets the width of this Drawable.
int16_t	getX() const
	Gets the x coordinate of this Drawable, relative to its parent.
int16_t	getY() const
	Gets the y coordinate of this Drawable, relative to its parent.
virtual void	handleClickEvent(const ClickEvent & event)
	Defines the event handler interface for ClickEvents.
virtual void	handleDragEvent(const DragEvent & event)
	Defines the event handler interface for DragEvents.
virtual void	handleGestureEvent(const GestureEvent & event)
	Defines the event handler interface for GestureEvents.
virtual void	invalidate() const
	Tell the framework that this entire Drawable needs to be redrawn.
virtual void	invalidateRect(Rect & invalidatedArea) const
	Request that a region of this drawable is redrawn.
bool	isTouchable() const
	Gets whether this Drawable receives touch events or not.
bool	isVisible() const
	Gets whether this Drawable is visible.
virtual void	moveRelative(int16_t x, int16_t y)
	Moves the drawable.
virtual void	moveTo(int16_t x, int16_t y)
	Moves the drawable.
virtual void	setHeight(int16_t height)
	Sets the height of this drawable.
void	setPosition(const Drawable & drawable)
	Sets the position of the Drawable to the same as the given Drawable.
void	setPosition(int16_t x, int16_t y, int16_t width, int16_t height)
	Sets the size and position of this Drawable, relative to its parent.
void	setTouchable(bool touch)
	Controls whether this Drawable receives touch events or not.
void	setVisible(bool vis)
	Controls whether this Drawable should be visible.
virtual void	setWidth(int16_t width)
	Sets the width of this drawable.
void	setWidthHeight(const Bitmap & bitmap)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(const Drawable & drawable)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(const Rect & other)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(int16_t width, int16_t height)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual void	setX(int16_t x)
	Sets the x coordinate of this Drawable, relative to its parent.
void	setXY(const Drawable & drawable)
	Sets the x and y coordinates of this Drawable.
void	setXY(int16_t x, int16_t y)
	Sets the x and y coordinates of this Drawable, relative to its parent.
virtual void	setY(int16_t y)
	Sets the y coordinate of this Drawable, relative to its parent.
virtual void	translateRectToAbsolute(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.
Rect	rect
	The coordinates of this Drawable, relative to its parent.
bool	touchable
	True if this drawable should receive touch events.
bool	visible
	True if this drawable should be drawn.

Public Functions Documentation

AbstractProgressIndicator

AbstractProgressIndicator	(			)

Initializes a new instance of the AbstractProgressIndicator class with a default range 0-100.

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:

setAlpha

getProgress

virtual uint16_t getProgress	(	uint16_t	range =100	)

Gets the current progress based on the range set by setRange() and the value set by setValue().

Parameters:

range	(Optional) The range, default is 100.

Returns:

The progress.

See also:

setRange, setValue, getValue

getProgressIndicatorHeight

virtual int16_t getProgressIndicatorHeight	(			)	const

Gets progress indicator height.

Returns:

The progress indicator height.

See also:

setProgressIndicatorPosition

getProgressIndicatorWidth

virtual int16_t getProgressIndicatorWidth	(			)	const

Gets progress indicator width.

Returns:

The progress indicator width.

See also:

setProgressIndicatorPosition

getProgressIndicatorX

virtual int16_t getProgressIndicatorX	(			)	const

Gets progress indicator x coordinate.

Returns:

The progress indicator x coordinate.

See also:

setProgressIndicatorPosition

getProgressIndicatorY

virtual int16_t getProgressIndicatorY	(			)	const

Gets progress indicator y coordinate.

Returns:

The progress indicator y coordinate.

See also:

setProgressIndicatorPosition

getRange

virtual void getRange	(	int &	min ,		const
		int &	max		const
		)	const

Gets the range set by setRange().

Parameters:

min	The minimum input value.
max	The maximum input value.

See also:

setRange

getRange

virtual void getRange	(	int &	min ,		const
		int &	max ,		const
		uint16_t &	steps		const
		)	const

Gets the range set by setRange().

Parameters:

min	The minimum input value.
max	The maximum input value.
steps	The steps in which to report progress.

See also:

setRange

getRange

virtual void getRange	(	int &	min ,		const
		int &	max ,		const
		uint16_t &	steps ,		const
		uint16_t &	minStep		const
		)	const

Gets the range set by setRange().

Parameters:

min	The minimum input value.
max	The maximum input value.
steps	The steps in which to report progress.
minStep	The step which the minimum input value is mapped to.

See also:

setRange

getValue

virtual int getValue	(			)	const

Gets the current value set by setValue().

Returns:

The value.

See also:

setValue

handleTickEvent

virtual void handleTickEvent	(			)

Called periodically by the framework if the Drawable instance has subscribed to timer ticks.

See also:

Application::registerTimerWidget

Reimplements: touchgfx::Drawable::handleTickEvent

invalidateContent

virtual void invalidateContent	(			)	const

Tell the framework that the contents of the Drawable needs to be redrawn.

If the Drawable is invisible, nothing happens. Subclasses of Drawable are encouraged to implement this function and invalidate as little as possible, i.e. the smallest rectangle covering the visual element(s) drawn by the widget.

Reimplements: touchgfx::Drawable::invalidateContent

Reimplemented by: touchgfx::Gauge::invalidateContent

setAlpha

virtual void setAlpha	(	uint8_t	newAlpha	)

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:

newAlpha	The new alpha value. 255=solid, 0=invisible.

Note

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

See also:

getAlpha

Reimplemented by: touchgfx::BoxProgress::setAlpha, touchgfx::CircleProgress::setAlpha, touchgfx::ImageProgress::setAlpha, touchgfx::LineProgress::setAlpha, touchgfx::TextProgress::setAlpha, touchgfx::Gauge::setAlpha

setBackground

virtual void setBackground	(	const Bitmap &	bitmapBackground	)

Sets the background image.

The width and height of the progress indicator widget is updated according to the dimensions of the bitmap.

Parameters:

bitmapBackground	The background bitmap.

setEasingEquation

virtual void setEasingEquation	(	EasingEquation	easingEquation	)

Sets easing equation to be used in updateValue.

Parameters:

easingEquation	The easing equation.

See also:

updateValue

setProgressIndicatorPosition

virtual void setProgressIndicatorPosition	(	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.

Parameters:

x	The x coordinate.
y	The y coordinate.
width	The width of the box progress indicator.
height	The height of the box progress indicator.

See also:

getProgressIndicatorX, getProgressIndicatorY, getProgressIndicatorWidth, getProgressIndicatorHeight

Reimplemented by: touchgfx::BoxProgress::setProgressIndicatorPosition, touchgfx::CircleProgress::setProgressIndicatorPosition, touchgfx::ImageProgress::setProgressIndicatorPosition, touchgfx::LineProgress::setProgressIndicatorPosition, touchgfx::TextProgress::setProgressIndicatorPosition, touchgfx::Gauge::setProgressIndicatorPosition

setRange

virtual void setRange	(	int	min ,
		int	max ,
		uint16_t	steps =0,
		uint16_t	minStep =0
		)

Sets the range for the progress indicator.

The range is the values that are given to the progress indicator while progressing through the task at hand. If an app needs to work through 237 items to finish a task, the range should be set to (0, 237) assuming that 0 items is the minimum. Though the minimum is often 0, it is possible to customize this.

The steps parameter is used to specify at what granularity you want the progress indicator to report a new progress value. If the 237 items to be reported as 0%, 10%, 20%, ... 100%, the steps should be set to 10 as there are ten steps from 0% to 100%. If you want to update a widget which is 150 pixels wide, you might want to set steps to 150 to get a new progress value for every pixel. If you are updating a clock and want this to resemble an analog clock, you might want to use 12 or perhaps 60 as number of steps.

The minStep parameter is used when the minimum input value (min) should give a progress different from 0. For example, if progress is a clock face, you want to count from 0..1000 and you want progress per minute, but want to make sure that 0 is not a blank clock face, but instead you want 1 minute to show, use

setRange(0, 1000, 60, 1)

to make sure that as values progress from 0 to 1000, getProgress() start from 1 and goes up to 60. Another example could be a BoxProgress with a TextProgress on top and you want to make sure that "0%" will always show in the box, use something like

setRange(0, 1000, 200, 40)

if your box is 200 pixels wide and "0%" is 40 pixels wide.

Parameters:

min	The minimum input value.
max	The maximum input value.
steps	(Optional) The steps in which to report progress.
minStep	(Optional) The step which the minimum input value is mapped to.

See also:

setValue, getProgress

setValue

virtual void setValue	(	int	value	)

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:

value	The value.

Note

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

See also:

getValue, updateValue, setValueSetAction

Reimplemented by: touchgfx::BoxProgress::setValue, touchgfx::CircleProgress::setValue, touchgfx::ImageProgress::setValue, touchgfx::LineProgress::setValue, touchgfx::TextProgress::setValue, touchgfx::Gauge::setValue

setValueSetAction

void setValueSetAction	(	GenericCallback< const AbstractProgressIndicator & > &	callback	)

Sets callback that will be triggered every time a new value is assigned to the progress indicator.

This can happen directly from setValue() or during a gradual change initiated using updateValue().

Parameters:

callback	The callback.

See also:

setValue, updateValue

setValueUpdatedAction

void setValueUpdatedAction	(	GenericCallback< const AbstractProgressIndicator & > &	callback	)

Sets callback that will be triggered when updateValue has finished animating to the final value.

Parameters:

callback	The callback.

See also:

updateValue, setValueSetAction

updateValue

virtual void updateValue	(	int	value ,
		uint16_t	duration
		)

Update 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. The value is changed gradually in the given number of ticks using the easing equation set in setEasingEquation. Function setValue() is called for every new value during the change of value, and if a callback function has been set using setValueSetAction, that callback will be called for every new value. The callback set using setValueUpdatedCallback is called when the animation has finished.

Parameters:

value	The value.
duration	The duration.

Note

If duration is 0, setValue will be called immediately and the valueUpdated action is called immediately.

See also:

setValue, setEasingEquation, setValueSetAction, setValueUpdatedAction

Protected Attributes Documentation

animationDuration

int animationDuration

Duration of the animation.

animationEndValue

int animationEndValue

The animation end value.

animationRunning

bool animationRunning

Is the animation running.

animationStartValue

int animationStartValue

The animation start value.

animationStep

int animationStep

The current animation step.

background

Image background

The background image.

currentValue

int currentValue

The current value.

equation

EasingEquation equation

The equation used in updateValue()

progressIndicatorContainer

Container progressIndicatorContainer

The container that holds the actual progress indicator.

rangeMax

int rangeMax

The range maximum.

rangeMin

int rangeMin

The range minimum.

rangeSteps

uint16_t rangeSteps

The range steps.

rangeStepsMin

uint16_t rangeStepsMin

The range steps minimum.

valueSetCallback

GenericCallback< const AbstractProgressIndicator & > * valueSetCallback

New value assigned Callback.

valueUpdatedCallback

GenericCallback< const AbstractProgressIndicator & > * valueUpdatedCallback

Animation ended Callback.