#include <hikogui/geometry/axis_aligned_rectangle.hpp>

Public Types
using	value_type = float

using	array_type = f32x4

Public Member Functions
constexpr	axis_aligned_rectangle (axis_aligned_rectangle const &rhs) noexcept=default

constexpr axis_aligned_rectangle &	operator= (axis_aligned_rectangle const &rhs) noexcept=default

constexpr	axis_aligned_rectangle (axis_aligned_rectangle &&rhs) noexcept=default

constexpr axis_aligned_rectangle &	operator= (axis_aligned_rectangle &&rhs) noexcept=default

constexpr	axis_aligned_rectangle (array_type const &other) noexcept

constexpr	axis_aligned_rectangle (value_type x, value_type y, value_type width, value_type height) noexcept
	Create a box from the position and size.

constexpr	axis_aligned_rectangle (extent< value_type, 2 > const &extent) noexcept
	Create a rectangle from the size.

constexpr	axis_aligned_rectangle (point< value_type, 2 > const &p0, point< value_type, 2 > const &p3) noexcept
	Create a rectangle from the left-bottom and right-top points.

constexpr	axis_aligned_rectangle (point< value_type, 2 > const &p0, extent< value_type, 2 > const &extent) noexcept
	Create a rectangle from the size.

constexpr	operator array_type () const noexcept

constexpr bool	holds_invariant () const noexcept
	Make sure p0 is left/bottom from p3.

constexpr bool	empty () const noexcept
	Check if the rectangle has no area.

constexpr	operator bool () const noexcept
	True when the rectangle has an area.

constexpr axis_aligned_rectangle &	operator\|= (axis_aligned_rectangle const &rhs) noexcept
	Expand the current rectangle to include the new rectangle.

constexpr axis_aligned_rectangle &	operator\|= (point< value_type, 2 > const &rhs) noexcept
	Expand the current rectangle to include the new rectangle.

constexpr point< value_type, 2 >	operator[] (std::size_t i) const noexcept

constexpr extent< value_type, 2 >	size () const noexcept
	Get size of the rectangle.

constexpr value_type	x () const noexcept

constexpr value_type	y () const noexcept

constexpr value_type	width () const noexcept

constexpr value_type	height () const noexcept

constexpr value_type	bottom () const noexcept

constexpr value_type	top () const noexcept

constexpr value_type	left () const noexcept

constexpr value_type	right () const noexcept

constexpr value_type	middle () const noexcept
	The middle on the y-axis between bottom and top.

constexpr value_type	center () const noexcept
	The center on the x-axis between left and right.

constexpr axis_aligned_rectangle &	set_width (value_type newWidth) noexcept

constexpr axis_aligned_rectangle &	set_height (value_type newHeight) noexcept

constexpr bool	contains (point< value_type, 2 > const &rhs) const noexcept
	Check if a 2D coordinate is inside the rectangle.

constexpr bool	contains (point< value_type, 3 > const &rhs) const noexcept
	Check if a 3D coordinate is inside the rectangle.

Static Public Member Functions
static constexpr axis_aligned_rectangle	large () noexcept
	Create a large axis aligned rectangle.

static constexpr axis_aligned_rectangle	_align (axis_aligned_rectangle outside, axis_aligned_rectangle inside, alignment alignment) noexcept
	Need to call the hidden friend function from within another class.

Friends
template<int I>
constexpr friend point< value_type, 2 >	get (axis_aligned_rectangle const &rhs) noexcept

constexpr friend point< value_type, 2 >	midpoint (axis_aligned_rectangle const &rhs) noexcept
	Get the center of the rectangle.

constexpr axis_aligned_rectangle	align (axis_aligned_rectangle haystack, extent< value_type, 2 > needle, alignment alignment) noexcept
	Align a rectangle within another rectangle.

constexpr axis_aligned_rectangle	align (axis_aligned_rectangle haystack, axis_aligned_rectangle needle, alignment alignment) noexcept
	Align a rectangle within another rectangle.

constexpr bool	operator== (axis_aligned_rectangle const &lhs, axis_aligned_rectangle const &rhs) noexcept

constexpr bool	overlaps (axis_aligned_rectangle const &lhs, axis_aligned_rectangle const &rhs) noexcept

constexpr axis_aligned_rectangle	operator\| (axis_aligned_rectangle const &lhs, axis_aligned_rectangle const &rhs) noexcept

constexpr axis_aligned_rectangle	operator\| (axis_aligned_rectangle const &lhs, point< value_type, 2 > const &rhs) noexcept

constexpr axis_aligned_rectangle	operator* (axis_aligned_rectangle const &lhs, value_type rhs) noexcept
	Expand the rectangle for the same amount in all directions.

constexpr axis_aligned_rectangle	operator+ (axis_aligned_rectangle const &lhs, value_type rhs) noexcept
	Expand the rectangle for the same amount in all directions.

constexpr axis_aligned_rectangle	operator- (axis_aligned_rectangle const &lhs, value_type rhs) noexcept
	Shrink the rectangle for the same amount in all directions.

constexpr axis_aligned_rectangle	operator- (axis_aligned_rectangle const &lhs, geo::margins< value_type > rhs) noexcept
	Shrink the rectangle by each margin.

constexpr axis_aligned_rectangle	round (axis_aligned_rectangle const &rhs) noexcept

constexpr axis_aligned_rectangle	ceil (axis_aligned_rectangle const &rhs) noexcept
	Round rectangle by expanding to pixel edge.

constexpr axis_aligned_rectangle	ceil (axis_aligned_rectangle const &lhs, extent< value_type, 2 > const &rhs) noexcept
	Round rectangle by expanding to a certain granularity.

constexpr axis_aligned_rectangle	floor (axis_aligned_rectangle const &rhs) noexcept
	Round rectangle by shrinking to pixel edge.

constexpr axis_aligned_rectangle	bounding_rectangle (axis_aligned_rectangle const &rhs) noexcept

constexpr axis_aligned_rectangle	intersect (axis_aligned_rectangle const &lhs, axis_aligned_rectangle const &rhs) noexcept
	Return the overlapping part of two rectangles.

value_type	distance (axis_aligned_rectangle const &lhs, point< value_type, 2 > const &rhs) noexcept

Detailed Description

Class which represents an axis-aligned rectangle.

Constructor & Destructor Documentation

◆ axis_aligned_rectangle() [1/4]

constexpr hi::v1::geo::axis_aligned_rectangle::axis_aligned_rectangle	(	value_type	x,
		value_type	y,
		value_type	width,
		value_type	height )

inlineconstexprnoexcept

Create a box from the position and size.

Parameters

x	The x location of the left-bottom corner of the box
y	The y location of the left-bottom corner of the box
width	The width of the box.
height	The height of the box.

◆ axis_aligned_rectangle() [2/4]

constexpr hi::v1::geo::axis_aligned_rectangle::axis_aligned_rectangle ( extent< value_type, 2 > const & extent )

inlineexplicitconstexprnoexcept

Create a rectangle from the size.

The rectangle's left bottom corner is at the origin.

Parameters

extent The size of the box.

◆ axis_aligned_rectangle() [3/4]

constexpr hi::v1::geo::axis_aligned_rectangle::axis_aligned_rectangle	(	point< value_type, 2 > const &	p0,
		point< value_type, 2 > const &	p3 )

inlineconstexprnoexcept

Create a rectangle from the left-bottom and right-top points.

Parameters

p0	The left bottom point.
p3	The right opt point.

◆ axis_aligned_rectangle() [4/4]

constexpr hi::v1::geo::axis_aligned_rectangle::axis_aligned_rectangle	(	point< value_type, 2 > const &	p0,
		extent< value_type, 2 > const &	extent )

inlineconstexprnoexcept

Create a rectangle from the size.

The rectangle's left bottom corner is at the origin.

Parameters

p0	The left-bottom point where the rectangle starts.
extent	The size of the rectangle.

Member Function Documentation

◆ _align()

static constexpr axis_aligned_rectangle hi::v1::geo::axis_aligned_rectangle::_align	(	axis_aligned_rectangle	outside,
		axis_aligned_rectangle	inside,
		alignment	alignment )

inlinestaticconstexprnoexcept

Need to call the hidden friend function from within another class.

◆ center()

constexpr value_type hi::v1::geo::axis_aligned_rectangle::center ( ) const

inlineconstexprnoexcept

The center on the x-axis between left and right.

◆ contains() [1/2]

constexpr bool hi::v1::geo::axis_aligned_rectangle::contains ( point< value_type, 2 > const & rhs ) const

inlineconstexprnoexcept

Check if a 2D coordinate is inside the rectangle.

Parameters

rhs	The coordinate of the point to test.

◆ contains() [2/2]

constexpr bool hi::v1::geo::axis_aligned_rectangle::contains ( point< value_type, 3 > const & rhs ) const

inlineconstexprnoexcept

Check if a 3D coordinate is inside the rectangle.

Parameters

rhs	The coordinate of the point to test. This point is converted to 2D by this function.

◆ empty()

constexpr bool hi::v1::geo::axis_aligned_rectangle::empty ( ) const

inlineconstexprnoexcept

Check if the rectangle has no area.

◆ holds_invariant()

constexpr bool hi::v1::geo::axis_aligned_rectangle::holds_invariant ( ) const

inlineconstexprnoexcept

Make sure p0 is left/bottom from p3.

Returns: True is p0 is left and below p3.

◆ large()

static constexpr axis_aligned_rectangle hi::v1::geo::axis_aligned_rectangle::large ( )

inlinestaticconstexprnoexcept

Create a large axis aligned rectangle.

◆ middle()

constexpr value_type hi::v1::geo::axis_aligned_rectangle::middle ( ) const

inlineconstexprnoexcept

The middle on the y-axis between bottom and top.

◆ operator bool()

constexpr hi::v1::geo::axis_aligned_rectangle::operator bool ( ) const

inlineexplicitconstexprnoexcept

True when the rectangle has an area.

◆ operator|=() [1/2]

constexpr axis_aligned_rectangle & hi::v1::geo::axis_aligned_rectangle::operator|= ( axis_aligned_rectangle const & rhs )

inlineconstexprnoexcept

Expand the current rectangle to include the new rectangle.

This is mostly used for extending bounding a bounding box.

Parameters

rhs	The new rectangle to include in the current rectangle.

◆ operator|=() [2/2]

constexpr axis_aligned_rectangle & hi::v1::geo::axis_aligned_rectangle::operator|= ( point< value_type, 2 > const & rhs )

inlineconstexprnoexcept

Expand the current rectangle to include the new rectangle.

This is mostly used for extending bounding a bounding box.

Parameters

rhs	A new point to include in the current rectangle.

◆ size()

constexpr extent< value_type, 2 > hi::v1::geo::axis_aligned_rectangle::size ( ) const

inlineconstexprnoexcept

Get size of the rectangle.

Returns: The (x, y) vector representing the width and height of the rectangle.

Friends And Related Symbol Documentation

◆ align [1/2]

constexpr axis_aligned_rectangle align	(	axis_aligned_rectangle	haystack,
		axis_aligned_rectangle	needle,
		alignment	alignment )

friend

Align a rectangle within another rectangle.

Parameters

haystack	The outside rectangle
needle	The inside rectangle; to be aligned.
alignment	How the inside rectangle should be aligned.

Returns: The needle rectangle repositioned and aligned inside the haystack.

◆ align [2/2]

constexpr axis_aligned_rectangle align	(	axis_aligned_rectangle	haystack,
		extent< value_type, 2 >	needle,
		alignment	alignment )

friend

Align a rectangle within another rectangle.

Parameters

haystack	The outside rectangle
needle	The size of the rectangle to be aligned.
alignment	How the inside rectangle should be aligned.

Returns: The needle rectangle repositioned and aligned inside the haystack.

◆ ceil [1/2]

constexpr axis_aligned_rectangle ceil	(	axis_aligned_rectangle const &	lhs,
		extent< value_type, 2 > const &	rhs )

friend

Round rectangle by expanding to a certain granularity.

◆ ceil [2/2]

constexpr axis_aligned_rectangle ceil ( axis_aligned_rectangle const & rhs )

friend

Round rectangle by expanding to pixel edge.

◆ floor

constexpr axis_aligned_rectangle floor ( axis_aligned_rectangle const & rhs )

friend

Round rectangle by shrinking to pixel edge.

◆ intersect

constexpr axis_aligned_rectangle intersect	(	axis_aligned_rectangle const &	lhs,
		axis_aligned_rectangle const &	rhs )

friend

Return the overlapping part of two rectangles.

When the rectangles are not overlapping, the width and height are zero.

◆ midpoint

constexpr friend point< value_type, 2 > midpoint ( axis_aligned_rectangle const & rhs )

friend

Get the center of the rectangle.

◆ operator*

constexpr axis_aligned_rectangle operator*	(	axis_aligned_rectangle const &	lhs,
		value_type	rhs )

friend

Expand the rectangle for the same amount in all directions.

Parameters

lhs	The original rectangle.
rhs	How much the width and height should be scaled by.

Returns: A new rectangle expanded on each side.

◆ operator+

constexpr axis_aligned_rectangle operator+	(	axis_aligned_rectangle const &	lhs,
		value_type	rhs )

friend

Expand the rectangle for the same amount in all directions.

Parameters

lhs	The original rectangle.
rhs	How much should be added on each side of the rectangle, this value may be zero or negative.

Returns: A new rectangle expanded on each side.

◆ operator- [1/2]

constexpr axis_aligned_rectangle operator-	(	axis_aligned_rectangle const &	lhs,
		geo::margins< value_type >	rhs )

friend

Shrink the rectangle by each margin.

Parameters

lhs	The original rectangle.
rhs	How much should be added on each side of the rectangle, this value may be zero or negative.

Returns: A new rectangle shrank on each side.

◆ operator- [2/2]

constexpr axis_aligned_rectangle operator-	(	axis_aligned_rectangle const &	lhs,
		value_type	rhs )

friend

Shrink the rectangle for the same amount in all directions.

Parameters

lhs	The original rectangle.
rhs	How much should be added on each side of the rectangle, this value may be zero or negative.

Returns: A new rectangle shrank on each side.

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

hikogui/src/hikogui/geometry/axis_aligned_rectangle.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ axis_aligned_rectangle() [1/4]

◆ axis_aligned_rectangle() [2/4]

◆ axis_aligned_rectangle() [3/4]

◆ axis_aligned_rectangle() [4/4]

Member Function Documentation

◆ _align()

◆ center()

◆ contains() [1/2]

◆ contains() [2/2]

◆ empty()

◆ holds_invariant()

◆ large()

◆ middle()

◆ operator bool()

◆ operator|=() [1/2]

◆ operator|=() [2/2]

◆ size()

Friends And Related Symbol Documentation

◆ align [1/2]

◆ align [2/2]

◆ ceil [1/2]

◆ ceil [2/2]

◆ floor

◆ intersect

◆ midpoint

◆ operator*

◆ operator+

◆ operator- [1/2]

◆ operator- [2/2]