3D vector 3 class More...

#include <tdme/math/Vector3.h>

Collaboration diagram for Vector3:

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

	Vector3 (float x, float y, float z)
	Public constructor. More...

	Vector3 (const array< float, 3 > &v)
	Public constructor. More...

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

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

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

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

float	getX () const

Vector3 &	setX (float x)
	Set X. More...

float	getY () const

Vector3 &	setY (float y)
	Set Y. More...

float	getZ () const

Vector3 &	setZ (float z)
	Set Z. More...

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

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

array< float, 3 > &	getArray () const

float	computeLength () const

float	computeLengthSquared () const

bool	computeEulerAngles (Vector3 &euler) const
	Compute Euler angles (rotation around x, y, z axes) More...

Vector3 &	abs ()
	Convert this vector to vector with positive vector components. More...

Vector3 &	normalize ()
	Normalize the vector. More...

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

Vector3 &	add (float value)
	Adds a float to each vector component. More...

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

Vector3 &	sub (float value)
	Subtracts a float from each vector component. More...

Vector3 &	scale (float scale)
	Scale this vector. More...

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

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

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

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

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

Vector3	operator- (const Vector3 &v) const
	Operator +. More...

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

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

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

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

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

Vector3 &	operator-= (const Vector3 &v)
	Operator -=. More...

Vector3 &	operator*= (const Vector3 &v)
	Operator *=. More...

Vector3 &	operator/= (const Vector3 &v)
	Operator /=. More...

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

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

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

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

Static Public Member Functions
static Vector3	computeCrossProduct (const Vector3 &v1, const Vector3 &v2)
	Compute the cross product of vector v1 and v2. More...

static float	computeDotProduct (const Vector3 &v1, const Vector3 &v2)
	Compute the dot product of vector v1 and v2. More...

static float	computeAngle (const Vector3 &a, const Vector3 &b)
	Computes angle between a and b from 0..180. More...

static float	computeAngle (const Vector3 &a, const Vector3 &b, const Vector3 &n)
	Computes angle between a and b. More...

static Vector3	interpolateLinear (const Vector3 &v1, const Vector3 &v2, float t)
	Interpolates between vector 1 and vector2 by 0f<=t<=1f linearly. More...

Private Attributes
array< float, 3 >	data

Friends
class	Matrix4x4

class	Quaternion

class	Vector4

Detailed Description

3D vector 3 class

Author: andreas.drewke

Version: $Id$

Definition at line 21 of file Vector3.h.

Constructor & Destructor Documentation

◆ Vector3() [1/4]

Vector3 ( )

inline

Public constructor.

Definition at line 34 of file Vector3.h.

◆ Vector3() [2/4]

Vector3	(	float	x,
		float	y,
		float	z
	)

inline

Public constructor.

Parameters

x	x
y	y
z	z

Definition at line 44 of file Vector3.h.

◆ Vector3() [3/4]

Vector3 ( const array< float, 3 > & v )

inline

Public constructor.

Parameters

v values

Definition at line 54 of file Vector3.h.

◆ Vector3() [4/4]

Vector3 ( const Vector3 & v )

inline

Public constructor.

Parameters

v vector

Definition at line 62 of file Vector3.h.

Member Function Documentation

◆ abs()

Vector3 & abs ( )

inline

Convert this vector to vector with positive vector components.

Returns: this vector

Definition at line 277 of file Vector3.h.

◆ add() [1/2]

Vector3 & add ( const Vector3 & v )

inline

Adds a vector.

Parameters

v v

Returns: this vector

Definition at line 301 of file Vector3.h.

◆ add() [2/2]

Vector3 & add ( float value )

inline

Adds a float to each vector component.

Parameters

value v

Returns: this vector

Definition at line 313 of file Vector3.h.

◆ clone()

Vector3 clone ( ) const

inline

Clones the vector.

Returns: new cloned vector

Definition at line 372 of file Vector3.h.

◆ computeAngle() [1/2]

static float computeAngle	(	const Vector3 &	a,
		const Vector3 &	b
	)

inlinestatic

Computes angle between a and b from 0..180.

Parameters

a	vector a, vector to test, must be normalized
b	vector b, vector to test against, must be normalized

Returns

Definition at line 254 of file Vector3.h.

◆ computeAngle() [2/2]

static float computeAngle	(	const Vector3 &	a,
		const Vector3 &	b,
		const Vector3 &	n
	)

inlinestatic

Computes angle between a and b.

Parameters

a	vector a, vector to test, must be normalized
b	vector b, vector to test against, must be normalized
n	plane normal n where a and b live in, must be normalized

Returns

Definition at line 266 of file Vector3.h.

◆ computeCrossProduct()

static Vector3 computeCrossProduct	(	const Vector3 &	v1,
		const Vector3 &	v2
	)

inlinestatic

Compute the cross product of vector v1 and v2.

Parameters

v1	vector 1
v2	vector 2

Returns: resulting vector

Definition at line 181 of file Vector3.h.

◆ computeDotProduct()

static float computeDotProduct	(	const Vector3 &	v1,
		const Vector3 &	v2
	)

inlinestatic

Compute the dot product of vector v1 and v2.

Parameters

v1	v1
v2	v2

Returns: Vector3

Definition at line 195 of file Vector3.h.

◆ computeEulerAngles()

bool computeEulerAngles ( Vector3 & euler ) const

inline

Compute Euler angles (rotation around x, y, z axes)

Parameters

euler euler angles

Returns: if euler angles have been generated

Definition at line 218 of file Vector3.h.

◆ computeLength()

float computeLength ( ) const

inline

Returns: the vectors length

Definition at line 202 of file Vector3.h.

◆ computeLengthSquared()

float computeLengthSquared ( ) const

inline

Returns: the vectors length squared

Definition at line 209 of file Vector3.h.

◆ equals() [1/2]

bool equals ( const Vector3 & v ) const

inline

Compares this vector with given vector.

Parameters

v vector v

Returns: equality

Definition at line 381 of file Vector3.h.

◆ equals() [2/2]

bool equals	(	const Vector3 &	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 406 of file Vector3.h.

◆ getArray()

array< float, 3 > & getArray ( ) const

inline

Returns: vector as array

Definition at line 171 of file Vector3.h.

◆ getX()

float getX ( ) const

inline

Returns: x

Definition at line 103 of file Vector3.h.

◆ getY()

float getY ( ) const

inline

Returns: y

Definition at line 119 of file Vector3.h.

◆ getZ()

float getZ ( ) const

inline

Returns: z

Definition at line 136 of file Vector3.h.

◆ interpolateLinear()

static Vector3 interpolateLinear	(	const Vector3 &	v1,
		const Vector3 &	v2,
		float	t
	)

inlinestatic

Interpolates between vector 1 and vector2 by 0f<=t<=1f linearly.

Parameters

v1	vector 1
v2	vector 2
t	t

Returns: resulting vector

Definition at line 392 of file Vector3.h.

◆ normalize()

Vector3 & normalize ( )

inline

Normalize the vector.

Returns: this vector

Definition at line 288 of file Vector3.h.

◆ operator!=()

bool operator!= ( const Vector3 & v ) const

inline

Non equality comparison operator.

Parameters

v	vector to compare to

Returns: non equality

Definition at line 545 of file Vector3.h.

◆ operator*() [1/2]

Vector3 operator* ( const float f ) const

inline

Operator * (float)

Parameters

f	value to multiply by

Returns: new vector (this * f)

Definition at line 440 of file Vector3.h.

◆ operator*() [2/2]

Vector3 operator* ( const Vector3 & v ) const

inline

Operator * (Vector3&)

Parameters

v	vector to multiply by

Returns: new vector (this * v)

Definition at line 450 of file Vector3.h.

◆ operator*=() [1/2]

Vector3 & operator*= ( const float f )

inline

Operator *=.

Parameters

f	float to multiply by

Returns: this vector multiplied by f

Definition at line 518 of file Vector3.h.

◆ operator*=() [2/2]

Vector3 & operator*= ( const Vector3 & v )

inline

Operator *=.

Parameters

v	vector to multiply by

Returns: this vector multiplied by v

Definition at line 499 of file Vector3.h.

◆ operator+()

Vector3 operator+ ( const Vector3 & v ) const

inline

Operator +.

Parameters

v	vector to add

Returns: new vector (this + v)

Definition at line 420 of file Vector3.h.

◆ operator+=()

Vector3 & operator+= ( const Vector3 & v )

inline

Operator +=.

Parameters

v	vector to add

Returns: this vector added by v

Definition at line 481 of file Vector3.h.

◆ operator-()

Vector3 operator- ( const Vector3 & v ) const

inline

Operator +.

Parameters

v	vector to subtract

Returns: new vector (this - v)

Definition at line 430 of file Vector3.h.

◆ operator-=()

Vector3 & operator-= ( const Vector3 & v )

inline

Operator -=.

Parameters

v	vector to substract

Returns: this vector substracted by v

Definition at line 490 of file Vector3.h.

◆ operator/() [1/2]

Vector3 operator/ ( const float f ) const

inline

Operator / (f)

Parameters

v	value to divide by

Returns: new vector (this / f)

Definition at line 460 of file Vector3.h.

◆ operator/() [2/2]

Vector3 operator/ ( const Vector3 & v ) const

inline

Operator / (Vector3&)

Parameters

v	vector to divide by

Returns: new vector (this / v)

Definition at line 470 of file Vector3.h.

◆ operator/=() [1/2]

Vector3 & operator/= ( const float f )

inline

Operator /=.

Parameters

f	float to divide by

Returns: this vector divided by f

Definition at line 527 of file Vector3.h.

◆ operator/=() [2/2]

Vector3 & operator/= ( const Vector3 & v )

inline

Operator /=.

Parameters

v	vector to divide by

Returns: this vector divided by v

Definition at line 508 of file Vector3.h.

◆ operator==()

bool operator== ( const Vector3 & v ) const

inline

Equality comparison operator.

Parameters

v	vector to compare to

Returns: equality

Definition at line 536 of file Vector3.h.

◆ operator[]() [1/2]

float & operator[] ( int i )

inline

Array access operator.

Parameters

i index

Returns: vector3 component

Definition at line 155 of file Vector3.h.

◆ operator[]() [2/2]

const float & operator[] ( int i ) const

inline

Const array access operator.

Parameters

i index

Returns: vector3 component

Definition at line 164 of file Vector3.h.

◆ scale() [1/2]

Vector3 & scale ( const Vector3 & scale )

inline

Scale this vector.

Parameters

scale scale

Returns: this vector

Definition at line 361 of file Vector3.h.

◆ scale() [2/2]

Vector3 & scale ( float scale )

inline

Scale this vector.

Parameters

scale scale

Returns: this vector

Definition at line 349 of file Vector3.h.

◆ set() [1/3]

Vector3 & set ( const array< float, 3 > & v )

inline

Set up vector.

Parameters

v	float array containing x,y,z values

Returns: this vector

Definition at line 85 of file Vector3.h.

◆ set() [2/3]

Vector3 & set ( const Vector3 & v )

inline

Set up vector.

Parameters

v v

Returns: this vector

Definition at line 95 of file Vector3.h.

◆ set() [3/3]

Vector3 & set	(	float	x,
		float	y,
		float	z
	)

inline

Set up vector.

Parameters

x	x
y	y
z	z

Returns: this vector

Definition at line 73 of file Vector3.h.

◆ setX()

Vector3 & setX ( float x )

inline

Set X.

Parameters

x x

Definition at line 111 of file Vector3.h.

◆ setY()

Vector3 & setY ( float y )

inline

Set Y.

Parameters

y y

Returns: this vector

Definition at line 128 of file Vector3.h.

◆ setZ()

Vector3 & setZ ( float z )

inline

Set Z.

Parameters

z z

Returns: this vector

Definition at line 145 of file Vector3.h.

◆ sub() [1/2]

Vector3 & sub ( const Vector3 & v )

inline

Subtracts a vector.

Parameters

v v

Returns: this vector

Definition at line 325 of file Vector3.h.

◆ sub() [2/2]

Vector3 & sub ( float value )

inline

Subtracts a float from each vector component.

Parameters

value v

Returns: this vector

Definition at line 337 of file Vector3.h.

Friends And Related Function Documentation

◆ Matrix4x4

friend class Matrix4x4

friend

Definition at line 23 of file Vector3.h.

◆ Quaternion

friend class Quaternion

friend

Definition at line 24 of file Vector3.h.

◆ Vector4

friend class Vector4

friend

Definition at line 25 of file Vector3.h.

Member Data Documentation

◆ data

array<float, 3> data

private

Definition at line 28 of file Vector3.h.

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Vector3() [1/4]

◆ Vector3() [2/4]

◆ Vector3() [3/4]

◆ Vector3() [4/4]

Member Function Documentation

◆ abs()

◆ add() [1/2]

◆ add() [2/2]

◆ clone()

◆ computeAngle() [1/2]

◆ computeAngle() [2/2]

◆ computeCrossProduct()

◆ computeDotProduct()

◆ computeEulerAngles()

◆ computeLength()

◆ computeLengthSquared()

◆ equals() [1/2]

◆ equals() [2/2]

◆ getArray()

◆ getX()

◆ getY()

◆ getZ()

◆ interpolateLinear()

◆ normalize()

◆ 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()

◆ setZ()

◆ sub() [1/2]

◆ sub() [2/2]

Friends And Related Function Documentation

◆ Matrix4x4

◆ Quaternion

◆ Vector4

Member Data Documentation

◆ data