graphics::PointType< DataType > Struct Template Reference

A point in 2D space. More...

#include <Point.h>

Public Member Functions
PointType &	operator+= (PointType rhs) noexcept
PointType &	operator-= (PointType rhs) noexcept
PointType &	operator*= (PointType rhs) noexcept
PointType &	operator/= (PointType rhs) noexcept
template<typename ScaleType >
PointType &	operator*= (ScaleType scale) noexcept
template<typename ScaleType >
PointType &	operator/= (ScaleType scale) noexcept
PointType	operator- () const noexcept
bool	IsZero () const noexcept

Public Attributes
DataType	x {}
DataType	y {}

Detailed Description

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

A point in 2D space.

Definition at line 22 of file Point.h.

Member Function Documentation

IsZero()

template<typename DataType >

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

inlinenoexcept

Definition at line 82 of file Point.h.

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

References graphics::PointType< DataType >::x, and graphics::PointType< DataType >::y.

operator*=() [1/2]

template<typename DataType >

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

inlinenoexcept

Definition at line 43 of file Point.h.

   {
      x *= rhs.x;
      y *= rhs.y;
 
      return *this;
   }

References graphics::PointType< DataType >::x, and graphics::PointType< DataType >::y.

operator*=() [2/2]

template<typename DataType >

template<typename ScaleType >

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

inlinenoexcept

Definition at line 59 of file Point.h.

   {
      x = static_cast<DataType>(x * scale);
      y = static_cast<DataType>(y * scale);
 
      return *this;
   }

References graphics::PointType< DataType >::x, and graphics::PointType< DataType >::y.

operator+=()

template<typename DataType >

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

inlinenoexcept

Definition at line 27 of file Point.h.

   {
      x += rhs.x;
      y += rhs.y;
 
      return *this;
   }

References graphics::PointType< DataType >::x, and graphics::PointType< DataType >::y.

operator-()

template<typename DataType >

PointType graphics::PointType< DataType >::operator- ( ) const

inlinenoexcept

Definition at line 75 of file Point.h.

   {
      static_assert(std::is_signed_v<DataType>);
 
      return { -x, -y };
   }

References graphics::PointType< DataType >::x, and graphics::PointType< DataType >::y.

operator-=()

template<typename DataType >

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

inlinenoexcept

Definition at line 35 of file Point.h.

   {
      x -= rhs.x;
      y -= rhs.y;
 
      return *this;
   }

References graphics::PointType< DataType >::x, and graphics::PointType< DataType >::y.

operator/=() [1/2]

template<typename DataType >

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

inlinenoexcept

Definition at line 51 of file Point.h.

   {
      x /= rhs.x;
      y /= rhs.y;
 
      return *this;
   }

References graphics::PointType< DataType >::x, and graphics::PointType< DataType >::y.

operator/=() [2/2]

template<typename DataType >

template<typename ScaleType >

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

inlinenoexcept

Definition at line 67 of file Point.h.

   {
      x = static_cast<DataType>(x / scale);
      y = static_cast<DataType>(y / scale);
 
      return *this;
   }

References graphics::PointType< DataType >::x, and graphics::PointType< DataType >::y.

Member Data Documentation

x

template<typename DataType >

DataType graphics::PointType< DataType >::x {}

Definition at line 24 of file Point.h.

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

y

template<typename DataType >

DataType graphics::PointType< DataType >::y {}

Definition at line 25 of file Point.h.

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

---

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

• Point.h