跳转到主要内容

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 voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
floatgetImageHeight() const
Gets SVG height as given in the SVG image file.
floatgetImagePositionX() const
Gets image position x coordinate.
floatgetImagePositionY() const
Gets image position y coordinate.
floatgetImageWidth() const
Gets SVG width as given in the SVG image file.
floatgetRotation() const
Gets SVG rotation.
floatgetRotationCenterX() const
Gets rotation center x coordinate.
floatgetRotationCenterY() const
Gets rotation center y coordinate.
floatgetScaleX() const
Gets SVG scale for width.
floatgetScaleY() const
Gets SVG height scale.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual voidinvalidateContent() const
Tell the framework that the contents of the Drawable needs to be redrawn.
voidreset()
Resets all adjustments made to the svg proportions.
voidresizeToCurrentSVG()
Resize the Widget to match the size of the SVG drawing.
voidsetImagePosition(float imageX, float imageY)
Sets image position.
voidsetRotation(float angle)
Sets SVG rotation.
voidsetRotationCenter(float centerX, float centerY)
Sets SVG rotation center.
voidsetScale(float scale)
Sets SVG scale for both width and height.
voidsetScale(float xScale, float yScale)
Sets SVG scale for width and for height.
voidsetScaleX(float scale)
Sets SVG scale for width.
voidsetScaleY(float scale)
Sets SVG height scale.
virtual voidsetSVG(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

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

Protected Attributes

floatimagePositionX
The SVG image position x coordinate.
floatimagePositionY
The SVG image position y coordinate.
floatrotation
The rotation.
floatrotationCenterX
The rotation center x coordinate.
floatrotationCenterY
The rotation center y coordinate.
floatscaleX
The scale for width.
floatscaleY
The scale for height.
uint16_tsvgId
The SVG to display.

Additional inherited members

Public Functions inherited from Widget

virtual voidgetLastChild(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

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

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:
invalidatedAreaThe 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:

getImagePositionY

float getImagePositionY()const

Gets image position y coordinate.

Returns:

The image position y coordinate.

See also:

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:

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:

getScaleY

float getScaleY()const

Gets SVG height scale.

Returns:

The SVG scale for height.

See also:

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

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

setImagePosition

void setImagePosition(floatimageX ,
floatimageY
)

Sets image position.

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

Parameters:
imageXThe image x coordinate.
imageYThe image y coordinate.
See also:

setRotation

void setRotation(floatangle)

Sets SVG rotation.

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

Parameters:
angleThe rotation angle.
See also:

setRotationCenter

void setRotationCenter(floatcenterX ,
floatcenterY
)

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:
centerXThe center x coordinate.
centerYThe center y coordinate.
See also:

setScale

void setScale(floatscale)

Sets SVG scale for both width and height.

Parameters:
scaleThe scale to apply to width and height.

setScale

void setScale(floatxScale ,
floatyScale
)

Sets SVG scale for width and for height.

Parameters:
xScaleThe scale for width.
yScaleThe scale for height.
See also:

setScaleX

void setScaleX(floatscale)

Sets SVG scale for width.

Parameters:
scaleThe scale for width.
See also:

setScaleY

void setScaleY(floatscale)

Sets SVG height scale.

Parameters:
scaleThe scale for height.
See also:

setSVG

virtual void setSVG(uint16_tid)

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:
idThe SVG ID.
Note

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

See also:

SVGImage

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

See also:

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.