Defines a 3-element floating point vector. More...

#include <Vec3.h>

Public Member Functions
	Vec3 ()
	Constructs a new vector initialized to all zeros. More...

	Vec3 (float xx, float yy, float zz)
	Constructs a new vector initialized to the specified values. More...

	Vec3 (const float *array)
	Constructs a new vector from the values in the specified array. More...

	Vec3 (const Vec3 &p1, const Vec3 &p2)
	Constructs a vector that describes the direction between the specified points. More...

	Vec3 (const Vec3 &copy)
	Constructs a new vector that is a copy of the specified vector. More...

	~Vec3 ()
	Destructor. More...

bool	isZero () const
	Indicates whether this vector contains all zeros. More...

bool	isOne () const
	Indicates whether this vector contains all ones. More...

void	add (const Vec3 &v)
	Adds the elements of the specified vector to this one. More...

void	clamp (const Vec3 &min, const Vec3 &max)
	Clamps this vector within the specified range. More...

void	cross (const Vec3 &v)
	Sets this vector to the cross product between itself and the specified vector. More...

float	distance (const Vec3 &v) const
	Returns the distance between this vector and v. More...

float	distanceSquared (const Vec3 &v) const
	Returns the squared distance between this vector and v. More...

float	dot (const Vec3 &v) const
	Returns the dot product of this vector and the specified vector. More...

float	length () const
	Computes the length of this vector. More...

float	lengthSquared () const
	Returns the squared length of this vector. More...

void	negate ()
	Negates this vector. More...

void	normalize ()
	Normalizes this vector. More...

Vec3	getNormalized () const
	Normalizes this vector and stores the result in dst. More...

void	scale (float scalar)
	Scales all elements of this vector by the specified value. More...

void	set (float xx, float yy, float zz)
	Sets the elements of this vector to the specified values. More...

void	set (const float *array)
	Sets the elements of this vector from the values in the specified array. More...

void	set (const Vec3 &v)
	Sets the elements of this vector to those in the specified vector. More...

void	set (const Vec3 &p1, const Vec3 &p2)
	Sets this vector to the directional vector between the specified points. More...

void	subtract (const Vec3 &v)
	Subtracts this vector and the specified vector as (this - v) and stores the result in this vector. More...

void	smooth (const Vec3 &target, float elapsedTime, float responseTime)
	Updates this vector towards the given target using a smoothing function. More...

const Vec3	operator+ (const Vec3 &v) const
	Calculates the sum of this vector with the given vector. More...

Vec3 &	operator+= (const Vec3 &v)
	Adds the given vector to this vector. More...

const Vec3	operator- (const Vec3 &v) const
	Calculates the difference of this vector with the given vector. More...

Vec3 &	operator-= (const Vec3 &v)
	Subtracts the given vector from this vector. More...

const Vec3	operator- () const
	Calculates the negation of this vector. More...

const Vec3	operator* (float s) const
	Calculates the scalar product of this vector with the given value. More...

Vec3 &	operator*= (float s)
	Scales this vector by the given value. More...

const Vec3	operator/ (float s) const
	Returns the components of this vector divided by the given constant. More...

bool	operator< (const Vec3 &v) const
	Determines if this vector is less than the given vector. More...

bool	operator== (const Vec3 &v) const
	Determines if this vector is equal to the given vector. More...

bool	operator!= (const Vec3 &v) const
	Determines if this vector is not equal to the given vector. More...

Static Public Member Functions
static Vec3	fromColor (unsigned int color)
	Creates a new vector from an integer interpreted as an RGB value. More...

static float	angle (const Vec3 &v1, const Vec3 &v2)
	Returns the angle (in radians) between the specified vectors. More...

static void	add (const Vec3 &v1, const Vec3 &v2, Vec3 *dst)
	Adds the specified vectors and stores the result in dst. More...

static void	clamp (const Vec3 &v, const Vec3 &min, const Vec3 &max, Vec3 *dst)
	Clamps the specified vector within the specified range and returns it in dst. More...

static void	cross (const Vec3 &v1, const Vec3 &v2, Vec3 *dst)
	Computes the cross product of the specified vectors and stores the result in dst. More...

static float	dot (const Vec3 &v1, const Vec3 &v2)
	Returns the dot product between the specified vectors. More...

static void	subtract (const Vec3 &v1, const Vec3 &v2, Vec3 *dst)
	Subtracts the specified vectors and stores the result in dst. More...

Public Attributes
float	x
	The x-coordinate. More...

float	y
	The y-coordinate. More...

float	z
	The z-coordinate. More...

Static Public Attributes
static const Vec3	ZERO
	equals to Vec3(0,0,0) More...

static const Vec3	ONE
	equals to Vec3(1,1,1) More...

static const Vec3	UNIT_X
	equals to Vec3(1,0,0) More...

static const Vec3	UNIT_Y
	equals to Vec3(0,1,0) More...

static const Vec3	UNIT_Z
	equals to Vec3(0,0,1) More...

Detailed Description

Defines a 3-element floating point vector.

When using a vector to represent a surface normal, the vector should typically be normalized. Other uses of directional vectors may wish to leave the magnitude of the vector intact. When used as a point, the elements of the vector represent a position in 3D space.

Constructor & Destructor Documentation

Vec3 ( )

Constructs a new vector initialized to all zeros.

Vec3	(	float	xx,
		float	yy,
		float	zz
	)

Constructs a new vector initialized to the specified values.

Parameters

xx	The x coordinate.
yy	The y coordinate.
zz	The z coordinate.

Vec3 ( const float * array )

Constructs a new vector from the values in the specified array.

Parameters

array An array containing the elements of the vector in the order x, y, z.

Vec3	(	const Vec3 &	p1,
		const Vec3 &	p2
	)

Constructs a vector that describes the direction between the specified points.

Parameters

p1	The first point.
p2	The second point.

Vec3 ( const Vec3 & copy )

Constructs a new vector that is a copy of the specified vector.

Parameters

copy	The vector to copy.

~Vec3 ( )

Destructor.

Member Function Documentation

void add ( const Vec3 & v )

Adds the elements of the specified vector to this one.

Parameters

v	The vector to add.

static void add	(	const Vec3 &	v1,
		const Vec3 &	v2,
		Vec3 *	dst
	)

static

Adds the specified vectors and stores the result in dst.

Parameters

v1	The first vector.
v2	The second vector.
dst	A vector to store the result in.

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

static

Returns the angle (in radians) between the specified vectors.

Parameters

v1	The first vector.
v2	The second vector.

Returns: The angle between the two vectors (in radians).

void clamp	(	const Vec3 &	min,
		const Vec3 &	max
	)

Clamps this vector within the specified range.

Parameters

min	The minimum value.
max	The maximum value.

static void clamp	(	const Vec3 &	v,
		const Vec3 &	min,
		const Vec3 &	max,
		Vec3 *	dst
	)

static

Clamps the specified vector within the specified range and returns it in dst.

Parameters

v	The vector to clamp.
min	The minimum value.
max	The maximum value.
dst	A vector to store the result in.

void cross ( const Vec3 & v )

Sets this vector to the cross product between itself and the specified vector.

Parameters

v	The vector to compute the cross product with.

static void cross	(	const Vec3 &	v1,
		const Vec3 &	v2,
		Vec3 *	dst
	)

static

Computes the cross product of the specified vectors and stores the result in dst.

Parameters

v1	The first vector.
v2	The second vector.
dst	A vector to store the result in.

float distance ( const Vec3 & v ) const

Returns the distance between this vector and v.

Parameters

v	The other vector.

Returns: The distance between this vector and v.

See also: distanceSquared

float distanceSquared ( const Vec3 & v ) const

Returns the squared distance between this vector and v.

When it is not necessary to get the exact distance between two vectors (for example, when simply comparing the distance between different vectors), it is advised to use this method instead of distance.

Parameters

v	The other vector.

Returns: The squared distance between this vector and v.

See also: distance

float dot ( const Vec3 & v ) const

Returns the dot product of this vector and the specified vector.

Parameters

v	The vector to compute the dot product with.

Returns: The dot product.

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

static

Returns the dot product between the specified vectors.

Parameters

v1	The first vector.
v2	The second vector.

Returns: The dot product between the vectors.

static Vec3 fromColor ( unsigned int color )

static

Creates a new vector from an integer interpreted as an RGB value.

E.g. 0xff0000 represents red or the vector (1, 0, 0).

Parameters

color The integer to interpret as an RGB value.

Returns: A vector corresponding to the interpreted RGB color.

Vec3 getNormalized ( ) const

Normalizes this vector and stores the result in dst.

If the vector already has unit length or if the length of the vector is zero, this method simply copies the current vector into dst.

Parameters

dst	The destination vector.

bool isOne ( ) const

Indicates whether this vector contains all ones.

Returns: true if this vector contains all ones, false otherwise.

bool isZero ( ) const

Indicates whether this vector contains all zeros.

Returns: true if this vector contains all zeros, false otherwise.

float length ( ) const

Computes the length of this vector.

Returns: The length of the vector.

See also: lengthSquared

float lengthSquared ( ) const

Returns the squared length of this vector.

When it is not necessary to get the exact length of a vector (for example, when simply comparing the lengths of different vectors), it is advised to use this method instead of length.

Returns: The squared length of the vector.

See also: length

void negate ( )

Negates this vector.

void normalize ( )

Normalizes this vector.

This method normalizes this Vect3 so that it is of unit length (in other words, the length of the vector after calling this method will be 1.0f). If the vector already has unit length or if the length of the vector is zero, this method does nothing.

Returns: This vector, after the normalization occurs.

bool operator!= ( const Vec3 & v ) const

inline

Determines if this vector is not equal to the given vector.

Parameters

v	The vector to compare against.

Returns: True if this vector is not equal to the given vector, false otherwise.

const Vec3 operator* ( float s ) const

inline

Calculates the scalar product of this vector with the given value.

Note: this does not modify this vector.

Parameters

s	The value to scale by.

Returns: The scaled vector.

Vec3& operator*= ( float s )

inline

Scales this vector by the given value.

Parameters

s	The value to scale by.

Returns: This vector, after the scale occurs.

const Vec3 operator+ ( const Vec3 & v ) const

inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

Parameters

v	The vector to add.

Returns: The vector sum.

Vec3& operator+= ( const Vec3 & v )

inline

Adds the given vector to this vector.

Parameters

v	The vector to add.

Returns: This vector, after the addition occurs.

const Vec3 operator- ( const Vec3 & v ) const

inline

Calculates the difference of this vector with the given vector.

Note: this does not modify this vector.

Parameters

v	The vector to subtract.

Returns: The vector difference.

const Vec3 operator- ( ) const

inline

Calculates the negation of this vector.

Note: this does not modify this vector.

Returns: The negation of this vector.

Vec3& operator-= ( const Vec3 & v )

inline

Subtracts the given vector from this vector.

Parameters

v	The vector to subtract.

Returns: This vector, after the subtraction occurs.

const Vec3 operator/ ( float s ) const

inline

Returns the components of this vector divided by the given constant.

Note: this does not modify this vector.

Parameters

s	the constant to divide this vector with

Returns: a smaller vector

bool operator< ( const Vec3 & v ) const

inline

Determines if this vector is less than the given vector.

Parameters

v	The vector to compare against.

Returns: True if this vector is less than the given vector, false otherwise.

bool operator== ( const Vec3 & v ) const

inline

Determines if this vector is equal to the given vector.

Parameters

v	The vector to compare against.

Returns: True if this vector is equal to the given vector, false otherwise.

void scale ( float scalar )

Scales all elements of this vector by the specified value.

Parameters

scalar The scalar value.

void set	(	float	xx,
		float	yy,
		float	zz
	)

Sets the elements of this vector to the specified values.

Parameters

xx	The new x coordinate.
yy	The new y coordinate.
zz	The new z coordinate.

void set ( const float * array )

Sets the elements of this vector from the values in the specified array.

Parameters

array An array containing the elements of the vector in the order x, y, z.

void set ( const Vec3 & v )

Sets the elements of this vector to those in the specified vector.

Parameters

v	The vector to copy.

void set	(	const Vec3 &	p1,
		const Vec3 &	p2
	)

Sets this vector to the directional vector between the specified points.

void smooth	(	const Vec3 &	target,
		float	elapsedTime,
		float	responseTime
	)

Updates this vector towards the given target using a smoothing function.

The given response time determines the amount of smoothing (lag). A longer response time yields a smoother result and more lag. To force this vector to follow the target closely, provide a response time that is very small relative to the given elapsed time.

Parameters

target	target value.
elapsedTime	elapsed time between calls.
responseTime	response time (in the same units as elapsedTime).

void subtract ( const Vec3 & v )

Subtracts this vector and the specified vector as (this - v) and stores the result in this vector.

Parameters

v	The vector to subtract.

static void subtract	(	const Vec3 &	v1,
		const Vec3 &	v2,
		Vec3 *	dst
	)

static

Subtracts the specified vectors and stores the result in dst.

The resulting vector is computed as (v1 - v2).

Parameters

v1	The first vector.
v2	The second vector.
dst	The destination vector.

Member Data Documentation

const Vec3 ONE

static

equals to Vec3(1,1,1)

const Vec3 UNIT_X

static

equals to Vec3(1,0,0)

const Vec3 UNIT_Y

static

equals to Vec3(0,1,0)

const Vec3 UNIT_Z

static

equals to Vec3(0,0,1)

float x

The x-coordinate.

float y

The y-coordinate.

float z

The z-coordinate.

const Vec3 ZERO

static

equals to Vec3(0,0,0)

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

/Users/huihoo/Software/huihoo-code/cocos2d-x/cocos2d-x-3.3/cocos/math/Vec3.h

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation