kanzi::Vector2 Class Reference

Vector with 2 floating point components: (x, y). More...

#include <kanzi/core/math/vector2.hpp>

Public Member Functions
float	getX () const
	Returns the x element of the vector. More...
float	getY () const
	Returns the y element of the vector. More...
bool	hasNan () const
	Returns true if and only if at least one of the vector values is NaN. More...
float	length () const
	Calculates the length a vectors. More...
KZ_NO_DISCARD Vector2	normalized () const
	Normalizes the vector and returns the resulting vector. More...
Vector2 &	operator*= (float scalar)
	Multiplies each vector element with a scalar. More...
Vector2 &	operator+= (float scalar)
	Adds a scalar to each vector element. More...
Vector2 &	operator+= (const Vector2 &v)
	Modifies this vector by adding another vector. More...
Vector2 &	operator-= (const Vector2 &v)
	Modifies this vector by subtracting another vector from this vector. More...
Vector2 &	operator/= (float scalar)
	Divides each vector element with a scalar. More...
const float &	operator[] (size_t index) const
	Access to individual elements of a vector. More...
float &	operator[] (size_t index)
	Access to individual elements of the vector. More...
void	setX (float value)
	Sets the x element of the vector. More...
void	setY (float value)
	Sets the y element of the vector. More...
float	squaredLength () const
	Calculates the squared length a vectors. More...
	Vector2 ()
	Default constructor. Initializes a vector to (0.0, 0.0). More...
	Vector2 (float x, float y)
	Constructor. More...
	Vector2 (float v)
	Constructor. More...

Static Public Member Functions
static Vector2	createFromVector3 (Vector3 v)
	Creates a Vector2 from Vector3 by dropping the z-coordinate. More...
static Vector2	highestValue ()
	Returns the vector with each element having the most positive float value. More...
static Vector2	lowestValue ()
	Returns the vector with each element having the most negative float value. More...
static Vector2	nan ()
	Returns the vector with each element being NaN. More...
static Vector2	negativeInfinity ()
	Returns the vector with each element being the negative infinity. More...
static KZ_NO_DISCARD const Vector2	one ()
	Returns the vector with each element being one. More...
static Vector2	positiveInfinity ()
	Returns the vector with each element being the positive infinity. More...
static KZ_NO_DISCARD const Vector2	zero ()
	Returns the vector with each element being zero. More...

Detailed Description

Vector with 2 floating point components: (x, y).

Constructor & Destructor Documentation

Vector2() [1/3]

kanzi::Vector2::Vector2 ( )

inlineexplicit

Default constructor. Initializes a vector to (0.0, 0.0).

Vector2() [2/3]

kanzi::Vector2::Vector2 ( float  x, float  y  )

inlineexplicit

Constructor.

Initializes a vector to (x, y).

Parameters

x	x coefficient of a vector.
y	y coefficient of a vector.

Vector2() [3/3]

kanzi::Vector2::Vector2 ( float  v )

inlineexplicit

Constructor.

Initializes a vector to (v, v).

Parameters

v	x and y coefficients of a vector.

Member Function Documentation

operator[]() [1/2]

const float& kanzi::Vector2::operator[] ( size_t  index ) const

inline

Access to individual elements of a vector.

Parameters

index

The index of the accessed element. Either 0 or 1.

Returns

If index is 0, the x element. If index is 1, the y element.

operator[]() [2/2]

float& kanzi::Vector2::operator[] ( size_t  index )

inline

Access to individual elements of the vector.

Parameters

index

Index of the accessed element. Either 0 or 1.

Returns

If index is 0, reference to x element. If index is 1, reference to y element.

operator*=()

Vector2& kanzi::Vector2::operator*= ( float  scalar )

inline

Multiplies each vector element with a scalar.

Parameters

scalar

Multiplier for each vector element.

Returns

This vector.

operator/=()

Vector2& kanzi::Vector2::operator/= ( float  scalar )

inline

Divides each vector element with a scalar.

Parameters

scalar

Divider for each vector element.

Returns

This vector.

operator+=() [1/2]

Vector2& kanzi::Vector2::operator+= ( float  scalar )

inline

Adds a scalar to each vector element.

Parameters

scalar

Addition to each vector element.

Returns

This vector.

operator+=() [2/2]

Vector2& kanzi::Vector2::operator+= ( const Vector2 &  v )

inline

Modifies this vector by adding another vector.

Parameters

v	Another vector.

Returns

This vector.

operator-=()

Vector2& kanzi::Vector2::operator-= ( const Vector2 &  v )

inline

Modifies this vector by subtracting another vector from this vector.

Parameters

v	Another vector.

Returns

This vector.

zero()

static KZ_NO_DISCARD const Vector2 kanzi::Vector2::zero ( )

inlinestatic

Returns the vector with each element being zero.

Returns

Vector with zeroed elements.

one()

static KZ_NO_DISCARD const Vector2 kanzi::Vector2::one ( )

inlinestatic

Returns the vector with each element being one.

Returns

Vector with unit element values.

getX()

float kanzi::Vector2::getX ( ) const

inline

Returns the x element of the vector.

Returns

The x element.

getY()

float kanzi::Vector2::getY ( ) const

inline

Returns the y element of the vector.

Returns

The y element.

setX()

void kanzi::Vector2::setX ( float  value )

inline

Sets the x element of the vector.

Parameters

value

The new value of the x element.

setY()

void kanzi::Vector2::setY ( float  value )

inline

Sets the y element of the vector.

Parameters

value

The new value of the y element.

length()

float kanzi::Vector2::length ( ) const

inline

Calculates the length a vectors.

Returns

sqrt(x*x + y*y)

squaredLength()

float kanzi::Vector2::squaredLength ( ) const

inline

Calculates the squared length a vectors.

Returns

x*x + y*y

normalized()

KZ_NO_DISCARD Vector2 kanzi::Vector2::normalized ( ) const

inline

Normalizes the vector and returns the resulting vector.

Returns

The normalized vector.

lowestValue()

Vector2 kanzi::Vector2::lowestValue ( )

inlinestatic

Returns the vector with each element having the most negative float value.

Returns

Vector with the lowest possible value.

highestValue()

Vector2 kanzi::Vector2::highestValue ( )

inlinestatic

Returns the vector with each element having the most positive float value.

Returns

Vector with the highest possible value.

nan()

Vector2 kanzi::Vector2::nan ( )

inlinestatic

Returns the vector with each element being NaN.

Returns

Vector with NaN elements.

hasNan()

bool kanzi::Vector2::hasNan ( ) const

inline

Returns true if and only if at least one of the vector values is NaN.

positiveInfinity()

Vector2 kanzi::Vector2::positiveInfinity ( )

inlinestatic

Returns the vector with each element being the positive infinity.

Returns

Vector with positive infinity elements.

negativeInfinity()

Vector2 kanzi::Vector2::negativeInfinity ( )

inlinestatic

Returns the vector with each element being the negative infinity.

Returns

Vector with negative infinity elements.

createFromVector3()

static Vector2 kanzi::Vector2::createFromVector3 ( Vector3  v )

inlinestatic

Creates a Vector2 from Vector3 by dropping the z-coordinate.

Parameters

v	Input vector.

Returns

The input vector without z-coordinate.

---

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

• kanzi/core/math/vector2.hpp