kanzi::Vector3 Class Reference

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

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

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

Static Public Member Functions
static constexpr Vector3	highestValue ()
	Returns the vector with each element having the most positive float value.
static constexpr Vector3	lowestValue ()
	Returns the vector with each element having the most negative float value.
static constexpr Vector3	nan ()
	Returns the vector with each element being NaN.
static constexpr Vector3	negativeInfinity ()
	Returns the vector with each element being the negative infinity.
static constexpr Vector3	negativeX ()
	Returns the unit vector pointing left.
static constexpr Vector3	negativeY ()
	Returns the unit vector pointing down.
static constexpr Vector3	negativeZ ()
	Returns the unit vector pointing forward.
static KZ_NO_DISCARD constexpr const Vector3	one ()
	Returns the vector with each element being one.
static constexpr Vector3	positiveInfinity ()
	Returns the vector with each element being the positive infinity.
static constexpr Vector3	positiveX ()
	Returns the unit vector pointing right.
static constexpr Vector3	positiveY ()
	Returns the unit vector pointing up.
static constexpr Vector3	positiveZ ()
	Returns the unit vector pointing backward.
static KZ_NO_DISCARD constexpr const Vector3	zero ()
	Returns the vector with each element being zero.

Detailed Description

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

Constructor & Destructor Documentation

Vector3() [1/3]

constexpr kanzi::Vector3::Vector3 ( )

inlineexplicitconstexpr

Default constructor.

Initializes the vector to (0.0, 0.0, 0.0).

Vector3() [2/3]

constexpr kanzi::Vector3::Vector3 ( float x, float y, float z )

inlineexplicitconstexpr

Constructor, initializes the vector to (x, y, z).

Parameters

x	X component of the vector.
y	Y component of the vector.
z	Z component of the vector.

Vector3() [3/3]

constexpr kanzi::Vector3::Vector3 ( float v )

inlineexplicitconstexpr

Constructor.

Initializes the vector to (v, v, v).

Parameters

v	X, Y and Z components of the vector.

Member Function Documentation

operator[]() [1/2]

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

inlineconstexpr

Access to individual elements of the vector.

Parameters

index

Index of the accessed element. Should be either 0, 1, or 2.

Returns

If index is 0, x element. If index is 1, y element. If index is 2, z element.

operator[]() [2/2]

constexpr float & kanzi::Vector3::operator[] ( size_t index )

inlineconstexpr

Access to individual elements of the vector.

Parameters

index

Index of the accessed element. Should be either 0, 1, or 2.

Returns

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

operator*=()

constexpr Vector3 & kanzi::Vector3::operator*= ( float scalar )

inlineconstexpr

Multiplies each vector element with a scalar.

Parameters

scalar

Multiplier for each vector element.

Returns

This vector.

operator/=()

constexpr Vector3 & kanzi::Vector3::operator/= ( float scalar )

inlineconstexpr

Divides each vector element with a scalar.

Parameters

scalar

Divider for each vector element.

Returns

This vector.

operator+=() [1/2]

constexpr Vector3 & kanzi::Vector3::operator+= ( float scalar )

inlineconstexpr

Adds a scalar to each vector element.

Parameters

scalar

Addition to each vector element.

Returns

This vector.

operator+=() [2/2]

constexpr Vector3 & kanzi::Vector3::operator+= ( Vector3 v )

inlineconstexpr

Modifies this vector by adding another vector.

Parameters

v	Another vector.

Returns

This vector.

operator-=()

constexpr Vector3 & kanzi::Vector3::operator-= ( Vector3 v )

inlineconstexpr

Modifies this vector by subtracting another vector from this vector.

Parameters

v	Another vector.

Returns

This vector.

zero()

static KZ_NO_DISCARD constexpr const Vector3 kanzi::Vector3::zero ( )

inlinestaticconstexpr

Returns the vector with each element being zero.

Returns

Vector with zeroed elements.

one()

static KZ_NO_DISCARD constexpr const Vector3 kanzi::Vector3::one ( )

inlinestaticconstexpr

Returns the vector with each element being one.

Returns

Vector with unit element values.

getX()

constexpr float kanzi::Vector3::getX ( ) const

inlineconstexpr

Returns the x element of the vector.

Returns

The x element.

getY()

constexpr float kanzi::Vector3::getY ( ) const

inlineconstexpr

Returns the y element of the vector.

Returns

The y element.

getZ()

constexpr float kanzi::Vector3::getZ ( ) const

inlineconstexpr

Returns the z element of the vector.

Returns

The z element.

setX()

constexpr void kanzi::Vector3::setX ( float value )

inlineconstexpr

Sets the x element of the vector.

Parameters

value

The new value of the x element.

setY()

constexpr void kanzi::Vector3::setY ( float value )

inlineconstexpr

Sets the y element of the vector.

Parameters

value

The new value of the y element.

setZ()

constexpr void kanzi::Vector3::setZ ( float value )

inlineconstexpr

Sets the z element of the vector.

Parameters

value

The new value of the z element.

minimumAxis()

Vector3 kanzi::Vector3::minimumAxis ( ) const

inline

Returns axis based on the minimum component of Vector3.

Returns

If X component is smallest, (1, 0, 0), else if Y component is smallest, (0, 1, 0), else (0, 0, 1).

maximumAxis()

Vector3 kanzi::Vector3::maximumAxis ( ) const

inline

Returns axis based on the largest component of Vector3.

Returns

If X component is largest, (1, 0, 0), else if Y component is largest, (0, 1, 0), else (0, 0, 1).

length()

float kanzi::Vector3::length ( ) const

inline

Calculates the length a vectors.

Returns

sqrt(x*x + y*y + z*z)

squaredLength()

constexpr float kanzi::Vector3::squaredLength ( ) const

constexpr

Calculates the squared length a vectors.

Returns

x*x + y*y + z*z

normalized()

KZ_NO_DISCARD Vector3 kanzi::Vector3::normalized ( ) const

inline

Normalizes the vector and returns the resulting vector.

Returns

The normalized vector.

lowestValue()

static constexpr Vector3 kanzi::Vector3::lowestValue ( )

inlinestaticconstexpr

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

Returns

Vector with the lowest possible value.

highestValue()

static constexpr Vector3 kanzi::Vector3::highestValue ( )

inlinestaticconstexpr

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

Returns

Vector with the highest possible value.

nan()

static constexpr Vector3 kanzi::Vector3::nan ( )

inlinestaticconstexpr

Returns the vector with each element being NaN.

Returns

Vector with NaN elements.

hasNan()

bool kanzi::Vector3::hasNan ( ) const

inline

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

positiveInfinity()

static constexpr Vector3 kanzi::Vector3::positiveInfinity ( )

inlinestaticconstexpr

Returns the vector with each element being the positive infinity.

Returns

Vector with positive infinity elements.

negativeInfinity()

static constexpr Vector3 kanzi::Vector3::negativeInfinity ( )

inlinestaticconstexpr

Returns the vector with each element being the negative infinity.

Returns

Vector with negative infinity elements.

positiveX()

static constexpr Vector3 kanzi::Vector3::positiveX ( )

inlinestaticconstexpr

Returns the unit vector pointing right.

Returns

Vector3(1.0f, 0.0f, 0.0f).

positiveY()

static constexpr Vector3 kanzi::Vector3::positiveY ( )

inlinestaticconstexpr

Returns the unit vector pointing up.

Returns

Vector3(0.0f, 1.0f, 0.0f).

positiveZ()

static constexpr Vector3 kanzi::Vector3::positiveZ ( )

inlinestaticconstexpr

Returns the unit vector pointing backward.

Returns

Vector3(0.0f, 0.0f, 1.0f).

negativeX()

static constexpr Vector3 kanzi::Vector3::negativeX ( )

inlinestaticconstexpr

Returns the unit vector pointing left.

Returns

Vector3(-1.0f, 0.0f, 0.0f).

negativeY()

static constexpr Vector3 kanzi::Vector3::negativeY ( )

inlinestaticconstexpr

Returns the unit vector pointing down.

Returns

Vector3(0.0f, -1.0f, 0.0f).

negativeZ()

static constexpr Vector3 kanzi::Vector3::negativeZ ( )

inlinestaticconstexpr

Returns the unit vector pointing forward.

Returns

Vector3(0.0f, 0.0f, -1.0f).

---

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

• kanzi/core/math/vector3.hpp