GraphElementGridY

GraphElementGridY draws horizontal lines at selected intervals along the y axis. By combining two GraphElementGridY instances, it is possible to have minor and major grid lines.

Note: The grid lines are drawn using LCD::fillRect for higher performance.

Inherits from: GraphElementGridBase, AbstractGraphElementNoCWR, AbstractGraphElement, CanvasWidget, Widget, Drawable

Public Functions


virtual void	draw(const Rect & invalidatedArea) const
	Draws the given invalidated area.

Protected Functions


void	drawLine(const Rect & invalidatedArea, int16_t xMin, int16_t yMin, int16_t width, int16_t length, colortype color, uint8_t alpha) const
	Draw horizontal line using LCD::fillRect and handles negative dimensions properly.

Additional inherited members

Public Functions inherited from GraphElementGridBase


float	getIntervalAsFloat() const
	Gets the interval between each grid line.

int	getIntervalAsInt() const
	Gets the interval between each grid line.

uint8_t	getLineWidth() const
	Gets line width.

	GraphElementGridBase()


virtual void	invalidateGraphPointAt(int16_t index)
	Invalidate the point at the given index.

void	setInterval(float interval)
	Sets the interval between each grid line.

void	setInterval(int interval)
	Sets the interval between each grid line.

void	setLineWidth(uint8_t width)
	Sets line width of the grid lines.

void	setMajorGrid(const GraphElementGridBase & major)
	Sets "major" grid that will be responsible for drawing major grid lines.

Protected Functions inherited from GraphElementGridBase


int	getCorrectlyScaledMajorInterval(const AbstractDataGraph * graph) const
	Gets correctly scaled major interval, as the major grid may have a scale that differs the scale of the graph and this grid line.

int	getIntervalScaled() const
	Gets the interval between each grid line.

void	setIntervalScaled(int interval)
	Sets the interval between each grid line.

Protected Attributes inherited from GraphElementGridBase


int	gridInterval
	The grid line interval.

uint8_t	lineWidth
	Width of the line.

const GraphElementGridBase *	majorGrid
	A pointer to a major grid, if any.

Public Functions inherited from AbstractGraphElementNoCWR


	AbstractGraphElementNoCWR()


virtual bool	drawCanvasWidget(const Rect & invalidatedArea) const
	Draw canvas widget for the given invalidated area.

virtual colortype	getColor() const
	Gets the color of the graph element.

virtual void	setColor(colortype newColor)
	Sets the color of the graph element.

Protected Functions inherited from AbstractGraphElementNoCWR


void	normalizeRect(Rect & rect) const
	Normalize rectangle by changing a rectangle with negative width or height to a rectangle with positive width or height at the correct position.

virtual void	setPainter(AbstractPainter & painter)
	Protected function to prevent users from setting a painter.

Protected Attributes inherited from AbstractGraphElementNoCWR


colortype	color
	The currently assigned color.

Public Functions inherited from AbstractGraphElement


	AbstractGraphElement()


int	getScale() const
	Gets the scaling factor set using setScale.

virtual void	invalidateGraphPointAt(int16_t index) =0
	Invalidate the point at the given index.

void	setScale(int scale)
	Sets a scaling factor to be multiplied on each added element.

Protected Functions inherited from AbstractGraphElement


int	convertToGraphScale(const AbstractDataGraph * graph, int value, int scale) const
	Converts a number with one scale to a number that has the same scale as the graph.

AbstractDataGraph *	getGraph() const
	Gets a pointer to the the graph containing the GraphElement.

int	getGraphRangeYMaxScaled(const AbstractDataGraph * graph) const
	Gets maximum y coordinate for the graph.

int	getGraphRangeYMinScaled(const AbstractDataGraph * graph) const
	Gets minimum y coordinate for the graph.

int	getGraphXAxisOffsetScaled(const AbstractDataGraph * graph) const
	Get x axis offset as a scaled value.

int	getGraphXAxisScaleScaled(const AbstractDataGraph * graph) const
	Get x axis scale as a scaled value.

CWRUtil::Q5	indexToScreenXQ5(const AbstractDataGraph * graph, int16_t index) const
	Gets screen x coordinate for a specific data point added to the graph.

CWRUtil::Q5	indexToScreenYQ5(const AbstractDataGraph * graph, int16_t index) const
	Gets screen y coordinate for a specific data point added to the graph.

bool	isCenterInvisible(const AbstractDataGraph * graph, int16_t index) const
	Query if the center of a given data point index is visible inside the graph area.

Rect	rectAround(CWRUtil::Q5 xQ5, CWRUtil::Q5 yQ5, CWRUtil::Q5 diameterQ5) const
	Find the screen rectangle around a given point with the specified diameter.

Rect	rectFromQ5Coordinates(CWRUtil::Q5 screenXminQ5, CWRUtil::Q5 screenYminQ5, CWRUtil::Q5 screenXmaxQ5, CWRUtil::Q5 screenYmaxQ5) const
	Find the screen rectangle containing the Q5 screen rectangle by rounding the coordinates up/down.

CWRUtil::Q5	roundQ5(CWRUtil::Q5 q5) const
	Round the given CWRUtil::Q5 to the nearest integer and return it as a CWRUtil::Q5 instead of an integer.

CWRUtil::Q5	valueToScreenXQ5(const AbstractDataGraph * graph, int x) const
	Gets graph screen x for x value.

CWRUtil::Q5	valueToScreenYQ5(const AbstractDataGraph * graph, int y) const
	Gets graph screen y for y value.

bool	xScreenRangeToIndexRange(int16_t xLow, int16_t xHigh, int16_t & elementLow, int16_t & elementHigh) const
	Gets graph element range for screen x coordinate range.

Protected Attributes inherited from AbstractGraphElement


int	dataScale
	The scaling factor.

Public Functions inherited from CanvasWidget


	CanvasWidget()


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.

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.


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.

	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

draw

Draws the given invalidated area.

If the underlying CanvasWidgetRenderer fail to render the widget (if the widget is too complex), the invalidated area is cut into smaller slices (horizontally) which are then drawn separately. If drawing a single raster line fails, that line is considered too complex and skipped (it is left blank/transparent) and drawing continues on the next raster line.

If drawing has failed at least once, which means that the number of horizontal lines draw has been reduced, the number of successfully drawn horizontal lines is remembered for the next invocation of draw(). A future call to draw() would then start off with the reduced number of horizontal lines to prevent potentially drawing the canvas widget in vain, as happened previously in draw().

Parameters:


invalidatedArea	The invalidated area.

Note

Subclasses of CanvasWidget should implement drawCanvasWidget(), not draw(). The term "too complex" means that the size of the buffer (assigned to CanvasWidgetRenderer using CanvasWidgetRenderer::setupBuffer()) is too small.

Protected Functions Documentation

drawLine


void drawLine	(	const Rect &	invalidatedArea ,	const
		int16_t	xMin ,	const
		int16_t	yMin ,	const
		int16_t	width ,	const
		int16_t	length ,	const
		colortype	color ,	const
		uint8_t	alpha	const
		)	const

Draw horizontal line using LCD::fillRect and handles negative dimensions properly.

Parameters:


invalidatedArea	The invalidated area to intersect the line with.
xMin	The minimum x coordinate.
yMin	The minimum y coordinate.
width	The width of the line.
length	The length of the line.
color	The color of the line.
alpha	The alpha of the line.

Public Functions​

Protected Functions​

Additional inherited members​

Public Functions inherited from GraphElementGridBase​

Protected Functions inherited from GraphElementGridBase​

Protected Attributes inherited from GraphElementGridBase​

Public Functions inherited from AbstractGraphElementNoCWR​

Protected Functions inherited from AbstractGraphElementNoCWR​

Protected Attributes inherited from AbstractGraphElementNoCWR​

Public Functions inherited from AbstractGraphElement​

Protected Functions inherited from AbstractGraphElement​

Protected Attributes inherited from AbstractGraphElement​

Public Functions inherited from CanvasWidget​

Public Functions inherited from Widget​

Public Functions inherited from Drawable​

Protected Attributes inherited from Drawable​

Public Functions Documentation​

draw​