Skip to main content
Version: 4.16

AbstractShape

Simple widget capable of drawing a abstractShape. The abstractShape can be scaled and rotated around 0,0. The shapes points (corners) are calculated with regards to scaling and rotation to allow for faster redrawing. Care must be taken to call updateAbstractShapeCache() after updating the shape, the scale of the shape or the rotation of the shape.

Inherits from: CanvasWidget, Widget, Drawable

Inherited by: Shape< POINTS >

Public Classes#

structShapePoint
Defines an alias for a single point.

Public Functions#

AbstractShape()
virtual booldrawCanvasWidget(const Rect & invalidatedArea) const
Draw canvas widget for the given invalidated area.
intgetAngle() const
Gets the current angle of the abstractShape.
template \<typename T \>
void
getAngle(T & angle)
Gets the abstractShape's angle.
virtual CWRUtil::Q5getCornerX(int i) const =0
Gets the x coordinate of a corner (a point) of the shape.
virtual CWRUtil::Q5getCornerY(int i) const =0
Gets the y coordinate of a corner (a point) of the shape.
virtual intgetNumPoints() const =0
Gets number of points used to make up the shape.
template \<typename T \>
void
getOrigin(T & dx, T & dy) const
Gets the position of the shapes (0,0).
template \<typename T \>
void
getScale(T & x, T & y) const
Gets the x scale and y scale of the shape as previously set using setScale.
template \<typename T \>
void
moveOrigin(T x, T y)
Sets the position of the shape's (0,0) in the widget.
template \<typename T \>
void
setAngle(T angle)
Sets the absolute angle to turn the AbstractShape.
virtual voidsetCorner(int i, CWRUtil::Q5 x, CWRUtil::Q5 y) =0
Sets one of the points (a corner) of the shape in CWRUtil::Q5 format.
template \<typename T \>
void
setOrigin(T x, T y)
Sets the position of the shape's (0,0) in the widget.
template \<typename T \>
void
setScale(T newXScale, T newYScale)
Scale the AbstractShape the given amounts in the x direction and the y direction.
template \<typename T \>
void
setScale(T scale)
Scale the AbstractShape the given amount in the x direction and the y direction.
template \<typename T \>
void
setShape(const ShapePoint< T > * points)
Sets a shape the struct Points.
template \<typename T \>
void
setShape(ShapePoint< T > * points)
Sets a shape the struct Points.
voidupdateAbstractShapeCache()
Updates the AbstractShape cache.
template \<typename T \>
void
updateAngle(T angle)
Sets the absolute angle to turn the AbstractShape.
template \<typename T \>
void
updateScale(T newXScale, T newYScale)
Scale the AbstractShape the given amount in the x direction and the y direction.

Protected Functions#

virtual CWRUtil::Q5getCacheX(int i) const =0
Gets cached x coordinate of a point/corner.
virtual CWRUtil::Q5getCacheY(int i) const =0
Gets cached y coordinate of a point/corner.
virtual RectgetMinimalRect() const
Gets minimal rectangle containing the shape drawn by this widget.
virtual voidsetCache(int i, CWRUtil::Q5 x, CWRUtil::Q5 y) =0
Sets the cached coordinates of a given point/corner.

Additional inherited members#

Public Functions inherited from CanvasWidget#

CanvasWidget()
virtual voiddraw(const Rect & invalidatedArea) const
Draws the given invalidated area.
virtual uint8_tgetAlpha() const
Gets the current alpha value of the widget.
virtual AbstractPainter &getPainter() const
Gets the current painter for the CanvasWidget.
virtual RectgetSolidRect() const
Gets the largest solid (non-transparent) rectangle.
virtual voidinvalidate() const
Invalidates the area covered by this CanvasWidget.
voidresetMaxRenderLines()
Resets the maximum render lines.
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
virtual voidsetPainter(AbstractPainter & painter)
Sets a painter for the CanvasWidget.

Public Functions inherited from Widget#

virtual voidgetLastChild(int16_t x, int16_t y, 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#

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.
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 & evt)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & evt)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & evt)
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 & rect)
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#

AbstractShape#

drawCanvasWidget#

virtual bool drawCanvasWidget(const Rect &invalidatedArea)

Draw canvas widget for the given invalidated area.

Similar to draw(), but might be invoked several times with increasingly smaller areas to due to memory constraints from the underlying CanvasWidgetRenderer.

Parameters:
invalidatedAreaThe invalidated area.
Returns:

true if the widget was drawn properly, false if not.

See also:

Reimplements: touchgfx::CanvasWidget::drawCanvasWidget

getAngle#

int getAngle()const

Gets the current angle of the abstractShape.

Returns:

The angle of the AbstractShaperounded down to the precision of int.

getAngle#

void getAngle(T &angle)

Gets the abstractShape's angle.

Template Parameters:
TGeneric type parameter.
Parameters:
angleThe current AbstractShape rotation angle rounded down to the precision of T.

getCornerX#

virtual CWRUtil::Q5 getCornerX(inti)

Gets the x coordinate of a corner (a point) of the shape.

Parameters:
iZero-based index of the corner.
Returns:

The corner x coordinate in CWRUtil::Q5 format.

Reimplemented by: touchgfx::Shape::getCornerX

getCornerY#

virtual CWRUtil::Q5 getCornerY(inti)

Gets the y coordinate of a corner (a point) of the shape.

Parameters:
iZero-based index of the corner.
Returns:

The corner y coordinate in CWRUtil::Q5 format.

Reimplemented by: touchgfx::Shape::getCornerY

getNumPoints#

virtual int getNumPoints()const =0

Gets number of points used to make up the shape.

Returns:

The number of points.

Reimplemented by: touchgfx::Shape::getNumPoints

getOrigin#

void getOrigin(T &dx ,const
T &dyconst
)const

Gets the position of the shapes (0,0).

Template Parameters:
TGeneric type parameter, either int or float.
Parameters:
dxThe x coordinate rounded down to the precision of T.
dyThe y coordinate rounded down to the precision of T.

getScale#

void getScale(T &x ,const
T &yconst
)const

Gets the x scale and y scale of the shape as previously set using setScale.

Default is 1 for both x scale and y scale.

Template Parameters:
TGeneric type parameter, either int or float.
Parameters:
xScaling of x coordinates rounded down to the precision of T.
yScaling of y coordinates rounded down to the precision of T.
See also:

moveOrigin#

void moveOrigin(Tx ,
Ty
)

Sets the position of the shape's (0,0) in the widget.

This means that all coordinates initially used when created the shape are moved relative to these given offsets. Subsequent calls to moveOrigin() or setOrigin() will replace the old values for origin. The cached outline of the shape is automatically updated.

Template Parameters:
TGeneric type parameter, either int or float.
Parameters:
xThe absolute x coordinate of the shapes position (0,0).
yThe absolute y coordinate of the shapes position (0,0).
Note

The area containing the AbstractShape is invalidated before and after the change.

See also:

setAngle#

void setAngle(Tangle)

Sets the absolute angle to turn the AbstractShape.

0 degrees means no rotation and 90 degrees is rotate the shape clockwise. Repeated calls to setAngle(10) will therefore not rotate the shape by an additional 10 degrees. The cached outline of the shape is automatically updated.

Template Parameters:
TGeneric type parameter.
Parameters:
angleThe absolute angle to turn the abstractShape to relative to 0 (straight up).
Note

The area containing the AbstractShape is not invalidated.

See also:

setCorner#

virtual void setCorner(inti ,=0
CWRUtil::Q5x ,=0
CWRUtil::Q5y=0
)=0

Sets one of the points (a corner) of the shape in CWRUtil::Q5 format.

Parameters:
iZero-based index of the corner.
xThe x coordinate in CWRUtil::Q5 format.
yThe y coordinate in CWRUtil::Q5 format.
Note

Remember to call updateAbstractShapeCache() after calling setCorner one or more times, to make sure that the cached outline of the shape is correct.

See also:

Reimplemented by: touchgfx::Shape::setCorner

setOrigin#

void setOrigin(Tx ,
Ty
)

Sets the position of the shape's (0,0) in the widget.

This means that all coordinates initially used when created the shape are moved relative to these given offsets. Subsequent calls to setOrigin() or moveOrigin() will replace the old values for origin. The cached outline of the shape is automatically updated.

Template Parameters:
TGeneric type parameter, either int or float.
Parameters:
xThe absolute x coordinate of the shapes position (0,0).
yThe absolute y coordinate of the shapes position (0,0).
Note

The area containing the AbstractShape is not invalidated.

See also:

setScale#

void setScale(TnewXScale ,
TnewYScale
)

Scale the AbstractShape the given amounts in the x direction and the y direction.

The new scaling factors do not multiply to previously set scaling factors, so scaling by 2 and later scaling by 2 again will not scale by 4, only by 2. The cached outline of the shape is automatically updated.

Template Parameters:
TGeneric type parameter, either int or float.
Parameters:
newXScaleThe new scale in the x direction.
newYScaleThe new scale in the y direction.
Note

The area containing the AbstractShape is not invalidated.

See also:

setScale#

void setScale(Tscale)

Scale the AbstractShape the given amount in the x direction and the y direction.

The new scaling factors do not multiply to previously set scaling factors, so scaling by 2 and later scaling by 2 again will not scale by 4, only by 2. The cached outline of the shape is automatically updated.

Template Parameters:
TGeneric type parameter, either int or float.
Parameters:
scaleThe scale in the x direction.
Note

The area containing the AbstractShape is not invalidated.

See also:

setShape#

void setShape(const ShapePoint< T > *points)

Sets a shape the struct Points.

The cached outline of the shape is automatically updated.

Template Parameters:
TGeneric type parameter, either int or float.
Parameters:
pointsThe points that make up the shape. The pointer must point to an array of getNumPoints() elements of type ShapePoint.
Note

The area containing the shape is not invalidated.

setShape#

void setShape(ShapePoint< T > *points)

Sets a shape the struct Points.

The cached outline of the shape is automatically updated.

Template Parameters:
TGeneric type parameter, either int or float.
Parameters:
pointsThe points that make up the shape. The pointer must point to an array of getNumPoints() elements of type ShapePoint.
Note

The area containing the shape is not invalidated.

updateAbstractShapeCache#

Updates the AbstractShape cache.

The cache is used to be able to quickly redraw the AbstractShape without calculating the points that make up the abstractShape (with regards to scaling and rotation).

updateAngle#

void updateAngle(Tangle)

Sets the absolute angle to turn the AbstractShape.

0 degrees means no rotation and 90 degrees is rotate the shape clockwise. Repeated calls to setAngle(10) will therefore not rotate the shape by an additional 10 degrees. The cached outline of the shape is automatically updated.

Template Parameters:
TGeneric type parameter.
Parameters:
angleThe angle to turn the abstractShape.
Note

The area containing the AbstractShape is invalidated before and after the change.

See also:

updateScale#

void updateScale(TnewXScale ,
TnewYScale
)

Scale the AbstractShape the given amount in the x direction and the y direction.

The new scaling factors do not multiply to previously set scaling factors, so scaling by 2 and later scaling by 2 again will not scale by 4, only by 2. The cached outline of the shape is automatically updated.

Template Parameters:
TGeneric type parameter, either int or float.
Parameters:
newXScaleThe new scale in the x direction.
newYScaleThe new scale in the y direction.
Note

The area containing the AbstractShape is invalidated before and after the change.

See also:

Protected Functions Documentation#

getCacheX#

virtual CWRUtil::Q5 getCacheX(inti)

Gets cached x coordinate of a point/corner.

Parameters:
iZero-based index of the point/corner.
Returns:

The cached x coordinate, or zero if nothing is cached for the given i.

Reimplemented by: touchgfx::Shape::getCacheX

getCacheY#

virtual CWRUtil::Q5 getCacheY(inti)

Gets cached y coordinate of a point/corner.

Parameters:
iZero-based index of the point/corner.
Returns:

The cached y coordinate, or zero if nothing is cached for the given i.

Reimplemented by: touchgfx::Shape::getCacheY

getMinimalRect#

virtual Rect getMinimalRect()const

Gets minimal rectangle containing the shape drawn by this widget.

Default implementation returns the size of the entire widget, but this function should be overwritten in subclasses and return the minimal rectangle containing the shape. See classes such as Circle for example implementations.

Returns:

The minimal rectangle containing the shape drawn.

Reimplements: touchgfx::CanvasWidget::getMinimalRect

setCache#

virtual void setCache(inti ,=0
CWRUtil::Q5x ,=0
CWRUtil::Q5y=0
)=0

Sets the cached coordinates of a given point/corner.

The coordinates in the cache are the coordinates from the corners after rotation and scaling has been applied to the coordinate.

Parameters:
iZero-based index of the corner.
xThe x coordinate.
yThe y coordinate.

Reimplemented by: touchgfx::Shape::setCache