Utility template class for manipulating 2-dimensional vectors. More...

#include <Vector2.h>

Public Member Functions
	Vector2 ()
	Default constructor. More...

	Vector2 (T X, T Y)
	Construct the vector from its coordinates. More...

template<typename U >
	Vector2 (const Vector2< U > &vector)
	Construct the vector from another type of vector. More...

Public Attributes
T	x
	X coordinate of the vector.

T	y
	Y coordinate of the vector.

Related Functions
(Note that these are not member functions.)
template<typename T >
Vector2< T >	operator- (const Vector2< T > &right)
	Overload of unary operator -. More...

template<typename T >
Vector2< T > &	operator+= (Vector2< T > &left, const Vector2< T > &right)
	Overload of binary operator +=. More...

template<typename T >
Vector2< T > &	operator-= (Vector2< T > &left, const Vector2< T > &right)
	Overload of binary operator -=. More...

template<typename T >
Vector2< T >	operator+ (const Vector2< T > &left, const Vector2< T > &right)
	Overload of binary operator +. More...

template<typename T >
Vector2< T >	operator- (const Vector2< T > &left, const Vector2< T > &right)
	Overload of binary operator -. More...

template<typename T >
Vector2< T >	operator* (const Vector2< T > &left, T right)
	Overload of binary operator *. More...

template<typename T >
Vector2< T >	operator* (T left, const Vector2< T > &right)
	Overload of binary operator *. More...

template<typename T >
Vector2< T > &	operator*= (Vector2< T > &left, T right)
	Overload of binary operator *=. More...

template<typename T >
Vector2< T >	operator/ (const Vector2< T > &left, T right)
	Overload of binary operator /. More...

template<typename T >
Vector2< T > &	operator/= (Vector2< T > &left, T right)
	Overload of binary operator /=. More...

template<typename T >
bool	operator== (const Vector2< T > &left, const Vector2< T > &right)
	Overload of binary operator ==. More...

template<typename T >
bool	operator!= (const Vector2< T > &left, const Vector2< T > &right)
	Overload of binary operator !=. More...

Detailed Description

template<typename T>
class gd::Vector2< T >

Utility template class for manipulating 2-dimensional vectors.

gd::Vector2 is a simple class that defines a mathematical vector with two coordinates (x and y). It can be used to represent anything that has two dimensions: a size, a point, a velocity, etc.

The template parameter T is the type of the coordinates. It can be any type that supports arithmetic operations (+, -, /, *) and comparisons (==, !=), for example int or float.

You generally don't have to care about the templated form (gd::Vector2<T>), the most common specializations have special typedefs:

gd::Vector2<float> is gd::Vector2f
gd::Vector2<int> is gd::Vector2i
gd::Vector2<unsigned int> is gd::Vector2u

The gd::Vector2 class has a small and simple interface, its x and y members can be accessed directly (there are no accessors like setX(), getX()) and it contains no mathematical function like dot product, cross product, length, etc.

Usage example:

gd::Vector2f v1(16.5f, 24.f);
v1.x = 18.2f;
float y = v1.y;
 
gd::Vector2f v2 = v1 * 5.f;
gd::Vector2f v3;
v3 = v1 + v2;
 
bool different = (v2 != v3);

Note: for 3-dimensional vectors, see gd::Vector3.

Constructor & Destructor Documentation

◆ Vector2() [1/3]

template<typename T >

gd::Vector2< T >::Vector2 ( )

inline

Default constructor.

Creates a Vector2(0, 0).

◆ Vector2() [2/3]

template<typename T >

gd::Vector2< T >::Vector2	(	T	X,
		T	Y
	)

inline

Construct the vector from its coordinates.

Parameters

X	X coordinate
Y	Y coordinate

◆ Vector2() [3/3]

template<typename T >

template<typename U >

gd::Vector2< T >::Vector2 ( const Vector2< U > & vector )

inlineexplicit

Construct the vector from another type of vector.

This constructor doesn't replace the copy constructor, it's called only when U != T. A call to this constructor will fail to compile if U is not convertible to T.

Parameters

vector Vector to convert

Friends And Related Function Documentation

◆ operator!=()

template<typename T >

bool operator!=	(	const Vector2< T > &	left,
		const Vector2< T > &	right
	)

This operator compares strict difference between two vectors.

Parameters

left	Left operand (a vector)
right	Right operand (a vector)

Returns: True if left is not equal to right

◆ operator*() [1/2]

template<typename T >

Vector2< T > operator*	(	const Vector2< T > &	left,
		T	right
	)

Parameters

left	Left operand (a vector)
right	Right operand (a scalar value)

Returns: Memberwise multiplication by right

◆ operator*() [2/2]

template<typename T >

Vector2< T > operator*	(	T	left,
		const Vector2< T > &	right
	)

Parameters

left	Left operand (a scalar value)
right	Right operand (a vector)

Returns: Memberwise multiplication by left

◆ operator*=()

template<typename T >

Vector2< T > & operator*=	(	Vector2< T > &	left,
		T	right
	)

This operator performs a memberwise multiplication by right, and assigns the result to left.

Parameters

left	Left operand (a vector)
right	Right operand (a scalar value)

Returns: Reference to left

◆ operator+()

template<typename T >

Vector2< T > operator+	(	const Vector2< T > &	left,
		const Vector2< T > &	right
	)

Parameters

left	Left operand (a vector)
right	Right operand (a vector)

Returns: Memberwise addition of both vectors

◆ operator+=()

template<typename T >

Vector2< T > & operator+=	(	Vector2< T > &	left,
		const Vector2< T > &	right
	)

This operator performs a memberwise addition of both vectors, and assigns the result to left.

Parameters

left	Left operand (a vector)
right	Right operand (a vector)

Returns: Reference to left

◆ operator-() [1/2]

template<typename T >

Vector2< T > operator-	(	const Vector2< T > &	left,
		const Vector2< T > &	right
	)

Parameters

left	Left operand (a vector)
right	Right operand (a vector)

Returns: Memberwise subtraction of both vectors

◆ operator-() [2/2]

template<typename T >

Vector2< T > operator- ( const Vector2< T > & right )

Parameters

right Vector to negate

Returns: Memberwise opposite of the vector

◆ operator-=()

template<typename T >

Vector2< T > & operator-=	(	Vector2< T > &	left,
		const Vector2< T > &	right
	)

This operator performs a memberwise subtraction of both vectors, and assigns the result to left.

Parameters

left	Left operand (a vector)
right	Right operand (a vector)

Returns: Reference to left

◆ operator/()

template<typename T >

Vector2< T > operator/	(	const Vector2< T > &	left,
		T	right
	)

Parameters

left	Left operand (a vector)
right	Right operand (a scalar value)

Returns: Memberwise division by right

◆ operator/=()

template<typename T >

Vector2< T > & operator/=	(	Vector2< T > &	left,
		T	right
	)

This operator performs a memberwise division by right, and assigns the result to left.

Parameters

left	Left operand (a vector)
right	Right operand (a scalar value)

Returns: Reference to left

◆ operator==()

template<typename T >

bool operator==	(	const Vector2< T > &	left,
		const Vector2< T > &	right
	)

This operator compares strict equality between two vectors.

Parameters

left	Left operand (a vector)
right	Right operand (a vector)

Returns: True if left is equal to right

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

Vector2.h

Public Member Functions

Public Attributes

Related Functions

Detailed Description

template<typename T> class gd::Vector2< T >

Constructor & Destructor Documentation

◆ Vector2() [1/3]

◆ Vector2() [2/3]

◆ Vector2() [3/3]

Friends And Related Function Documentation

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator==()

template<typename T>
class gd::Vector2< T >