juce::RectangleList< ValueType > Class Template Reference

Maintains a set of rectangles as a complex region. More...

#include <juce_RectangleList.h>

Inheritance diagram for juce::RectangleList< ValueType >:

Collaboration diagram for juce::RectangleList< ValueType >:

Public Types
using	RectangleType = Rectangle< ValueType >

Public Member Functions
	RectangleList ()=default
	Creates an empty RectangleList.
	RectangleList (const RectangleList &other)
	Creates a copy of another list.
	RectangleList (RectangleList &&other) noexcept
	Move constructor.
	RectangleList (RectangleType rect)
	Creates a list containing just one rectangle.
void	add (const RectangleList &other)
	Merges another rectangle list into this one.
void	add (RectangleType rect)
	Merges a new rectangle into the list.
void	add (ValueType x, ValueType y, ValueType width, ValueType height)
	Merges a new rectangle into the list.
void	addWithoutMerging (RectangleType rect)
	Dumbly adds a rectangle to the list without checking for overlaps.
const RectangleType *	begin () const noexcept
	Standard method for iterating the rectangles in the list.
void	clear ()
	Removes all rectangles to leave an empty region.
template<typename OtherValueType >
bool	clipTo (const RectangleList< OtherValueType > &other)
	Removes any areas of the region that lie outside a given rectangle list.
bool	clipTo (RectangleType rect)
	Removes any areas of the region that lie outside a given rectangle.
void	consolidate ()
	Optimises the list into a minimum number of constituent rectangles.
bool	containsPoint (Point< ValueType > point) const noexcept
	Checks whether the region contains a given point.
bool	containsPoint (ValueType x, ValueType y) const noexcept
	Checks whether the region contains a given point.
bool	containsRectangle (RectangleType rectangleToCheck) const
	Checks whether the region contains the whole of a given rectangle.
const RectangleType *	end () const noexcept
	Standard method for iterating the rectangles in the list.
void	ensureStorageAllocated (int minNumRectangles)
	Increases the internal storage to hold a minimum number of rectangles.
RectangleType	getBounds () const noexcept
	Returns the smallest rectangle that can enclose the whole of this region.
bool	getIntersectionWith (RectangleType rect, RectangleList &destRegion) const
	Creates a region which is the result of clipping this one to a given rectangle.
int	getNumRectangles () const noexcept
	Returns the number of rectangles in the list.
RectangleType	getRectangle (int index) const noexcept
	Returns one of the rectangles at a particular index.
bool	intersects (const RectangleList &other) const noexcept
	Checks whether this region intersects any part of another one.
bool	intersectsRectangle (RectangleType rectangleToCheck) const noexcept
	Checks whether the region contains any part of a given rectangle.
bool	isEmpty () const noexcept
	Returns true if the region is empty.
void	offsetAll (Point< ValueType > offset) noexcept
	Adds an x and y value to all the coordinates.
void	offsetAll (ValueType dx, ValueType dy) noexcept
	Adds an x and y value to all the coordinates.
RectangleList &	operator= (const RectangleList &other)
	Copies this list from another one.
RectangleList &	operator= (RectangleList &&other) noexcept
	Move assignment operator.
template<typename ScaleType >
void	scaleAll (ScaleType scaleFactor) noexcept
	Scales all the coordinates.
bool	subtract (const RectangleList &otherList)
	Removes all areas in another RectangleList from this one.
void	subtract (const RectangleType rect)
	Removes a rectangular region from the list.
void	swapWith (RectangleList &otherList) noexcept
	Swaps the contents of this and another list.
Path	toPath () const
	Creates a Path object to represent this region.
void	transformAll (const AffineTransform &transform) noexcept
	Applies a transform to all the rectangles.

Private Attributes
Array< RectangleType >	rects

Detailed Description

template<typename ValueType>
class juce::RectangleList< ValueType >

Maintains a set of rectangles as a complex region.

This class allows a set of rectangles to be treated as a solid shape, and can add and remove rectangular sections of it, and simplify overlapping or adjacent rectangles.

See also

Rectangle

@tags{Graphics}

Member Typedef Documentation

RectangleType

template<typename ValueType >

using juce::RectangleList< ValueType >::RectangleType = Rectangle<ValueType>

Constructor & Destructor Documentation

RectangleList() [1/4]

template<typename ValueType >

juce::RectangleList< ValueType >::RectangleList ( )

default

Creates an empty RectangleList.

RectangleList() [2/4]

template<typename ValueType >

juce::RectangleList< ValueType >::RectangleList ( const RectangleList< ValueType > &  other )

inline

Creates a copy of another list.

RectangleList() [3/4]

template<typename ValueType >

juce::RectangleList< ValueType >::RectangleList ( RectangleType  rect )

inline

Creates a list containing just one rectangle.

References juce::RectangleList< ValueType >::addWithoutMerging().

RectangleList() [4/4]

template<typename ValueType >

juce::RectangleList< ValueType >::RectangleList ( RectangleList< ValueType > &&  other )

inlinenoexcept

Move constructor.

Member Function Documentation

add() [1/3]

template<typename ValueType >

void juce::RectangleList< ValueType >::add ( const RectangleList< ValueType > &  other )

inline

Merges another rectangle list into this one.

Any overlaps between the two lists will be clipped, so that the result is the union of both lists.

References juce::RectangleList< ValueType >::add().

add() [2/3]

template<typename ValueType >

void juce::RectangleList< ValueType >::add ( RectangleType  rect )

inline

Merges a new rectangle into the list.

The rectangle being added will first be clipped to remove any parts of it that overlap existing rectangles in the list, and adjacent rectangles will be merged into it.

The rectangle can have any size and may be empty, but if it's floating point then it's expected to not contain any INF values.

References juce::Rectangle< ValueType >::contains(), juce::Rectangle< ValueType >::intersects(), juce::Rectangle< ValueType >::isEmpty(), juce::RectangleList< ValueType >::isEmpty(), juce::Rectangle< ValueType >::isFinite(), jassert, and juce::RectangleList< ValueType >::rects.

Referenced by juce::RectangleList< ValueType >::add(), juce::RectangleList< ValueType >::add(), juce::Direct2DGraphicsContext::PendingClipList::clipTo(), and juce::CoreGraphicsMetalLayerRenderer::drawRectangleList().

add() [3/3]

template<typename ValueType >

void juce::RectangleList< ValueType >::add ( ValueType  x, ValueType  y, ValueType  width, ValueType  height  )

inline

Merges a new rectangle into the list.

The rectangle being added will first be clipped to remove any parts of it that overlap existing rectangles in the list.

References juce::RectangleList< ValueType >::add().

addWithoutMerging()

template<typename ValueType >

void juce::RectangleList< ValueType >::addWithoutMerging ( RectangleType  rect )

inline

Dumbly adds a rectangle to the list without checking for overlaps.

This simply adds the rectangle to the end, it doesn't merge it or remove any overlapping bits.

The rectangle can have any size and may be empty, but if it's floating point then it's expected to not contain any INF values.

References juce::Rectangle< ValueType >::isEmpty(), juce::Rectangle< ValueType >::isFinite(), jassert, and juce::RectangleList< ValueType >::rects.

Referenced by juce::RectangleList< ValueType >::RectangleList(), and juce::LowLevelGraphicsContext::drawRect().

begin()

template<typename ValueType >

const RectangleType * juce::RectangleList< ValueType >::begin ( ) const

inlinenoexcept

Standard method for iterating the rectangles in the list.

References juce::RectangleList< ValueType >::rects.

clear()

template<typename ValueType >

void juce::RectangleList< ValueType >::clear ( )

inline

Removes all rectangles to leave an empty region.

References juce::RectangleList< ValueType >::rects.

Referenced by juce::Direct2DGraphicsContext::PendingClipList::clipTo(), juce::RectangleList< ValueType >::clipTo(), juce::CoreGraphicsMetalLayerRenderer::drawRectangleList(), juce::RectangleList< ValueType >::getIntersectionWith(), juce::detail::StandardCachedComponentImage::invalidateAll(), and juce::detail::StandardCachedComponentImage::paint().

clipTo() [1/2]

template<typename ValueType >

template<typename OtherValueType >

bool juce::RectangleList< ValueType >::clipTo ( const RectangleList< OtherValueType > &  other )

inline

Removes any areas of the region that lie outside a given rectangle list.

Any rectangles in this object which overlap the specified list will be clipped and subdivided if necessary.

Returns true if the resulting region is not empty, false if it is empty.

See also

getIntersectionWith

References juce::RectangleList< ValueType >::isEmpty(), juce::RectangleList< ValueType >::rects, and juce::RectangleList< ValueType >::swapWith().

clipTo() [2/2]

template<typename ValueType >

bool juce::RectangleList< ValueType >::clipTo ( RectangleType  rect )

inline

Removes any areas of the region that lie outside a given rectangle.

Any rectangles in the list which overlap this will be clipped and subdivided if necessary.

Returns true if the resulting region is not empty, false if it is empty.

See also

getIntersectionWith

References juce::RectangleList< ValueType >::clear(), juce::Rectangle< ValueType >::intersectRectangle(), juce::Rectangle< ValueType >::isEmpty(), juce::Rectangle< ValueType >::isFinite(), jassert, and juce::RectangleList< ValueType >::rects.

Referenced by juce::Direct2DGraphicsContext::PendingClipList::clipTo(), juce::Direct2DGraphicsContext::PendingClipList::clipTo(), juce::RenderingHelpers::ClipRegions::RectangleListRegion< SavedStateType >::clipToRectangle(), and juce::RenderingHelpers::ClipRegions::RectangleListRegion< SavedStateType >::clipToRectangleList().

consolidate()

template<typename ValueType >

void juce::RectangleList< ValueType >::consolidate ( )

inline

Optimises the list into a minimum number of constituent rectangles.

This will try to combine any adjacent rectangles into larger ones where possible, to simplify lists that might have been fragmented by repeated add/subtract calls.

References juce::RectangleList< ValueType >::rects.

containsPoint() [1/2]

template<typename ValueType >

bool juce::RectangleList< ValueType >::containsPoint ( Point< ValueType >  point ) const

inlinenoexcept

Checks whether the region contains a given point.

Returns

true if the point lies within one of the rectangles in the list

References juce::RectangleList< ValueType >::rects.

Referenced by juce::RectangleList< ValueType >::containsPoint().

containsPoint() [2/2]

template<typename ValueType >

bool juce::RectangleList< ValueType >::containsPoint ( ValueType  x, ValueType  y  ) const

inlinenoexcept

Checks whether the region contains a given point.

Returns

true if the point lies within one of the rectangles in the list

References juce::RectangleList< ValueType >::containsPoint().

containsRectangle()

template<typename ValueType >

bool juce::RectangleList< ValueType >::containsRectangle ( RectangleType  rectangleToCheck ) const

inline

Checks whether the region contains the whole of a given rectangle.

Returns

true all parts of the rectangle passed in lie within the region defined by this object

See also

intersectsRectangle, containsPoint

References juce::RectangleList< ValueType >::isEmpty(), and juce::RectangleList< ValueType >::rects.

Referenced by juce::detail::StandardCachedComponentImage::paint().

end()

template<typename ValueType >

const RectangleType * juce::RectangleList< ValueType >::end ( ) const

inlinenoexcept

Standard method for iterating the rectangles in the list.

References juce::RectangleList< ValueType >::rects.

ensureStorageAllocated()

template<typename ValueType >

void juce::RectangleList< ValueType >::ensureStorageAllocated ( int  minNumRectangles )

inline

Increases the internal storage to hold a minimum number of rectangles.

Calling this before adding a large number of rectangles means that the array won't have to keep dynamically resizing itself as the elements are added, and it'll therefore be more efficient.

See also

Array::ensureStorageAllocated

References juce::RectangleList< ValueType >::rects.

getBounds()

template<typename ValueType >

RectangleType juce::RectangleList< ValueType >::getBounds ( ) const

inlinenoexcept

Returns the smallest rectangle that can enclose the whole of this region.

References juce::RectangleList< ValueType >::isEmpty(), juce::jmax(), juce::jmin(), and juce::RectangleList< ValueType >::rects.

Referenced by juce::RenderingHelpers::ClipRegions::RectangleListRegion< SavedStateType >::getClipBounds().

getIntersectionWith()

template<typename ValueType >

bool juce::RectangleList< ValueType >::getIntersectionWith ( RectangleType  rect, RectangleList< ValueType > &  destRegion  ) const

inline

Creates a region which is the result of clipping this one to a given rectangle.

Unlike the other clipTo method, this one doesn't affect this object - it puts the resulting region into the list whose reference is passed-in.

Returns true if the resulting region is not empty, false if it is empty.

See also

clipTo

References juce::RectangleList< ValueType >::clear(), juce::Rectangle< ValueType >::intersectRectangle(), juce::Rectangle< ValueType >::isEmpty(), juce::RectangleList< ValueType >::isEmpty(), juce::Rectangle< ValueType >::isFinite(), jassert, and juce::RectangleList< ValueType >::rects.

getNumRectangles()

template<typename ValueType >

int juce::RectangleList< ValueType >::getNumRectangles ( ) const

inlinenoexcept

Returns the number of rectangles in the list.

References juce::RectangleList< ValueType >::rects.

Referenced by juce::UIATextProvider::UIATextRangeProvider::GetBoundingRectangles().

getRectangle()

template<typename ValueType >

RectangleType juce::RectangleList< ValueType >::getRectangle ( int  index ) const

inlinenoexcept

Returns one of the rectangles at a particular index.

Returns

the rectangle at the index, or an empty rectangle if the index is out-of-range.

References juce::RectangleList< ValueType >::rects.

intersects()

template<typename ValueType >

bool juce::RectangleList< ValueType >::intersects ( const RectangleList< ValueType > &  other ) const

inlinenoexcept

Checks whether this region intersects any part of another one.

See also

intersectsRectangle

References juce::RectangleList< ValueType >::rects.

Referenced by juce::RenderingHelpers::ClipRegions::RectangleListRegion< SavedStateType >::clipRegionIntersects().

intersectsRectangle()

template<typename ValueType >

bool juce::RectangleList< ValueType >::intersectsRectangle ( RectangleType  rectangleToCheck ) const

inlinenoexcept

Checks whether the region contains any part of a given rectangle.

Returns

true if any part of the rectangle passed in lies within the region defined by this object

See also

containsRectangle

References juce::RectangleList< ValueType >::rects.

isEmpty()

template<typename ValueType >

bool juce::RectangleList< ValueType >::isEmpty ( ) const

inlinenoexcept

Returns true if the region is empty.

References juce::RectangleList< ValueType >::rects.

Referenced by juce::RectangleList< ValueType >::add(), juce::RectangleList< ValueType >::clipTo(), juce::RenderingHelpers::ClipRegions::RectangleListRegion< SavedStateType >::clipToRectangle(), juce::RenderingHelpers::ClipRegions::RectangleListRegion< SavedStateType >::clipToRectangleList(), juce::RectangleList< ValueType >::containsRectangle(), juce::RenderingHelpers::ClipRegions::RectangleListRegion< SavedStateType >::excludeClipRectangle(), juce::RectangleList< ValueType >::getBounds(), juce::RectangleList< ValueType >::getIntersectionWith(), and juce::RectangleList< ValueType >::subtract().

offsetAll() [1/2]

template<typename ValueType >

void juce::RectangleList< ValueType >::offsetAll ( Point< ValueType >  offset )

inlinenoexcept

Adds an x and y value to all the coordinates.

References juce::RectangleList< ValueType >::rects.

Referenced by juce::RenderingHelpers::SavedStateBase< SavedStateType >::clipToRectangleList(), juce::RenderingHelpers::SavedStateBase< SavedStateType >::fillRectList(), juce::RectangleList< ValueType >::offsetAll(), and juce::RenderingHelpers::ClipRegions::RectangleListRegion< SavedStateType >::translate().

offsetAll() [2/2]

template<typename ValueType >

void juce::RectangleList< ValueType >::offsetAll ( ValueType  dx, ValueType  dy  )

inlinenoexcept

Adds an x and y value to all the coordinates.

References juce::RectangleList< ValueType >::offsetAll().

operator=() [1/2]

template<typename ValueType >

RectangleList & juce::RectangleList< ValueType >::operator= ( const RectangleList< ValueType > &  other )

inline

Copies this list from another one.

References juce::RectangleList< ValueType >::rects.

operator=() [2/2]

template<typename ValueType >

RectangleList & juce::RectangleList< ValueType >::operator= ( RectangleList< ValueType > &&  other )

inlinenoexcept

Move assignment operator.

References juce::RectangleList< ValueType >::rects.

scaleAll()

template<typename ValueType >

template<typename ScaleType >

void juce::RectangleList< ValueType >::scaleAll ( ScaleType  scaleFactor )

inlinenoexcept

Scales all the coordinates.

References juce::RectangleList< ValueType >::rects.

subtract() [1/2]

template<typename ValueType >

bool juce::RectangleList< ValueType >::subtract ( const RectangleList< ValueType > &  otherList )

inline

Removes all areas in another RectangleList from this one.

Any rectangles in the list which overlap this will be clipped and subdivided if necessary.

Returns

true if the resulting list is non-empty.

References juce::RectangleList< ValueType >::isEmpty(), and juce::RectangleList< ValueType >::subtract().

subtract() [2/2]

template<typename ValueType >

void juce::RectangleList< ValueType >::subtract ( const RectangleType  rect )

inline

Removes a rectangular region from the list.

Any rectangles in the list which overlap this will be clipped and subdivided if necessary.

References juce::Rectangle< ValueType >::getHeight(), juce::Rectangle< ValueType >::getWidth(), juce::Rectangle< ValueType >::getX(), juce::Rectangle< ValueType >::getY(), juce::ignoreUnused(), and juce::RectangleList< ValueType >::rects.

Referenced by juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToRectangleList(), juce::RenderingHelpers::ClipRegions::RectangleListRegion< SavedStateType >::excludeClipRectangle(), juce::detail::StandardCachedComponentImage::invalidate(), juce::RectangleList< ValueType >::subtract(), and juce::Direct2DGraphicsContext::PendingClipList::subtract().

swapWith()

template<typename ValueType >

void juce::RectangleList< ValueType >::swapWith ( RectangleList< ValueType > &  otherList )

inlinenoexcept

Swaps the contents of this and another list.

This swaps their internal pointers, so is hugely faster than using copy-by-value to swap them.

References juce::RectangleList< ValueType >::rects.

Referenced by juce::RectangleList< ValueType >::clipTo().

toPath()

template<typename ValueType >

Path juce::RectangleList< ValueType >::toPath ( ) const

inline

Creates a Path object to represent this region.

References juce::RectangleList< ValueType >::rects.

transformAll()

template<typename ValueType >

void juce::RectangleList< ValueType >::transformAll ( const AffineTransform &  transform )

inlinenoexcept

Applies a transform to all the rectangles.

Obviously this will create a mess if the transform involves any rotation or skewing.

References juce::RectangleList< ValueType >::rects.

Referenced by juce::RenderingHelpers::SavedStateBase< SavedStateType >::fillRectList().

Member Data Documentation

rects

template<typename ValueType >

Array<RectangleType> juce::RectangleList< ValueType >::rects

private

Referenced by juce::RectangleList< ValueType >::add(), juce::RectangleList< ValueType >::addWithoutMerging(), juce::RectangleList< ValueType >::begin(), juce::RectangleList< ValueType >::clear(), juce::RectangleList< ValueType >::clipTo(), juce::RectangleList< ValueType >::clipTo(), juce::RectangleList< ValueType >::consolidate(), juce::RectangleList< ValueType >::containsPoint(), juce::RectangleList< ValueType >::containsRectangle(), juce::RectangleList< ValueType >::end(), juce::RectangleList< ValueType >::ensureStorageAllocated(), juce::RectangleList< ValueType >::getBounds(), juce::RectangleList< ValueType >::getIntersectionWith(), juce::RectangleList< ValueType >::getNumRectangles(), juce::RectangleList< ValueType >::getRectangle(), juce::RectangleList< ValueType >::intersects(), juce::RectangleList< ValueType >::intersectsRectangle(), juce::RectangleList< ValueType >::isEmpty(), juce::RectangleList< ValueType >::offsetAll(), juce::RectangleList< ValueType >::operator=(), juce::RectangleList< ValueType >::operator=(), juce::RectangleList< ValueType >::scaleAll(), juce::RectangleList< ValueType >::subtract(), juce::RectangleList< ValueType >::swapWith(), juce::RectangleList< ValueType >::toPath(), and juce::RectangleList< ValueType >::transformAll().

---

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

• juce_RectangleList.h