#include <hikogui/geometry/extent2.hpp>

Public Types
using	array_type = simd<float, 4>
using	value_type = array_type::value_type

Public Member Functions
constexpr	extent2 (extent2 const &) noexcept=default
constexpr	extent2 (extent2 &&) noexcept=default
constexpr extent2 &	operator= (extent2 const &) noexcept=default
constexpr extent2 &	operator= (extent2 &&) noexcept=default
constexpr	extent2 (array_type const &other) noexcept
constexpr	operator array_type () const noexcept
	Convert a extent to its array_type-nummeric_array.
constexpr	extent2 (vector2 const &other) noexcept
constexpr	operator vector2 () const noexcept
constexpr	extent2 () noexcept
	Construct a empty extent / zero length.
constexpr	extent2 (float width, float height) noexcept
	Construct a 3D extent from width, height and depth.
constexpr	operator bool () const noexcept
constexpr float &	width () noexcept
	Access the x-as-width element from the extent.
constexpr float &	height () noexcept
	Access the y-as-height element from the extent.
constexpr float	width () const noexcept
	Access the x-as-width element from the extent.
constexpr float	height () const noexcept
	Access the y-as-height element from the extent.
constexpr vector2	right () const noexcept
constexpr vector2	up () const noexcept
constexpr extent2 &	operator+= (extent2 const &rhs) noexcept
constexpr bool	holds_invariant () const noexcept
	Check if the extent is valid.

Static Public Member Functions
static constexpr extent2	infinity () noexcept
static constexpr extent2	large () noexcept
static constexpr extent2	nan () noexcept

Friends
constexpr friend extent2	operator+ (extent2 const &lhs, extent2 const &rhs) noexcept
	Add two extents from each other.
constexpr friend extent2	operator- (extent2 const &lhs, extent2 const &rhs) noexcept
	Subtract two extents from each other.
constexpr friend extent2	operator* (extent2 const &lhs, float const &rhs) noexcept
	Scale the extent by a scaler.
constexpr friend extent2	operator+ (extent2 const &lhs, vector2 const &rhs) noexcept
constexpr friend vector2	operator+ (vector2 const &lhs, extent2 const &rhs) noexcept
constexpr friend extent2	operator+ (extent2 const &lhs, float const &rhs) noexcept
	Add a scaler to the extent.
constexpr friend extent2	operator* (float const &lhs, extent2 const &rhs) noexcept
	Scale the extent by a scaler.
constexpr friend bool	operator== (extent2 const &lhs, extent2 const &rhs) noexcept
	Compare if two extents are equal.
constexpr friend std::partial_ordering	operator<=> (extent2 const &lhs, extent2 const &rhs) noexcept
hi_force_inline constexpr friend float	squared_hypot (extent2 const &rhs) noexcept
	Get the squared length of the extent.
float	hypot (extent2 const &rhs) noexcept
	Get the length of the extent.
constexpr friend float	rcp_hypot (extent2 const &rhs) noexcept
	Get the length of the extent.
constexpr friend extent2	normalize (extent2 const &rhs) noexcept
	Normalize a extent to a unit extent.
constexpr friend extent2	ceil (extent2 const &rhs) noexcept
constexpr friend extent2	floor (extent2 const &rhs) noexcept
constexpr friend extent2	round (extent2 const &rhs) noexcept
constexpr friend extent2	min (extent2 const &lhs, extent2 const &rhs) noexcept
constexpr friend extent2	max (extent2 const &lhs, extent2 const &rhs) noexcept
constexpr friend extent2	clamp (extent2 const &value, extent2 const &min, extent2 const &max) noexcept
std::string	to_string (extent2 const &rhs) noexcept
std::ostream &	operator<< (std::ostream &lhs, extent2 const &rhs) noexcept

Detailed Description

A high-level geometric extent.

A extent, for both 2D or 3D is internally represented as a 4D homogeneous extent. Which can be efficiently implemented as a __m128 SSE register.

Constructor & Destructor Documentation

◆ extent2() [1/2]

hi::v1::extent2::extent2 ( )

inlinenodiscardconstexprnoexcept

Construct a empty extent / zero length.

◆ extent2() [2/2]

hi::v1::extent2::extent2	(	float	width,
		float	height )

inlinenodiscardconstexprnoexcept

Construct a 3D extent from width, height and depth.

Parameters

width	The width element.
height	The height element.
depth	The depth element.

Member Function Documentation

◆ height() [1/2]

float hi::v1::extent2::height ( ) const

inlinenodiscardconstexprnoexcept

Access the y-as-height element from the extent.

A extent can be seen as having a width, height and depth, these accessors are aliases for x, y, and z.

Returns: a reference to the y element.

◆ height() [2/2]

float & hi::v1::extent2::height ( )

inlinenodiscardconstexprnoexcept

Access the y-as-height element from the extent.

A extent can be seen as having a width, height and depth, these accessors are aliases for x, y, and z.

Returns: a reference to the y element.

◆ holds_invariant()

bool hi::v1::extent2::holds_invariant ( ) const

inlinenodiscardconstexprnoexcept

Check if the extent is valid.

Extends must be positive. This function will check if w is zero, and with 2D extent is z is zero.

◆ operator array_type()

hi::v1::extent2::operator array_type ( ) const

inlineexplicitnodiscardconstexprnoexcept

Convert a extent to its array_type-nummeric_array.

◆ width() [1/2]

float hi::v1::extent2::width ( ) const

inlinenodiscardconstexprnoexcept

Access the x-as-width element from the extent.

A extent can be seen as having a width, height and depth, these accessors are aliases for x, y, and z.

Returns: a reference to the x element.

◆ width() [2/2]

float & hi::v1::extent2::width ( )

inlinenodiscardconstexprnoexcept

Access the x-as-width element from the extent.

A extent can be seen as having a width, height and depth, these accessors are aliases for x, y, and z.

Returns: a reference to the x element.

◆ hypot

float hypot ( extent2 const & rhs )

friend

Get the length of the extent.

Parameters

rhs	The extent.

Returns: The length of the extent.

◆ normalize

friend extent2 normalize ( extent2 const & rhs )

friend

Normalize a extent to a unit extent.

Parameters

rhs	The extent.

Returns: A extent with the same direction as the given extent, but its length is 1.0.

◆ operator* [1/2]

friend extent2 operator*	(	extent2 const &	lhs,
		float const &	rhs )

friend

Scale the extent by a scaler.

Parameters

lhs	The extent to scale.
rhs	The scaling factor.

Returns: The scaled extent.

◆ operator* [2/2]

friend extent2 operator*	(	float const &	lhs,
		extent2 const &	rhs )

friend

Scale the extent by a scaler.

Parameters

lhs	The extent to scale.
rhs	The scaling factor.

Returns: The scaled extent.

◆ operator+ [1/2]

friend extent2 operator+	(	extent2 const &	lhs,
		extent2 const &	rhs )

friend

Add two extents from each other.

Parameters

lhs	The first extent.
rhs	The second extent.

Returns: A new extent.

◆ operator+ [2/2]

friend extent2 operator+	(	extent2 const &	lhs,
		float const &	rhs )

friend

Add a scaler to the extent.

Parameters

lhs	The extent to scale.
rhs	The scaling factor.

Returns: The scaled extent.

◆ operator-

friend extent2 operator-	(	extent2 const &	lhs,
		extent2 const &	rhs )

friend

Subtract two extents from each other.

Parameters

lhs	The first extent.
rhs	The second extent.

Returns: A new extent.

◆ operator==

friend bool operator==	(	extent2 const &	lhs,
		extent2 const &	rhs )

friend

Compare if two extents are equal.

Parameters

lhs	The first extent.
rhs	The second extent.

Returns: True if both extents are completely equal to each other.

◆ rcp_hypot

friend float rcp_hypot ( extent2 const & rhs )

friend

Get the length of the extent.

Parameters

rhs	The extent.

Returns: One over the length of the extent.

◆ squared_hypot

hi_force_inline constexpr friend float squared_hypot ( extent2 const & rhs )

friend

Get the squared length of the extent.

Parameters

rhs	The extent.

Returns: The length of the extent.

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

hikogui/src/hikogui/geometry/extent2.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ extent2() [1/2]

◆ extent2() [2/2]

Member Function Documentation

◆ height() [1/2]

◆ height() [2/2]

◆ holds_invariant()

◆ operator array_type()

◆ width() [1/2]

◆ width() [2/2]

Friends And Related Symbol Documentation

◆ hypot

◆ normalize

◆ operator* [1/2]

◆ operator* [2/2]

◆ operator+ [1/2]

◆ operator+ [2/2]

◆ operator-

◆ operator==

◆ rcp_hypot

◆ squared_hypot