LPointTemplate< T > Class Template Reference

Template for 2D vectors. More...

#include <LPoint.h>

Public Member Functions
constexpr	LPointTemplate () noexcept
	Initializes the vector with (0,0).
constexpr	LPointTemplate (T x, T y) noexcept
	Initializes the vector with (x,y).
constexpr	LPointTemplate (T n) noexcept
	Initializes the vector with (n,n).
template<class N >
constexpr	LPointTemplate (const LPointTemplate< N > &point) noexcept
	Copy constructor.
constexpr T	x () const noexcept
	First component of the vector.
constexpr T	y () const noexcept
	Second component of the vector.
constexpr T	w () const noexcept
	First component of the vector (equivalent to x())
constexpr T	h () const noexcept
	Second component of the vector (equivalent to y())
constexpr T	width () const noexcept
	First component of the vector (equivalent to x())
constexpr T	height () const noexcept
	Second component of the vector (equivalent to y())
constexpr T	area () const noexcept
	Product of the components (x*y)
constexpr void	setX (T x) noexcept
	Assigns the value to the first component of the vector.
constexpr void	setY (T y) noexcept
	Assigns the value to the second component of the vector.
constexpr void	setW (T x) noexcept
	Assigns the value to the first component of the vector (equivalent to setX())
constexpr void	setH (T y) noexcept
	Assigns the value to the second component of the vector (equivalent to setY())
constexpr void	setWidth (T x) noexcept
	Assigns the value to the first component of the vector (equivalent to setX())
constexpr void	setHeight (T y) noexcept
	Assigns the value to the second component of the vector (equivalent to setY())
template<class N >
constexpr LPointTemplate< T >	constrainedToHeight (N size) const noexcept
	Assigns the second component while maintaining proportion with the first.
template<class N >
constexpr T	distanceFrom (const LPointTemplate< N > &point) const noexcept
	Distance from another point.

Detailed Description

template<class T>
class Louvre::LPointTemplate< T >

Template for 2D vectors.

The LPointTemplate class is a template for creating two-dimensional vectors.
The library uses this template to generate the LPoint and LSize classes, which work with 32-bit integers, and LPointF and LSizeF, which work with 32-bit floating-point numbers.

Constructor & Destructor Documentation

LPointTemplate() [1/4]

template<class T >

constexpr LPointTemplate ( )

inlineconstexprnoexcept

Initializes the vector with (0,0).

LPointTemplate() [2/4]

template<class T >

constexpr LPointTemplate ( T  x, T  y  )

inlineconstexprnoexcept

Initializes the vector with (x,y).

LPointTemplate() [3/4]

template<class T >

constexpr LPointTemplate ( T  n )

inlineconstexprnoexcept

Initializes the vector with (n,n).

LPointTemplate() [4/4]

template<class T >

template<class N >

constexpr LPointTemplate ( const LPointTemplate< N > &  point )

inlineconstexprnoexcept

Copy constructor.

Member Function Documentation

x()

template<class T >

constexpr T x ( ) const

inlineconstexprnoexcept

First component of the vector.

y()

template<class T >

constexpr T y ( ) const

inlineconstexprnoexcept

Second component of the vector.

w()

template<class T >

constexpr T w ( ) const

inlineconstexprnoexcept

First component of the vector (equivalent to x())

h()

template<class T >

constexpr T h ( ) const

inlineconstexprnoexcept

Second component of the vector (equivalent to y())

width()

template<class T >

constexpr T width ( ) const

inlineconstexprnoexcept

First component of the vector (equivalent to x())

height()

template<class T >

constexpr T height ( ) const

inlineconstexprnoexcept

Second component of the vector (equivalent to y())

area()

template<class T >

constexpr T area ( ) const

inlineconstexprnoexcept

Product of the components (x*y)

setX()

template<class T >

constexpr void setX ( T  x )

inlineconstexprnoexcept

Assigns the value to the first component of the vector.

setY()

template<class T >

constexpr void setY ( T  y )

inlineconstexprnoexcept

Assigns the value to the second component of the vector.

setW()

template<class T >

constexpr void setW ( T  x )

inlineconstexprnoexcept

Assigns the value to the first component of the vector (equivalent to setX())

setH()

template<class T >

constexpr void setH ( T  y )

inlineconstexprnoexcept

Assigns the value to the second component of the vector (equivalent to setY())

setWidth()

template<class T >

constexpr void setWidth ( T  x )

inlineconstexprnoexcept

Assigns the value to the first component of the vector (equivalent to setX())

setHeight()

template<class T >

constexpr void setHeight ( T  y )

inlineconstexprnoexcept

Assigns the value to the second component of the vector (equivalent to setY())

constrainedToHeight()

template<class T >

template<class N >

constexpr LPointTemplate< T > constrainedToHeight ( N  size ) const

inlineconstexprnoexcept

Assigns the second component while maintaining proportion with the first.

distanceFrom()

template<class T >

template<class N >

constexpr T distanceFrom ( const LPointTemplate< N > &  point ) const

inlineconstexprnoexcept

Distance from another point.