Used to manage a list of rectangular areas and optimize them for drawing to the screen. More...

#include <IGraphicsStructs.h>

Public Member Functions
	IRECTList (const IRECTList &)=delete

IRECTList &	operator= (const IRECTList &)=delete

int	Size () const

void	Add (const IRECT &rect)
	Add a rectangle to the list. More...

void	Set (int idx, const IRECT &rect)
	Set a specific rectangle in the list (will crash if idx is invalid) More...

const IRECT &	Get (int idx) const
	Get an IRECT from the list (will crash if idx is invalid) More...

void	Clear ()
	Clear the list. More...

IRECT	Bounds ()
	Get a union of all rectangles in the list. More...

void	PixelAlign ()
	Align the rectangles to pixel boundaries. More...

void	PixelAlign (float scale)
	Pixel-align the IRECTs at the given scale factor then scale them back down. More...

int	Find (float x, float y) const
	Find the first index of the rect that contains point x, y, if it exists. More...

void	Optimize ()
	Remove rects that are contained by other rects and intersections and merge any rects that can be merged. More...

Static Public Member Functions
static bool	GetFracGrid (const IRECT &input, IRECTList &rects, const std::initializer_list< float > &rowFractions, const std::initializer_list< float > &colFractions, EDirection layoutDir=EDirection::Horizontal)
	Fill an IRECTList with divisons of an input IRECT. More...

Detailed Description

Used to manage a list of rectangular areas and optimize them for drawing to the screen.

Definition at line 1729 of file IGraphicsStructs.h.

Constructor & Destructor Documentation

◆ IRECTList()

IRECTList::IRECTList ( )

inline

Definition at line 1732 of file IGraphicsStructs.h.

Member Function Documentation

◆ Add()

void IRECTList::Add ( const IRECT & rect )

inline

Add a rectangle to the list.

Parameters

rect	The IRECT to add

Definition at line 1743 of file IGraphicsStructs.h.

Referenced by IGraphics::AttachGestureRecognizerToRegion(), GetFracGrid(), and IGraphics::IsDirty().

◆ Bounds()

IRECT IRECTList::Bounds ( )

inline

Get a union of all rectangles in the list.

Returns: IRECT Union of all rectangles in the list

Definition at line 1772 of file IGraphicsStructs.h.

References Get(), and IRECT::Union().

Referenced by IGraphics::Draw(), and GetFracGrid().

◆ Clear()

void IRECTList::Clear ( )

inline

Clear the list.

Definition at line 1765 of file IGraphicsStructs.h.

Referenced by IGraphics::ClearGestureRegions().

◆ Find()

int IRECTList::Find	(	float	x,
		float	y
	)		const

inline

Find the first index of the rect that contains point x, y, if it exists.

Parameters

x	Horizontal position to check
y	Vertical position to check

Returns: integer index of rect that contains point x,y or -1 if not found

Definition at line 1807 of file IGraphicsStructs.h.

References IRECT::Contains(), Get(), and Size().

Referenced by IGraphics::OnGestureRecognized(), and IGraphics::RespondsToGesture().

◆ Get()

const IRECT & IRECTList::Get ( int idx ) const

inline

Get an IRECT from the list (will crash if idx is invalid)

Parameters

idx	The index to get

Returns: const IRECT& The IRECT at idx

Definition at line 1759 of file IGraphicsStructs.h.

Referenced by Bounds(), IGraphics::Draw(), Find(), Optimize(), and PixelAlign().

◆ GetFracGrid()

static bool IRECTList::GetFracGrid	(	const IRECT &	input,
		IRECTList &	rects,
		const std::initializer_list< float > &	rowFractions,
		const std::initializer_list< float > &	colFractions,
		EDirection	layoutDir = `EDirection::Horizontal`
	)

inlinestatic

Fill an IRECTList with divisons of an input IRECT.

Parameters

input	The input rectangle
rects	The output IRECTList
rowFractions	Initializer list of fractions for the grid rows (should sum to 1.0)
colFractions	Initializer list of fractions for the grid columns (should sum to 1.0)
layoutDir	By default the cell idx increases horizontally (by row). If set to EDirection::Vertical, cell idx increases vertically (by column).