DeltaCompressedAnimation

touchgfx/widgets/DeltaCompressedAnimation.hpp

Widget that displays frames from a TouchGFX Delta Compressed Animation resource. For animation data that is not directly addressable, a caller-owned header buffer must be configured with setHeaderBuffer() if the animation uses L8 or L8_RLE. The resource and configured header buffer must remain valid for as long as the widget uses them.

Inherits from: Widget, Drawable

Public Functions

	DeltaCompressedAnimation()
	Constructs an empty animation widget with no animation assigned.
virtual void	draw(const Rect & invalidatedArea) const
	Draw this drawable.
int	getFrameNumber() const
	Returns the zero-based index of the current frame.
virtual Rect	getSolidRect() const
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual void	handleTickEvent()
	Advances the animation when the configured tick interval elapses.
bool	nextFrame()
	Advances to the next frame and invalidates its rectangular parts.
void	setAnimation(const void * animation)
	Assigns an animation resource and loads its current frame.
void	setDoneAction(touchgfx::GenericCallback< const DeltaCompressedAnimation & > & callback)
	Associates an action to be performed when the animation reaches its final frame.
void	setHeaderBuffer(uint32_t * buffer, size_t size)
	Sets the working buffer used for non-addressable L8 and L8-RLE bitmap data.
void	setLoopAnimation(bool loop)
	Sets whether the animation restarts after its final frame.
void	setUpdateTicksInterval(uint8_t updateInterval)
	Sets the number of timer ticks between frame changes.
void	startAnimation(bool loop =false)
	Starts advancing the animation on timer ticks.
void	stopAnimation()
	Stops advancing the animation and unregisters its timer.

Additional inherited members

Public Functions inherited from Widget

virtual void	getLastChild(int16_t , int16_t , 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

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.
	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	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	invalidateContent() const
	Tell the framework that the contents of the 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

DeltaCompressedAnimation

DeltaCompressedAnimation	(			)

Constructs an empty animation widget with no animation assigned.

draw

virtual void draw	(	const Rect &	invalidatedArea	)

Draw this drawable.

It is a requirement that the draw implementation does not draw outside the region specified by invalidatedArea.

Parameters:

invalidatedArea	The sub-region of this drawable that needs to be redrawn, expressed in coordinates relative to its parent (e.g. for a complete redraw, invalidatedArea will be (0, 0, width, height).

Reimplements: touchgfx::Drawable::draw

getFrameNumber

int getFrameNumber	(			)	const

Returns the zero-based index of the current frame.

Returns:

The current frame index.

getSolidRect

virtual Rect getSolidRect	(			)	const

Get (the largest possible) rectangle that is guaranteed to be solid (opaque).

This information is important, as any Drawable underneath the solid area does not need to be drawn.

Returns:

The solid rectangle part of the Drawable.

Note

The rectangle returned must be relative to upper left corner of the Drawable, meaning that a completely solid widget should return the full size Rect(0, 0, getWidth(), getHeight()). If no area can be guaranteed to be solid, an empty Rect must be returned. Failing to return the correct rectangle may result in errors on the display.

Reimplements: touchgfx::Drawable::getSolidRect

handleTickEvent

virtual void handleTickEvent	(			)

Advances the animation when the configured tick interval elapses.

The widget must be started with startAnimation() to receive timer ticks. At the final frame, playback either stops or wraps to the first frame depending on the loop setting.

Reimplements: touchgfx::Drawable::handleTickEvent

nextFrame

bool nextFrame	(			)

Advances to the next frame and invalidates its rectangular parts.

The frame index wraps to the first frame after the final frame.

Returns:

false if no animation is assigned or the newly selected frame is the final frame; otherwise true.

setAnimation

void setAnimation	(	const void *	animation	)

Assigns an animation resource and loads its current frame.

The widget dimensions are updated from the resource header. The resource is not copied and must remain valid while the animation is in use.

Parameters:

animation	Pointer to the start of a valid animation resource.

setDoneAction

void setDoneAction	(	touchgfx::GenericCallback< const DeltaCompressedAnimation & > &	callback	)

Associates an action to be performed when the animation reaches its final frame.

If the animation is set to loop, the action is also triggered at the end of each loop.

Parameters:

callback	The callback is executed when the animation is done and receives this widget.

setHeaderBuffer

void setHeaderBuffer	(	uint32_t *	buffer ,
		size_t	size
		)

Sets the working buffer used for non-addressable L8 and L8-RLE bitmap data.

The buffer is not owned by the widget and must remain valid while non-addressable animations are drawn. Addressable animation data does not require this buffer.

Parameters:

buffer	Pointer to writable, 32-bit-aligned memory.
size	Buffer capacity in bytes.

setLoopAnimation

void setLoopAnimation	(	bool	loop	)

Sets whether the animation restarts after its final frame.

Parameters:

loop	If true, restart at the first frame after the final frame.

setUpdateTicksInterval

void setUpdateTicksInterval	(	uint8_t	updateInterval	)

Sets the number of timer ticks between frame changes.

Parameters:

updateInterval	Number of ticks between frame changes.

startAnimation

void startAnimation	(	bool	loop =false	)

Starts advancing the animation on timer ticks.

Parameters:

loop	If true, restart at the first frame after the final frame.

stopAnimation

void stopAnimation	(			)

Stops advancing the animation and unregisters its timer.