Rectangle with x, y, width and height integer components. More...

#include <recti.hpp>

Collaboration diagram for jau::math::RectI< Value_type, >:

Public Types
typedef const value_type *	const_iterator

typedef const value_type *	const_pointer

typedef const value_type &	const_reference

typedef value_type *	iterator

typedef value_type *	pointer

typedef value_type &	reference

typedef Value_type	value_type

Public Member Functions
constexpr	RectI () noexcept

constexpr	RectI (const RectI &o) noexcept=default

constexpr	RectI (const value_type x, const value_type y, const value_type width, const value_type height) noexcept

constexpr	RectI (const value_type xywh[]) noexcept

constexpr	RectI (RectI &&o) noexcept=default

iterator	get (iterator xywh) const noexcept
	xywh = this, returns xywh. More...

constexpr value_type	height () const noexcept

constexpr bool	is_zero () const noexcept
	Return true if area is zero. More...

constexpr RectI &	operator= (const RectI &) noexcept=default

constexpr RectI &	operator= (RectI &&) noexcept=default

constexpr bool	operator== (const RectI &rhs) const noexcept

constexpr RectI &	set (const value_type x, const value_type y, const value_type width, const value_type height) noexcept
	TODO constexpr bool operator<=>(const Recti_t& rhs ) const noexcept { return ... }. More...

constexpr RectI &	set (const_iterator xywh) noexcept
	this = xywh, returns this. More...

constexpr void	setHeight (const value_type height) noexcept

constexpr void	setWidth (const value_type width) noexcept

constexpr void	setX (const value_type x) noexcept

constexpr void	setY (const value_type y) noexcept

std::string	toString () const noexcept

constexpr value_type	width () const noexcept

constexpr value_type	x () const noexcept

constexpr value_type	y () const noexcept

Detailed Description

template<typename Value_type, std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>
class jau::math::RectI< Value_type, >

Rectangle with x, y, width and height integer components.

Definition at line 43 of file recti.hpp.

Member Typedef Documentation

◆ value_type

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

typedef Value_type jau::math::RectI< Value_type, >::value_type

Definition at line 45 of file recti.hpp.

◆ pointer

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

typedef value_type* jau::math::RectI< Value_type, >::pointer

Definition at line 46 of file recti.hpp.

◆ const_pointer

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

typedef const value_type* jau::math::RectI< Value_type, >::const_pointer

Definition at line 47 of file recti.hpp.

◆ reference

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

typedef value_type& jau::math::RectI< Value_type, >::reference

Definition at line 48 of file recti.hpp.

◆ const_reference

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

typedef const value_type& jau::math::RectI< Value_type, >::const_reference

Definition at line 49 of file recti.hpp.

◆ iterator

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

typedef value_type* jau::math::RectI< Value_type, >::iterator

Definition at line 50 of file recti.hpp.

◆ const_iterator

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

typedef const value_type* jau::math::RectI< Value_type, >::const_iterator

Definition at line 51 of file recti.hpp.

Constructor & Destructor Documentation

◆ RectI() [1/5]

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr jau::math::RectI< Value_type, >::RectI ( )

inlineconstexprnoexcept

Definition at line 60 of file recti.hpp.

◆ RectI() [2/5]

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr jau::math::RectI< Value_type, >::RectI ( const value_type xywh[] )

inlineconstexprnoexcept

Definition at line 63 of file recti.hpp.

◆ RectI() [3/5]

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr jau::math::RectI< Value_type, >::RectI	(	const value_type	x,
		const value_type	y,
		const value_type	width,
		const value_type	height
	)

inlineconstexprnoexcept

Definition at line 67 of file recti.hpp.

◆ RectI() [4/5]

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr jau::math::RectI< Value_type, >::RectI ( const RectI< Value_type, > & o )

constexprdefaultnoexcept

◆ RectI() [5/5]

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr jau::math::RectI< Value_type, >::RectI ( RectI< Value_type, > && o )

constexprdefaultnoexcept

Member Function Documentation

◆ operator=() [1/2]

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr RectI & jau::math::RectI< Value_type, >::operator= ( const RectI< Value_type, > & )

constexprdefaultnoexcept

◆ operator=() [2/2]

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr RectI & jau::math::RectI< Value_type, >::operator= ( RectI< Value_type, > && )

constexprdefaultnoexcept

◆ operator==()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr bool jau::math::RectI< Value_type, >::operator== ( const RectI< Value_type, > & rhs ) const

inlineconstexprnoexcept

Definition at line 76 of file recti.hpp.

◆ set() [1/2]

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr RectI & jau::math::RectI< Value_type, >::set	(	const value_type	x,
		const value_type	y,
		const value_type	width,
		const value_type	height
	)

inlineconstexprnoexcept

TODO constexpr bool operator<=>(const Recti_t& rhs ) const noexcept { return ... }.

this = { x, y, width, height }, returns this.

Definition at line 90 of file recti.hpp.

Here is the caller graph for this function:

◆ set() [2/2]

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr RectI & jau::math::RectI< Value_type, >::set ( const_iterator xywh )

inlineconstexprnoexcept

this = xywh, returns this.

Definition at line 94 of file recti.hpp.

◆ get()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

iterator jau::math::RectI< Value_type, >::get ( iterator xywh ) const

inlinenoexcept

xywh = this, returns xywh.

Definition at line 98 of file recti.hpp.

◆ x()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr value_type jau::math::RectI< Value_type, >::x ( ) const

inlineconstexprnoexcept

Definition at line 101 of file recti.hpp.

Here is the caller graph for this function:

◆ y()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr value_type jau::math::RectI< Value_type, >::y ( ) const

inlineconstexprnoexcept

Definition at line 102 of file recti.hpp.

Here is the caller graph for this function:

◆ width()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr value_type jau::math::RectI< Value_type, >::width ( ) const

inlineconstexprnoexcept

Definition at line 103 of file recti.hpp.

Here is the caller graph for this function:

◆ height()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr value_type jau::math::RectI< Value_type, >::height ( ) const

inlineconstexprnoexcept

Definition at line 104 of file recti.hpp.

Here is the caller graph for this function:

◆ setX()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr void jau::math::RectI< Value_type, >::setX ( const value_type x )

inlineconstexprnoexcept

Definition at line 106 of file recti.hpp.

◆ setY()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr void jau::math::RectI< Value_type, >::setY ( const value_type y )

inlineconstexprnoexcept

Definition at line 107 of file recti.hpp.

◆ setWidth()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr void jau::math::RectI< Value_type, >::setWidth ( const value_type width )

inlineconstexprnoexcept

Definition at line 108 of file recti.hpp.

◆ setHeight()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr void jau::math::RectI< Value_type, >::setHeight ( const value_type height )

inlineconstexprnoexcept

Definition at line 109 of file recti.hpp.

◆ is_zero()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

constexpr bool jau::math::RectI< Value_type, >::is_zero ( ) const

inlineconstexprnoexcept

Return true if area is zero.

Definition at line 112 of file recti.hpp.

◆ toString()

template<typename Value_type , std::enable_if_t< std::is_integral_v< Value_type >, bool > = true>

std::string jau::math::RectI< Value_type, >::toString ( ) const

inlinenoexcept

Definition at line 116 of file recti.hpp.

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

include/jau/math/recti.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ value_type

◆ pointer

◆ const_pointer

◆ reference

◆ const_reference

◆ iterator

◆ const_iterator

Constructor & Destructor Documentation

◆ RectI() [1/5]

◆ RectI() [2/5]

◆ RectI() [3/5]

◆ RectI() [4/5]

◆ RectI() [5/5]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ set() [1/2]

◆ set() [2/2]

◆ get()

◆ x()

◆ y()

◆ width()

◆ height()

◆ setX()

◆ setY()

◆ setWidth()

◆ setHeight()

◆ is_zero()

◆ toString()