GridXY Class Reference

Grid class, x- and y-axis. More...

#include <hV_Utilities.h>

Public Member Functions
	GridXY ()
void	define (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint16_t nX, uint16_t nY, bool flagAdjust=false)
	Define the grid.
uint16_t	dX (uint16_t i=1)
	Get size for number of divisions, x-axis.
uint16_t	dY (uint16_t i=1)
	Get size for number of divisions, y-axis.
uint16_t	x (uint16_t i=0)
	Get coordinate at division, x-axis.
uint16_t	y (uint16_t i=0)
	Get coordinate at division, y-axis.

Detailed Description

Grid class, x- and y-axis.

Constructor & Destructor Documentation

GridXY()

GridXY::GridXY

(

)

Constructor

Member Function Documentation

define()

void GridXY::define	(	uint16_t	x0,
		uint16_t	y0,
		uint16_t	dx,
		uint16_t	dy,
		uint16_t	nX,
		uint16_t	nY,
		bool	flagAdjust = false )

Define the grid.

Parameters

x0	origin coordinate, x-axis
y0	origin coordinate, y-axis
dx	size of the grid, x-axis
dy	size of the grid, y-axis
nX	number of divisions in x-axis
nY	number of divisions in y-axis
flagAdjust	adjust origin, default false

dX()

uint16_t GridXY::dX

(

uint16_t

i = 1

)

Get size for number of divisions, x-axis.

Parameters

i	number of divisions, 0..n

Returns

pixels of the divisions

Note

No check on i <= n

dY()

uint16_t GridXY::dY

(

uint16_t

i = 1

)

Get size for number of divisions, y-axis.

Parameters

i	number of divisions, 0..n

Returns

pixels of the divisions

Note

No check on i <= n

x()

uint16_t GridXY::x

(

uint16_t

i = 0

)

Get coordinate at division, x-axis.

Parameters

i	index of the division, 0..n-1

Returns

coordinate of the start of the division

Note

No check on i < n

y()

uint16_t GridXY::y

(

uint16_t

i = 0

)

Get coordinate at division, y-axis.

Parameters

i	index of the division, 0..n-1

Returns

coordinate of the start of the division

Note

No check on i < n

---

The documentation for this class was generated from the following file:

• hV_Utilities.h