Skip to main content
Version: 4.16

Shape

Simple widget capable of drawing a fully filled shape. The shape can be scaled and rotated. The Shape class allows the user to draw any shape and allows the defined shape to be scaled, rotated and moved freely. Example uses could be the hands of a clock.

See: AbstractShape

Inherits from: AbstractShape, CanvasWidget, Widget, Drawable

Public Functions#

virtual CWRUtil::Q5getCornerX(int i) const
Gets the x coordinate of a corner (a point) of the shape.
virtual CWRUtil::Q5getCornerY(int i) const
Gets the y coordinate of a corner (a point) of the shape.
virtual intgetNumPoints() const
Gets number of points used to make up the shape.
virtual voidsetCorner(int i, CWRUtil::Q5 x, CWRUtil::Q5 y)
Sets one of the points (a corner) of the shape in CWRUtil::Q5 format.

Protected Functions#

virtual CWRUtil::Q5getCacheX(int i) const
Gets cached x coordinate of a point/corner.
virtual CWRUtil::Q5getCacheY(int i) const
Gets cached y coordinate of a point/corner.
virtual voidsetCache(int i, CWRUtil::Q5 x, CWRUtil::Q5 y)
Sets the cached coordinates of a given point/corner.

Additional inherited members#

Public Classes inherited from AbstractShape#

structShapePoint
Defines an alias for a single point.

Public Functions inherited from AbstractShape#

AbstractShape()
virtual booldrawCanvasWidget(const Rect & invalidatedArea) const
Draw canvas widget for the given invalidated area.
intgetAngle() const
Gets the current angle of the abstractShape.
voidgetAngle(T & angle)
Gets the abstractShape's angle.
voidgetOrigin(T & dx, T & dy) const
Gets the position of the shapes (0,0).
voidgetScale(T & x, T & y) const
Gets the x scale and y scale of the shape as previously set using setScale.
voidmoveOrigin(T x, T y)
Sets the position of the shape's (0,0) in the widget.
voidsetAngle(T angle)
Sets the absolute angle to turn the AbstractShape.
voidsetOrigin(T x, T y)
Sets the position of the shape's (0,0) in the widget.
voidsetScale(T newXScale, T newYScale)
Scale the AbstractShape the given amounts in the x direction and the y direction.
voidsetScale(T scale)
Scale the AbstractShape the given amount in the x direction and the y direction.
voidsetShape(const ShapePoint< T > * points)
Sets a shape the struct Points.
voidsetShape(ShapePoint< T > * points)
Sets a shape the struct Points.
voidupdateAbstractShapeCache()
Updates the AbstractShape cache.
voidupdateAngle(T angle)
Sets the absolute angle to turn the AbstractShape.
voidupdateScale(T newXScale, T newYScale)
Scale the AbstractShape the given amount in the x direction and the y direction.

Protected Functions inherited from AbstractShape#

virtual RectgetMinimalRect() const
Gets minimal rectangle containing the shape drawn by this widget.

Public Functions inherited from CanvasWidget#

CanvasWidget()
virtual voiddraw(const Rect & invalidatedArea) const
Draws the given invalidated area.
virtual booldrawCanvasWidget(const Rect & invalidatedArea) const =0
Draw canvas widget for the given invalidated area.
virtual uint8_tgetAlpha() const
Gets the current alpha value of the widget.
virtual RectgetMinimalRect() const
Gets minimal rectangle containing the shape drawn by this 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#

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.

Reimplements: touchgfx::AbstractShape::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.

Reimplements: touchgfx::AbstractShape::getCornerY

getNumPoints#

virtual int getNumPoints()const

Gets number of points used to make up the shape.

Returns:

The number of points.

Reimplements: touchgfx::AbstractShape::getNumPoints

setCorner#

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

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:

Reimplements: touchgfx::AbstractShape::setCorner

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.

Reimplements: touchgfx::AbstractShape::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.

Reimplements: touchgfx::AbstractShape::getCacheY

setCache#

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

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.

Reimplements: touchgfx::AbstractShape::setCache