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
| struct | ShapePoint |
| Defines an alias for a single point. | |
Public Functions
| AbstractShape() | |
| virtual bool | drawCanvasWidget(const Rect & invalidatedArea) const |
| Draw canvas widget for the given invalidated area. | |
| int | getAngle() const |
| Gets the current angle of the abstractShape. | |
| template \<typename T \> void | getAngle(T & angle) |
| Gets the abstractShape's angle. | |
| virtual CWRUtil::Q5 | getCornerX(int i) const =0 |
| Gets the x coordinate of a corner (a point) of the shape. | |
| virtual CWRUtil::Q5 | getCornerY(int i) const =0 |
| Gets the y coordinate of a corner (a point) of the shape. | |
| virtual int | getNumPoints() 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 void | setCorner(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. | |
| void | updateAbstractShapeCache() |
| 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::Q5 | getCacheX(int i) const =0 |
| Gets cached x coordinate of a point/corner. | |
| virtual CWRUtil::Q5 | getCacheY(int i) const =0 |
| Gets cached y coordinate of a point/corner. | |
| virtual Rect | getMinimalRect() const |
| Gets minimal rectangle containing the shape drawn by this widget. | |
| virtual void | setCache(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 void | draw(const Rect & invalidatedArea) const |
| Draws the given invalidated area. | |
| virtual uint8_t | getAlpha() const |
| Gets the current alpha value of the widget. | |
| virtual AbstractPainter & | getPainter() const |
| Gets the current painter for the CanvasWidget. | |
| virtual Rect | getSolidRect() const |
| Gets the largest solid (non-transparent) rectangle. | |
| virtual void | invalidate() const |
| Invalidates the area covered by this CanvasWidget. | |
| void | resetMaxRenderLines() |
| Resets the maximum render lines. | |
| virtual void | setAlpha(uint8_t newAlpha) |
| Sets the opacity (alpha value). | |
| virtual void | setPainter(AbstractPainter & painter) |
| Sets a painter for the CanvasWidget. | |
Public Functions inherited from Widget
| virtual void | getLastChild(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 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. | |
| virtual void | draw(const Rect & invalidatedArea) const =0 |
| Draw this drawable. | |
| Drawable() | |
| Initializes a new instance of the Drawable class. | |
| void | drawToDynamicBitmap(BitmapId id) |
| Render the Drawable object into a dynamic bitmap. | |
| 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 | getSolidRect() const =0 |
| Get (the largest possible) rectangle that is guaranteed to be solid (opaque). | |
| 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 & rect) |
| 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
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.
| invalidatedArea | The invalidated area. |
true if the widget was drawn properly, false if not.
Reimplements: touchgfx::CanvasWidget::drawCanvasWidget
getAngle
| int getAngle | ( | ) | const |
Gets the current angle of the abstractShape.
The angle of the AbstractShaperounded down to the precision of int.
getAngle
| void getAngle | ( | T & | angle | ) | |
Gets the abstractShape's angle.
| T | Generic type parameter. |
| angle | The current AbstractShape rotation angle rounded down to the precision of T. |
getCornerX
| virtual CWRUtil::Q5 getCornerX | ( | int | i | ) | |
Gets the x coordinate of a corner (a point) of the shape.
| i | Zero-based index of the corner. |
The corner x coordinate in CWRUtil::Q5 format.
Reimplemented by: touchgfx::Shape::getCornerX
getCornerY
| virtual CWRUtil::Q5 getCornerY | ( | int | i | ) | |
Gets the y coordinate of a corner (a point) of the shape.
| i | Zero-based index of the corner. |
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.
The number of points.
Reimplemented by: touchgfx::Shape::getNumPoints
getOrigin
| void getOrigin | ( | T & | dx , | const | |
| T & | dy | const | |||
| ) | const |
Gets the position of the shapes (0,0).
| T | Generic type parameter, either int or float. |
| dx | The x coordinate rounded down to the precision of T. |
| dy | The y coordinate rounded down to the precision of T. |
getScale
| void getScale | ( | T & | x , | const | |
| T & | y | const | |||
| ) | 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.
| T | Generic type parameter, either int or float. |
| x | Scaling of x coordinates rounded down to the precision of T. |
| y | Scaling of y coordinates rounded down to the precision of T. |
moveOrigin
| void moveOrigin | ( | T | x , | ||
| T | y | ||||
| ) |
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.
| T | Generic type parameter, either int or float. |
| x | The absolute x coordinate of the shapes position (0,0). |
| y | The absolute y coordinate of the shapes position (0,0). |
Note
The area containing the AbstractShape is invalidated before and after the change.
setAngle
| void setAngle | ( | T | angle | ) | |
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.
| T | Generic type parameter. |
| angle | The absolute angle to turn the abstractShape to relative to 0 (straight up). |
Note
The area containing the AbstractShape is not invalidated.
setCorner
| virtual void setCorner | ( | int | i , | =0 | |
| CWRUtil::Q5 | x , | =0 | |||
| CWRUtil::Q5 | y | =0 | |||
| ) | =0 |
Sets one of the points (a corner) of the shape in CWRUtil::Q5 format.
| i | Zero-based index of the corner. |
| x | The x coordinate in CWRUtil::Q5 format. |
| y | The 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.
Reimplemented by: touchgfx::Shape::setCorner
setOrigin
| void setOrigin | ( | T | x , | ||
| T | y | ||||
| ) |
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.
| T | Generic type parameter, either int or float. |
| x | The absolute x coordinate of the shapes position (0,0). |
| y | The absolute y coordinate of the shapes position (0,0). |
Note
The area containing the AbstractShape is not invalidated.
setScale
| void setScale | ( | T | newXScale , | ||
| T | newYScale | ||||
| ) |
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.
| T | Generic type parameter, either int or float. |
| newXScale | The new scale in the x direction. |
| newYScale | The new scale in the y direction. |
Note
The area containing the AbstractShape is not invalidated.
setScale
| void setScale | ( | T | scale | ) | |
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.
| T | Generic type parameter, either int or float. |
| scale | The scale in the x direction. |
Note
The area containing the AbstractShape is not invalidated.
setShape
| void setShape | ( | const ShapePoint< T > * | points | ) | |
Sets a shape the struct Points.
The cached outline of the shape is automatically updated.
| T | Generic type parameter, either int or float. |
| points | The 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.
| T | Generic type parameter, either int or float. |
| points | The 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
| void 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 | ( | T | angle | ) | |
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.
| T | Generic type parameter. |
| angle | The angle to turn the abstractShape. |
Note
The area containing the AbstractShape is invalidated before and after the change.
updateScale
| void updateScale | ( | T | newXScale , | ||
| T | newYScale | ||||
| ) |
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.
| T | Generic type parameter, either int or float. |
| newXScale | The new scale in the x direction. |
| newYScale | The new scale in the y direction. |
Note
The area containing the AbstractShape is invalidated before and after the change.
Protected Functions Documentation
getCacheX
| virtual CWRUtil::Q5 getCacheX | ( | int | i | ) | |
Gets cached x coordinate of a point/corner.
| i | Zero-based index of the point/corner. |
The cached x coordinate, or zero if nothing is cached for the given i.
Reimplemented by: touchgfx::Shape::getCacheX
getCacheY
| virtual CWRUtil::Q5 getCacheY | ( | int | i | ) | |
Gets cached y coordinate of a point/corner.
| i | Zero-based index of the point/corner. |
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.
The minimal rectangle containing the shape drawn.
Reimplements: touchgfx::CanvasWidget::getMinimalRect
setCache
| virtual void setCache | ( | int | i , | =0 | |
| CWRUtil::Q5 | x , | =0 | |||
| CWRUtil::Q5 | y | =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.
| i | Zero-based index of the corner. |
| x | The x coordinate. |
| y | The y coordinate. |
Reimplemented by: touchgfx::Shape::setCache