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::Q5 | getCornerX(int i) const |
Gets the x coordinate of a corner (a point) of the shape. | |
virtual CWRUtil::Q5 | getCornerY(int i) const |
Gets the y coordinate of a corner (a point) of the shape. | |
virtual int | getNumPoints() const |
Gets number of points used to make up the shape. | |
virtual void | setCorner(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::Q5 | getCacheX(int i) const |
Gets cached x coordinate of a point/corner. | |
virtual CWRUtil::Q5 | getCacheY(int i) const |
Gets cached y coordinate of a point/corner. | |
virtual void | setCache(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
struct | ShapePoint |
Defines an alias for a single point. | |
Public Functions inherited from AbstractShape
AbstractShape() | |
virtual bool | drawCanvasWidget(const Rect & invalidatedArea) const |
Draw canvas widget for the given invalidated area. | |
int | getAngle() const |
Gets the current angle in degrees of the abstractShape. | |
void | getAngle(T & angle) |
Gets the abstractShape's angle in degrees. | |
void | getOrigin(T & xOrigin, T & yOrigin) const |
Gets the position of the shapes (0,0). | |
void | getScale(T & x, T & y) const |
Gets the x scale and y scale of the shape as previously set using setScale. | |
void | moveOrigin(T x, T y) |
Sets the position of the shape's (0,0) in the widget. | |
void | setAngle(T angle) |
Sets the absolute angle in degrees to turn the AbstractShape. | |
void | setOrigin(T x, T y) |
Sets the position of the shape's (0,0) in the widget. | |
void | setScale(T newXScale, T newYScale) |
Scale the AbstractShape the given amounts in the x direction and the y direction. | |
void | setScale(T scale) |
Scale the AbstractShape the given amount in the x direction and the y direction. | |
void | setShape(const ShapePoint< T > * points) |
Sets a shape the struct Points. | |
void | setShape(ShapePoint< T > * points) |
Sets a shape the struct Points. | |
void | updateAbstractShapeCache() |
Updates the AbstractShape cache. | |
void | updateAngle(T angle) |
Sets the absolute angle in degrees to turn the AbstractShape. | |
void | updateScale(T newXScale, T newYScale) |
Scale the AbstractShape the given amount in the x direction and the y direction. | |
Protected Functions inherited from AbstractShape
virtual Rect | getMinimalRect() const |
Gets minimal rectangle containing the shape drawn by this widget. | |
Public Functions inherited from CanvasWidget
CanvasWidget() | |
virtual void | draw(const Rect & invalidatedArea) const |
Draws the given invalidated area. | |
virtual bool | drawCanvasWidget(const Rect & invalidatedArea) const =0 |
Draw canvas widget for the given invalidated area. | |
virtual uint8_t | getAlpha() const |
Gets the current alpha value of the widget. | |
virtual Rect | getMinimalRect() const |
Gets minimal rectangle containing the shape drawn by this widget. | |
const 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. | |
virtual void | setAlpha(uint8_t newAlpha) |
Sets the opacity (alpha value). | |
void | setPainter(const AbstractPainter & painter) |
Sets a painter for the CanvasWidget. | |
Protected Attributes inherited from CanvasWidget
uint8_t | alpha |
The Alpha for this CanvasWidget. | |
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. | |
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. | |
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 | 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 | invalidateContent() const |
Tell the framework that the contents of the 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
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.
Reimplements: touchgfx::AbstractShape::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.
Reimplements: touchgfx::AbstractShape::getCornerY
getNumPoints
virtual int getNumPoints | ( | ) | const |
Gets number of points used to make up the shape.
The number of points.
Reimplements: touchgfx::AbstractShape::getNumPoints
setCorner
virtual void setCorner | ( | int | i , | ||
CWRUtil::Q5 | x , | ||||
CWRUtil::Q5 | y | ||||
) |
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.
Reimplements: touchgfx::AbstractShape::setCorner
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.
Reimplements: touchgfx::AbstractShape::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.
Reimplements: touchgfx::AbstractShape::getCacheY
setCache
virtual void setCache | ( | int | i , | ||
CWRUtil::Q5 | x , | ||||
CWRUtil::Q5 | y | ||||
) |
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. |
Reimplements: touchgfx::AbstractShape::setCache