3-component vector. More...

#include <Vec3.hpp>

Public Member Functions
	Vec3 (Vec3 &&v) noexcept=default
	Move constructor.

	Vec3 (const Vec3 &other) noexcept=default
	Copy constructor.

	Vec3 (float ax, float ay, float az) noexcept

Vec3 &	operator= (Vec3 &&) noexcept=default
	Move assignment.

Vec3	operator/ (float f) const

Vec3	operator/ (const Vec3 &v) const

Vec3	operator- () const

Vec3	operator- (const Vec3 &v) const

Vec3	operator+ (const Vec3 &v) const

Vec3	operator+ (float f) const

Vec3 &	operator-= (const Vec3 &v)

Vec3 &	operator+= (const Vec3 &v)

Vec3 &	operator*= (float f)

Vec3 &	operator/= (float f)

Vec3 &	operator*= (const Vec3 &v)

Vec3 &	operator= (const Vec3 &v)

Vec3	operator* (const Vec3 &v) const

Vec3	operator* (float f) const

Vec3	Normalized () const

bool	IsAlmost (const Vec3 &v2) const

float	Length () const

void	Zero ()
	Resets this vector's values to 0.

Static Public Member Functions
static Vec3	Cross (const Vec3 &v1, const Vec3 &v2)
	Cross product. More...

static Vec3	Min2 (const Vec3 &v1, const Vec3 &v2)

static Vec3	Max2 (const Vec3 &v1, const Vec3 &v2)

static float	Distance (const Vec3 &v1, const Vec3 &v2)

static float	DistanceSquared (const Vec3 &v1, const Vec3 &v2)

static float	Dot (const Vec3 &v1, const Vec3 &v2)

static Vec3	Reflect (const Vec3 &vec, const Vec3 &normal)

Public Attributes
float	x = 0
	X coordinate.

float	y = 0
	Y coordinate.

float	z = 0
	Z coordinate.

Detailed Description

3-component vector.

Constructor & Destructor Documentation

ae3d::Vec3::Vec3	(	float	ax,
		float	ay,
		float	az
	)

inlinenoexcept

Constructor.

Parameters

ax	X-coordinate.
ay	Y-coordinate.
az	Z-coordinate.

Member Function Documentation

static Vec3 ae3d::Vec3::Cross	(	const Vec3 &	v1,
		const Vec3 &	v2
	)

inlinestatic

Cross product.

Parameters

v1	Vector.
v2	Another vector.

Returns: Cross product of this vector and v.

static float ae3d::Vec3::Distance	(	const Vec3 &	v1,
		const Vec3 &	v2
	)

inlinestatic

Solves distance between two vectors.

Parameters

v1	Vector.
v2	Other vector.

Returns: Distance.

See also: DistanceSquared()

static float ae3d::Vec3::DistanceSquared	(	const Vec3 &	v1,
		const Vec3 &	v2
	)

inlinestatic

Solves squared distance between two vectors.

Parameters

v1	Vector.
v2	Other vector.

Returns: Squared distance.

See also: Distance()

static float ae3d::Vec3::Dot	(	const Vec3 &	v1,
		const Vec3 &	v2
	)

inlinestatic

Dot product.

Parameters

v1	Vector.
v2	Other vector.

Returns: Dot product of vectors v1 and v2.

bool ae3d::Vec3::IsAlmost ( const Vec3 & v2 ) const

inline

Compares this vector with another vector.

Parameters

v2	Another vector.

Returns: True if vectors are almost equal.

float ae3d::Vec3::Length ( ) const

inline

Returns: length.

static Vec3 ae3d::Vec3::Max2	(	const Vec3 &	v1,
		const Vec3 &	v2
	)

inlinestatic

Gets maximum components and creates a new vector from them. Example: v1( 1, 0, 2 ), v2( 2, 1, 1 ) -> result( 2, 1, 2 ).

Parameters

v1	Vector.
v2	Other vector.

Returns: Vector that has v1's and v2's maximum components.

static Vec3 ae3d::Vec3::Min2	(	const Vec3 &	v1,
		const Vec3 &	v2
	)

inlinestatic

Gets minimum components and creates a new vector from them. Example:

v1( 1, 0, 2 ), v2( 2, 1, 1 ) -> result( 1, 0, 1 )

.

Parameters

v1	Vector.
v2	Other vector.

Returns: Vector that has v1's and v2's minimum components.

See also: Max2()

Vec3 ae3d::Vec3::Normalized ( ) const

inline

Returns a normalized vector

Vec3 ae3d::Vec3::operator* ( const Vec3 & v ) const

inline

Multiplication operator.

Parameters

v	A vector that is multiplied with this vector

Returns: A vector that is the product of this vector and v.

Vec3 ae3d::Vec3::operator* ( float f ) const

inline

Multiplication operator.

Parameters

f	A value that is multiplied with this vector.

Returns: This vector multiplied by f.

Vec3& ae3d::Vec3::operator*= ( float f )

inline

Operator multiply and assign.

Parameters

f	A value that is to be multiplied with this vector.

Returns: Reference to this vector.

Vec3& ae3d::Vec3::operator*= ( const Vec3 & v )

inline

Operator multiply and assign.

Parameters

v	A value that is to be multiplied with this vector.

Returns: Reference to this vector.

Vec3 ae3d::Vec3::operator+ ( const Vec3 & v ) const

inline

Addition operator.

Parameters

v	a vector that is to be added to this vector.

Returns: A vector that is the sum of this vector and v.

Vec3 ae3d::Vec3::operator+ ( float f ) const

inline

Addition operator.

Parameters

f	a value that is to be added to this vector.

Returns: A vector that is the sum of this vector and c.

Vec3& ae3d::Vec3::operator+= ( const Vec3 & v )

inline

Operator add and assign.

Parameters

v	Vector that is to be added to this vector.

Returns: Reference to this vector.

Vec3 ae3d::Vec3::operator- ( ) const

inline

Negation operator.

Returns: a vector that has negative values.

Vec3 ae3d::Vec3::operator- ( const Vec3 & v ) const

inline

Subtraction operator.

Parameters

v	a vector that is to be subtracted from this vector.

Returns: result of the subtraction.

Vec3& ae3d::Vec3::operator-= ( const Vec3 & v )

inline

Operator subtract and assign.

Parameters

v	Vector that is to be subtracted from this vector.

Returns: Reference to this vector.

Vec3 ae3d::Vec3::operator/ ( float f ) const

inline

Divides by a scalar operator.

Parameters

f	Scalar value.

Returns: a vector that has its values divided by f.

Vec3 ae3d::Vec3::operator/ ( const Vec3 & v ) const

inline

Divides by a vector operator.

Parameters

v	Vector value.

Returns: a vector that has its values divided by v.

Vec3& ae3d::Vec3::operator/= ( float f )

inline

Operator divide and assign.

Parameters

f	A value that is to be divided with this vector.

Returns: Reference to this vector.

Vec3& ae3d::Vec3::operator= ( const Vec3 & v )

inline

Assignment operator.

Parameters

v	a vector that is assigned to this vector.

Returns: Reference to this vector.

static Vec3 ae3d::Vec3::Reflect	(	const Vec3 &	vec,
		const Vec3 &	normal
	)

inlinestatic

Reflects a vector with normal.

Parameters

vec	Vector.
normal	Normal.

Returns: Reflected vector.

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

Vec3.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation