graphics::SizeType< DataType > Struct Template Reference

A class that represents size in 2D space. More...

#include <Size.h>

Public Member Functions
SizeType &	operator+= (SizeType rhs) noexcept
SizeType &	operator-= (SizeType rhs) noexcept
SizeType &	operator*= (SizeType rhs) noexcept
SizeType &	operator/= (SizeType rhs) noexcept
template<typename ScaleType >
SizeType &	operator*= (ScaleType scale) noexcept
template<typename ScaleType >
SizeType &	operator/= (ScaleType scale) noexcept
SizeType &	operator- () noexcept
bool	IsZero () const noexcept
	Return true if both width and height are zero. More...

Public Attributes
DataType	width {}
	Width. More...
DataType	height {}
	Height. More...

Detailed Description

template<typename DataType>
struct graphics::SizeType< DataType >

A class that represents size in 2D space.

Definition at line 32 of file Size.h.

Member Function Documentation

IsZero()

template<typename DataType >

bool graphics::SizeType< DataType >::IsZero ( ) const

inlinenoexcept

Return true if both width and height are zero.

Definition at line 98 of file Size.h.

   {
      return std::abs(width) <= std::numeric_limits<DataType>::epsilon() &&
             std::abs(height) <= std::numeric_limits<DataType>::epsilon();
   }

References graphics::SizeType< DataType >::height, and graphics::SizeType< DataType >::width.

operator*=() [1/2]

template<typename DataType >

template<typename ScaleType >

SizeType & graphics::SizeType< DataType >::operator*= ( ScaleType  scale )

inlinenoexcept

Definition at line 71 of file Size.h.

   {
      width = static_cast<DataType>(GetPositiveSizeValue(width * scale));
      height = static_cast<DataType>(GetPositiveSizeValue(height * scale));
 
      return *this;
   }

References graphics::details::GetPositiveSizeValue(), graphics::SizeType< DataType >::height, and graphics::SizeType< DataType >::width.

Here is the call graph for this function:

operator*=() [2/2]

template<typename DataType >

SizeType & graphics::SizeType< DataType >::operator*= ( SizeType< DataType >  rhs )

inlinenoexcept

Definition at line 55 of file Size.h.

   {
      width = GetPositiveSizeValue(width * rhs.width);
      height = GetPositiveSizeValue(height * rhs.height);
 
      return *this;
   }

References graphics::details::GetPositiveSizeValue(), graphics::SizeType< DataType >::height, and graphics::SizeType< DataType >::width.

Here is the call graph for this function:

operator+=()

template<typename DataType >

SizeType & graphics::SizeType< DataType >::operator+= ( SizeType< DataType >  rhs )

inlinenoexcept

Definition at line 39 of file Size.h.

   {
      width = GetPositiveSizeValue(width + rhs.width);
      height = GetPositiveSizeValue(height + rhs.height);
 
      return *this;
   }

References graphics::details::GetPositiveSizeValue(), graphics::SizeType< DataType >::height, and graphics::SizeType< DataType >::width.

Here is the call graph for this function:

operator-()

template<typename DataType >

SizeType & graphics::SizeType< DataType >::operator- ( )

inlinenoexcept

Definition at line 87 of file Size.h.

   {
      static_assert(std::is_signed_v<DataType>);
 
      width = -width;
      height = -height;
 
      return *this;
   }

References graphics::SizeType< DataType >::height, and graphics::SizeType< DataType >::width.

operator-=()

template<typename DataType >

SizeType & graphics::SizeType< DataType >::operator-= ( SizeType< DataType >  rhs )

inlinenoexcept

Definition at line 47 of file Size.h.

   {
      width = GetPositiveSizeValue(width - rhs.width);
      height = GetPositiveSizeValue(height - rhs.height);
 
      return *this;
   }

References graphics::details::GetPositiveSizeValue(), graphics::SizeType< DataType >::height, and graphics::SizeType< DataType >::width.

Here is the call graph for this function:

operator/=() [1/2]

template<typename DataType >

template<typename ScaleType >

SizeType & graphics::SizeType< DataType >::operator/= ( ScaleType  scale )

inlinenoexcept

Definition at line 79 of file Size.h.

   {
      width = static_cast<DataType>(GetPositiveSizeValue(width / scale));
      height = static_cast<DataType>(GetPositiveSizeValue(height / scale));
 
      return *this;
   }

References graphics::details::GetPositiveSizeValue(), graphics::SizeType< DataType >::height, and graphics::SizeType< DataType >::width.

Here is the call graph for this function:

operator/=() [2/2]

template<typename DataType >

SizeType & graphics::SizeType< DataType >::operator/= ( SizeType< DataType >  rhs )

inlinenoexcept

Definition at line 63 of file Size.h.

   {
      width = GetPositiveSizeValue(width / rhs.width);
      height = GetPositiveSizeValue(height / rhs.height);
 
      return *this;
   }

References graphics::details::GetPositiveSizeValue(), graphics::SizeType< DataType >::height, and graphics::SizeType< DataType >::width.

Here is the call graph for this function:

Member Data Documentation

height

template<typename DataType >

DataType graphics::SizeType< DataType >::height {}

Height.

Definition at line 37 of file Size.h.

Referenced by graphics::SizeType< DataType >::IsZero(), graphics::SizeType< DataType >::operator*=(), graphics::SizeType< DataType >::operator+=(), graphics::SizeType< DataType >::operator-(), graphics::SizeType< DataType >::operator-=(), graphics::SizeType< DataType >::operator/=(), and graphics::size_cast().

width

template<typename DataType >

DataType graphics::SizeType< DataType >::width {}

Width.

Definition at line 35 of file Size.h.

Referenced by graphics::SizeType< DataType >::IsZero(), graphics::SizeType< DataType >::operator*=(), graphics::SizeType< DataType >::operator+=(), graphics::SizeType< DataType >::operator-(), graphics::SizeType< DataType >::operator-=(), graphics::SizeType< DataType >::operator/=(), and graphics::size_cast().

---

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

• Size.h