SVGImage

touchgfx/widgets/SVGImage.hpp

Simple widget capable of showing a SVG image on the display.

See: Image

Inherits from: Widget, Drawable

Public Functions

virtual void	draw(const Rect & invalidatedArea) const
	Draw this drawable.
float	getImageHeight() const
	Gets SVG height as given in the SVG image file.
float	getImagePositionX() const
	Gets image position x coordinate.
float	getImagePositionY() const
	Gets image position y coordinate.
float	getImageWidth() const
	Gets SVG width as given in the SVG image file.
float	getRotation() const
	Gets SVG rotation.
float	getRotationCenterX() const
	Gets rotation center x coordinate.
float	getRotationCenterY() const
	Gets rotation center y coordinate.
float	getScaleX() const
	Gets SVG scale for width.
float	getScaleY() const
	Gets SVG height scale.
virtual Rect	getSolidRect() const
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual void	invalidateContent() const
	Tell the framework that the contents of the Drawable needs to be redrawn.
void	reset()
	Resets all adjustments made to the svg proportions.
void	resizeToCurrentSVG()
	Resize the Widget to match the size of the SVG drawing.
void	setImagePosition(float imageX, float imageY)
	Sets image position.
void	setRotation(float angle)
	Sets SVG rotation.
void	setRotationCenter(float centerX, float centerY)
	Sets SVG rotation center.
void	setScale(float scale)
	Sets SVG scale for both width and height.
void	setScale(float xScale, float yScale)
	Sets SVG scale for width and for height.
void	setScaleX(float scale)
	Sets SVG scale for width.
void	setScaleY(float scale)
	Sets SVG height scale.
virtual void	setSVG(uint16_t id)
	Sets the SVG for this SVGImage and updates the width and height of this widget (if the widget has not already been assigned a width and height) to match those of the SVG drawing.
	SVGImage()
	Constructs a new Image with a default SVG (undefined) if none is specified.

Protected Functions

Matrix3x3	getTransformationMatrix() const
	Calculate the transformation matrix used when drawing the SVG.

Protected Attributes

float	imagePositionX
	The SVG image position x coordinate.
float	imagePositionY
	The SVG image position y coordinate.
float	rotation
	The rotation.
float	rotationCenterX
	The rotation center x coordinate.
float	rotationCenterY
	The rotation center y coordinate.
float	scaleX
	The scale for width.
float	scaleY
	The scale for height.
uint16_t	svgId
	The SVG to display.

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	handleTickEvent()
	Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
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

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

getImageHeight

float getImageHeight	(			)	const

Gets SVG height as given in the SVG image file.

This is the width before applying any rotation and scaling.

Returns:

The SVG height.

getImagePositionX

float getImagePositionX	(			)	const

Gets image position x coordinate.

Returns:

The image position x coordinate.

See also:

setImagePosition

getImagePositionY

float getImagePositionY	(			)	const

Gets image position y coordinate.

Returns:

The image position y coordinate.

See also:

setImagePosition

getImageWidth

float getImageWidth	(			)	const

Gets SVG width as given in the SVG image file.

This is the width before applying any rotation and scaling.

Returns:

The SVG width.

getRotation

float getRotation	(			)	const

Gets SVG rotation.

Returns:

The SVG rotation.

See also:

setRotation

getRotationCenterX

float getRotationCenterX	(			)	const

Gets rotation center x coordinate.

Returns:

The rotation center x coordinate.

getRotationCenterY

float getRotationCenterY	(			)	const

Gets rotation center y coordinate.

Returns:

The rotation center y coordinate.

getScaleX

float getScaleX	(			)	const

Gets SVG scale for width.

Returns:

The SVG scale for width.

See also:

setScale, setScaleX

getScaleY

float getScaleY	(			)	const

Gets SVG height scale.

Returns:

The SVG scale for height.

See also:

setScale, setScaleY

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

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

reset

void reset	(			)

Resets all adjustments made to the svg proportions.

resizeToCurrentSVG

void resizeToCurrentSVG	(			)

Resize the Widget to match the size of the SVG drawing.

setImagePosition

void setImagePosition	(	float	imageX ,
		float	imageY
		)

Sets image position.

This is used to move the SVG on the screen. Negative values move the SVG to the left and up.

Parameters:

imageX	The image x coordinate.
imageY	The image y coordinate.

See also:

getImagePositionX, getImagePositionY

setRotation

void setRotation	(	float	angle	)

Sets SVG rotation.

The rotation is done around the position set in the previously set rotation center.

Parameters:

angle	The rotation angle.

See also:

setRotationCenter, getRotation

setRotationCenter

void setRotationCenter	(	float	centerX ,
		float	centerY
		)

Sets SVG rotation center.

The position is relative to the topleft corner of the SVGImage widget, not relative to the SVG. The center is the position before applying any scaling.

Parameters:

centerX	The center x coordinate.
centerY	The center y coordinate.

See also:

getRotationCenterX, getRotationCenterY, setImagePosition

setScale

void setScale	(	float	scale	)

Sets SVG scale for both width and height.

Parameters:

scale	The scale to apply to width and height.

setScale

void setScale	(	float	xScale ,
		float	yScale
		)

Sets SVG scale for width and for height.

Parameters:

xScale	The scale for width.
yScale	The scale for height.

See also:

setScale(float), getScaleX, getScaleY

setScaleX

void setScaleX	(	float	scale	)

Sets SVG scale for width.

Parameters:

scale	The scale for width.

See also:

setScale(float), setScale(float,float), getScaleX

setScaleY

void setScaleY	(	float	scale	)

Sets SVG height scale.

Parameters:

scale	The scale for height.

See also:

setScale(float), setScale(float,float), getScaleY

setSVG

virtual void setSVG	(	uint16_t	id	)

Sets the SVG for this SVGImage and updates the width and height of this widget (if the widget has not already been assigned a width and height) to match those of the SVG drawing.

See the file generated/images/include/images/SVGDatabase.hpp.

Parameters:

id	The SVG ID.

Note

The image is not resized and invalidated after setting the id.

See also:

resizeToCurrentSVG

SVGImage

SVGImage	(			)

Constructs a new Image with a default SVG (undefined) if none is specified.

See also:

setSVG

Protected Functions Documentation

getTransformationMatrix

Matrix3x3 getTransformationMatrix	(			)	const

Calculate the transformation matrix used when drawing the SVG.

Returns:

The transformation matrix.

Protected Attributes Documentation

imagePositionX

float imagePositionX

The SVG image position x coordinate.

imagePositionY

float imagePositionY

The SVG image position y coordinate.

rotation

float rotation

The rotation.

rotationCenterX

float rotationCenterX

The rotation center x coordinate.

rotationCenterY

float rotationCenterY

The rotation center y coordinate.

scaleX

float scaleX

The scale for width.

scaleY

float scaleY

The scale for height.

svgId

uint16_t svgId

The SVG to display.