2D vector 2 class More...

#include <tdme/math/Vector2.h>

Collaboration diagram for Vector2:

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

	Vector2 (float x, float y)
	Public constructor. More...

	Vector2 (const array< float, 2 > &v)
	Public constructor. More...

	Vector2 (const Vector2 &v)
	Public constructor. More...

Vector2 &	set (float x, float y)
	Set up vector. More...

Vector2 &	set (const array< float, 2 > &v)
	Set up vector. More...

Vector2 &	set (const Vector2 &v)
	Set up vector. More...

float	getX () const

Vector2 &	setX (float x)
	set X More...

float	getY () const

Vector2 &	setY (float y)
	set Y More...

Vector2 &	add (const Vector2 &v)
	Adds a vector. More...

Vector2 &	sub (const Vector2 &v)
	Subtracts a vector. More...

Vector2 &	scale (const float scale)
	Scale this vector. More...

Vector2 &	scale (const Vector2 &scale)
	Scale this vector. More...

float	computeLength () const

float &	operator[] (int i)
	Array access operator. More...

const float &	operator[] (int i) const
	Const array access operator. More...

Vector2	operator+ (const Vector2 &v) const
	Operator +. More...

Vector2	operator- (const Vector2 &v) const
	Operator -. More...

Vector2	operator* (const float f) const
	Operator * (float) More...

Vector2	operator* (const Vector2 &v) const
	Operator * (Vector2&) More...

Vector2	operator/ (const float f) const
	Operator / (f) More...

Vector2	operator/ (const Vector2 &v) const
	Operator / (Vector2&) More...

Vector2 &	operator+= (const Vector2 &v)
	Operator +=. More...

Vector2 &	operator-= (Vector2 &v)
	Operator -=. More...

Vector2 &	operator*= (Vector2 &v)
	Operator *=. More...

Vector2 &	operator/= (Vector2 &v)
	Operator /=. More...

Vector2 &	operator*= (const float f)
	Operator *=. More...

Vector2 &	operator/= (const float f)
	Operator /=. More...

bool	operator== (const Vector2 &v) const
	Equality comparison operator. More...

bool	operator!= (const Vector2 &v) const
	Non equality comparison operator. More...

array< float, 2 > &	getArray () const

Vector2	clone () const
	Clones the vector. More...

bool	equals (const Vector2 &v) const
	Compares this vector with given vector. More...

bool	equals (const Vector2 &v, float tolerance) const
	Compares this vector with given vector. More...

Private Attributes
array< float, 2 >	data

Friends
class	Matrix2D3x3

Detailed Description

2D vector 2 class

Author: Andreas Drewke

Version: $Id$

Definition at line 18 of file Vector2.h.

Constructor & Destructor Documentation

◆ Vector2() [1/4]

Vector2 ( )

inline

Public constructor.

Definition at line 29 of file Vector2.h.

◆ Vector2() [2/4]

Vector2	(	float	x,
		float	y
	)

inline

Public constructor.

Parameters

x	x
y	y

Definition at line 38 of file Vector2.h.

◆ Vector2() [3/4]

Vector2 ( const array< float, 2 > & v )

inline

Public constructor.

Parameters

v	float values

Definition at line 47 of file Vector2.h.

◆ Vector2() [4/4]

Vector2 ( const Vector2 & v )

inline

Public constructor.

Parameters

v v

Definition at line 55 of file Vector2.h.

Member Function Documentation

◆ add()

Vector2 & add ( const Vector2 & v )

inline

Adds a vector.

Parameters

v v

Returns: this vector

Definition at line 129 of file Vector2.h.

◆ clone()

Vector2 clone ( ) const

inline

Clones the vector.

Returns: new cloned vector

Definition at line 338 of file Vector2.h.

◆ computeLength()

float computeLength ( ) const

inline

Returns: the vectors length

Definition at line 171 of file Vector2.h.

◆ equals() [1/2]

bool equals ( const Vector2 & v ) const

inline

Compares this vector with given vector.

Parameters

v vector v

Returns: equality

Definition at line 347 of file Vector2.h.

◆ equals() [2/2]

bool equals	(	const Vector2 &	v,
		float	tolerance
	)		const

inline

Compares this vector with given vector.

Parameters

v	vector v
tolerance	tolerance per component(x, y, z)

Returns: equality

Definition at line 357 of file Vector2.h.

◆ getArray()

array< float, 2 > & getArray ( ) const

inline

Returns: vector as array

Definition at line 330 of file Vector2.h.

◆ getX()

float getX ( ) const

inline

Returns: x

Definition at line 94 of file Vector2.h.

◆ getY()

float getY ( ) const

inline

Returns: y

Definition at line 111 of file Vector2.h.

◆ operator!=()

bool operator!= ( const Vector2 & v ) const

inline

Non equality comparison operator.

Parameters

v	vector to compare to

Returns: non equality

Definition at line 323 of file Vector2.h.

◆ operator*() [1/2]

Vector2 operator* ( const float f ) const

inline

Operator * (float)

Parameters

f	value to multiply by

Returns: new vector (this * f)

Definition at line 218 of file Vector2.h.

◆ operator*() [2/2]

Vector2 operator* ( const Vector2 & v ) const

inline

Operator * (Vector2&)

Parameters

v	vector to multiply by

Returns: new vector (this * v)

Definition at line 228 of file Vector2.h.

◆ operator*=() [1/2]

Vector2 & operator*= ( const float f )

inline

Operator *=.

Parameters

f	float to multiply by

Returns: this vector multiplied by f

Definition at line 296 of file Vector2.h.

◆ operator*=() [2/2]

Vector2 & operator*= ( Vector2 & v )

inline

Operator *=.

Parameters

v	vector to multiply by

Returns: this vector multiplied by v

Definition at line 277 of file Vector2.h.

◆ operator+()

Vector2 operator+ ( const Vector2 & v ) const

inline

Operator +.

Parameters

v	vector to add

Returns: new vector (this + v)

Definition at line 198 of file Vector2.h.

◆ operator+=()

Vector2 & operator+= ( const Vector2 & v )

inline

Operator +=.

Parameters

v	vector to add

Returns: this vector added by v

Definition at line 259 of file Vector2.h.

◆ operator-()

Vector2 operator- ( const Vector2 & v ) const

inline

Operator -.

Parameters

v	vector to subtract

Returns: new vector (this - v)

Definition at line 208 of file Vector2.h.

◆ operator-=()

Vector2 & operator-= ( Vector2 & v )

inline

Operator -=.

Parameters

v	vector to substract

Returns: this vector substracted by v

Definition at line 268 of file Vector2.h.

◆ operator/() [1/2]

Vector2 operator/ ( const float f ) const

inline

Operator / (f)

Parameters

v	value to divide by

Returns: new vector (this / f)

Definition at line 238 of file Vector2.h.

◆ operator/() [2/2]

Vector2 operator/ ( const Vector2 & v ) const

inline

Operator / (Vector2&)

Parameters

v	vector to divide by

Returns: new vector (this / v)

Definition at line 248 of file Vector2.h.

◆ operator/=() [1/2]

Vector2 & operator/= ( const float f )

inline

Operator /=.

Parameters

f	float to divide by

Returns: this vector divided by f

Definition at line 305 of file Vector2.h.

◆ operator/=() [2/2]

Vector2 & operator/= ( Vector2 & v )

inline

Operator /=.

Parameters

v	vector to devide by

Returns: this vector devided by v

Definition at line 286 of file Vector2.h.

◆ operator==()

bool operator== ( const Vector2 & v ) const

inline

Equality comparison operator.

Parameters

v	vector to compare to

Returns: equality

Definition at line 314 of file Vector2.h.

◆ operator[]() [1/2]

float & operator[] ( int i )

inline

Array access operator.

Parameters

i index

Returns: vector3 component

Definition at line 180 of file Vector2.h.

◆ operator[]() [2/2]

const float & operator[] ( int i ) const

inline

Const array access operator.

Parameters

i index

Returns: vector3 component

Definition at line 189 of file Vector2.h.

◆ scale() [1/2]

Vector2 & scale ( const float scale )

inline

Scale this vector.

Parameters

scale scale

Returns: this vector

Definition at line 151 of file Vector2.h.

◆ scale() [2/2]

Vector2 & scale ( const Vector2 & scale )

inline

Scale this vector.

Parameters

scale scale

Returns: this vector

Definition at line 162 of file Vector2.h.

◆ set() [1/3]

Vector2 & set ( const array< float, 2 > & v )

inline

Set up vector.

Parameters

v	float array containing x,y values

Returns: this vector

Definition at line 76 of file Vector2.h.

◆ set() [2/3]

Vector2 & set ( const Vector2 & v )

inline

Set up vector.

Parameters

v v

Returns: this vector

Definition at line 86 of file Vector2.h.

◆ set() [3/3]

Vector2 & set	(	float	x,
		float	y
	)

inline

Set up vector.

Parameters

x	x
y	y

Returns: this vector

Definition at line 65 of file Vector2.h.

◆ setX()

Vector2 & setX ( float x )

inline

set X

Parameters

x x

Returns: this vector

Definition at line 103 of file Vector2.h.

◆ setY()

Vector2 & setY ( float y )

inline

set Y

Parameters

y y

Definition at line 119 of file Vector2.h.

◆ sub()

Vector2 & sub ( const Vector2 & v )

inline

Subtracts a vector.

Parameters

v v

Returns: this vector

Definition at line 140 of file Vector2.h.

Friends And Related Function Documentation

◆ Matrix2D3x3

friend class Matrix2D3x3

friend

Definition at line 20 of file Vector2.h.

Member Data Documentation

◆ data

array<float, 2> data

private

Definition at line 23 of file Vector2.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/math/Vector2.h

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Vector2() [1/4]

◆ Vector2() [2/4]

◆ Vector2() [3/4]

◆ Vector2() [4/4]

Member Function Documentation

◆ add()

◆ clone()

◆ computeLength()

◆ equals() [1/2]

◆ equals() [2/2]

◆ getArray()

◆ getX()

◆ getY()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ scale() [1/2]

◆ scale() [2/2]

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ setX()

◆ setY()

◆ sub()

Friends And Related Function Documentation

◆ Matrix2D3x3

Member Data Documentation

◆ data