Vec4 Class Reference

Defines 4-element floating point vector. More...

Public Member Functions
	Vec4 ()
	Constructs a new vector initialized to all zeros.
	Vec4 (float xx, float yy, float zz, float ww)
	Constructs a new vector initialized to the specified values. More...
	Vec4 ( var xx, var yy, var zz, var ww)
	Constructs a new vector initialized to the specified values. More...
	Vec4 ( local xx, local yy, local zz, local ww)
	Constructs a new vector initialized to the specified values. More...
	Vec4 (const float *array)
	Constructs a new vector from the values in the specified array. More...
	Vec4 (const Vec4 &p1, const Vec4 &p2)
	Constructs a vector that describes the direction between the specified points. More...
	Vec4 (const Vec4 &copy)
	Constructs a new vector that is a copy of the specified vector. More...
	~Vec4 ()
	Destructor.
bool	isZero () const
	Indicates whether this vector contains all zeros. More...
var	isZero ()
	Indicates whether this vector contains all zeros. More...
local	isZero ()
	Indicates whether this vector contains all zeros. More...
bool	isOne () const
	Indicates whether this vector contains all ones. More...
void	add (const Vec4 &v)
	Adds the elements of the specified vector to this one. More...
void	clamp (const Vec4 &min, const Vec4 &max)
	Clamps this vector within the specified range. More...
float	distance (const Vec4 &v) const
	Returns the distance between this point and v. More...
var	distance ( var v)
	Returns the distance between this point and v. More...
local	distance ( local v)
	Returns the distance between this point and v. More...
float	distanceSquared (const Vec4 &v) const
	Returns the squared distance between this point and v. More...
var	distanceSquared ( var v)
	Returns the squared distance between this point and v. More...
local	distanceSquared ( local v)
	Returns the squared distance between this point and v. More...
float	dot (const Vec4 &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...
var	lengthSquared ()
	Returns the squared length of this vector. More...
local	lengthSquared ()
	Returns the squared length of this vector. More...
void	negate ()
	Negates this vector.
var	negate ()
	Negates this vector.
local	negate ()
	Negates this vector.
void	normalize ()
	Normalizes this vector. More...
var	normalize ()
	Normalizes this vector. More...
local	normalize ()
	Normalizes this vector. More...
Vec4	getNormalized () const
	Get the normalized vector.
var	getNormalized ()
	Get the normalized vector.
local	getNormalized ()
	Get the normalized vector.
void	scale (float scalar)
	Scales all elements of this vector by the specified value. More...
var	scale ( var scalar)
	Scales all elements of this vector by the specified value. More...
local	scale ( local scalar)
	Scales all elements of this vector by the specified value. More...
void	set (float xx, float yy, float zz, float ww)
	Sets the elements of this vector to the specified values. More...
var	set ( var xx, var yy, var zz, var ww)
	Sets the elements of this vector to the specified values. More...
local	set ( local xx, local yy, local zz, local ww)
	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 Vec4 &v)
	Sets the elements of this vector to those in the specified vector. More...
void	set (const Vec4 &p1, const Vec4 &p2)
	Sets this vector to the directional vector between the specified points. More...
var	set ( var p1, var p2)
	Sets this vector to the directional vector between the specified points. More...
local	set ( local p1, local p2)
	Sets this vector to the directional vector between the specified points. More...
void	subtract (const Vec4 &v)
	Subtracts this vector and the specified vector as (this - v) and stores the result in this vector. More...
const Vec4	operator+ (const Vec4 &v) const
	Calculates the sum of this vector with the given vector. More...
Vec4 &	operator+= (const Vec4 &v)
	Adds the given vector to this vector. More...
const Vec4	operator- (const Vec4 &v) const
	Calculates the difference of this vector with the given vector. More...
Vec4 &	operator-= (const Vec4 &v)
	Subtracts the given vector from this vector. More...
const Vec4	operator- () const
	Calculates the negation of this vector. More...
const Vec4	operator* (float s) const
	Calculates the scalar product of this vector with the given value. More...
Vec4 &	operator*= (float s)
	Scales this vector by the given value. More...
const Vec4	operator/ (float s) const
	Returns the components of this vector divided by the given constant Note: this does not modify this vector. More...
bool	operator< (const Vec4 &v) const
	Determines if this vector is less than the given vector. More...
bool	operator== (const Vec4 &v) const
	Determines if this vector is equal to the given vector. More...
bool	operator!= (const Vec4 &v) const
	Determines if this vector is not equal to the given vector. More...

Static Public Member Functions
static Vec4	fromColor (unsigned int color)
	Creates a new vector from an integer interpreted as an RGB value. More...
local	fromColor ( local color)
	Creates a new vector from an integer interpreted as an RGB value. More...
static float	angle (const Vec4 &v1, const Vec4 &v2)
	Returns the angle (in radians) between the specified vectors. More...
static void	add (const Vec4 &v1, const Vec4 &v2, Vec4 *dst)
	Adds the specified vectors and stores the result in dst. More...
local	add ( local v1, local v2, local dst)
	Adds the specified vectors and stores the result in dst. More...
static void	clamp (const Vec4 &v, const Vec4 &min, const Vec4 &max, Vec4 *dst)
	Clamps the specified vector within the specified range and returns it in dst. More...
var	clamp ( var v, var min, var max, var dst)
	Clamps the specified vector within the specified range and returns it in dst. More...
local	clamp ( local v, local min, local max, local dst)
	Clamps the specified vector within the specified range and returns it in dst. More...
static float	dot (const Vec4 &v1, const Vec4 &v2)
	Returns the dot product between the specified vectors. More...
local	dot ( local v1, local v2)
	Returns the dot product between the specified vectors. More...
static void	subtract (const Vec4 &v1, const Vec4 &v2, Vec4 *dst)
	Subtracts the specified vectors and stores the result in dst. More...
var	subtract ( var v1, var v2, var dst)
	Subtracts the specified vectors and stores the result in dst. More...
local	subtract ( local v1, local v2, local dst)
	Subtracts the specified vectors and stores the result in dst. More...

Public Attributes
float	x
	The x-coordinate.
float	y
	The y-coordinate.
var	y
	The y-coordinate.
local	y
	The y-coordinate.
float	z
	The z-coordinate.
var	z
	The z-coordinate.
local	z
	The z-coordinate.
float	w
	The w-coordinate.
var	w
	The w-coordinate.
local	w
	The w-coordinate.

Static Public Attributes
static const Vec4	ZERO
	equals to Vec4(0,0,0,0)
static const Vec4	ONE
	equals to Vec4(1,1,1,1)
var	ONE
	equals to Vec4(1,1,1,1)
local	ONE
	equals to Vec4(1,1,1,1)
static const Vec4	UNIT_X
	equals to Vec4(1,0,0,0)
var	UNIT_X
	equals to Vec4(1,0,0,0)
local	UNIT_X
	equals to Vec4(1,0,0,0)
static const Vec4	UNIT_Y
	equals to Vec4(0,1,0,0)
var	UNIT_Y
	equals to Vec4(0,1,0,0)
local	UNIT_Y
	equals to Vec4(0,1,0,0)
static const Vec4	UNIT_Z
	equals to Vec4(0,0,1,0)
var	UNIT_Z
	equals to Vec4(0,0,1,0)
local	UNIT_Z
	equals to Vec4(0,0,1,0)
static const Vec4	UNIT_W
	equals to Vec4(0,0,0,1)
var	UNIT_W
	equals to Vec4(0,0,0,1)
local	UNIT_W
	equals to Vec4(0,0,0,1)

Detailed Description

Defines 4-element floating point vector.

Constructor & Destructor Documentation

Vec4	(	float	xx,
		float	yy,
		float	zz,
		float	ww
	)

Constructs a new vector initialized to the specified values.

The x coordinate. The y coordinate. The z coordinate. The w coordinate.

var Vec4	(	var	xx,
		var	yy,
		var	zz,
		var	ww
	)

Constructs a new vector initialized to the specified values.

The x coordinate. The y coordinate. The z coordinate. The w coordinate.

local Vec4	(	local	xx,
		local	yy,
		local	zz,
		local	ww
	)

Constructs a new vector initialized to the specified values.

The x coordinate. The y coordinate. The z coordinate. The w coordinate.

Vec4

(

const float *

array

)

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

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

var Vec4

(

var

array

)

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

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

local Vec4

(

local

array

)

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

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

Vec4	(	const Vec4 &	p1,
		const Vec4 &	p2
	)

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

The first point. The second point.

var Vec4	(	var	p1,
		var	p2
	)

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

The first point. The second point.

local Vec4	(	local	p1,
		local	p2
	)

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

The first point. The second point.

Vec4

(

const Vec4 &

copy

)

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

The vector to copy.

var Vec4

(

var

copy

)

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

The vector to copy.

local Vec4

(

local

copy

)

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

The vector to copy.

Member Function Documentation

static Vec4 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, 1).

The integer to interpret as an RGB value. A vector corresponding to the interpreted RGB color.

var fromColor ( var  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, 1).

The integer to interpret as an RGB value. A vector corresponding to the interpreted RGB color.

local fromColor ( local  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, 1).

The integer to interpret as an RGB value. A vector corresponding to the interpreted RGB color.

bool isZero

(

)

const

Indicates whether this vector contains all zeros.

true if this vector contains all zeros, false otherwise.

var isZero

(

)

Indicates whether this vector contains all zeros.

true if this vector contains all zeros, false otherwise.

local isZero

(

)

Indicates whether this vector contains all zeros.

true if this vector contains all zeros, false otherwise.

bool isOne

(

)

const

Indicates whether this vector contains all ones.

true if this vector contains all ones, false otherwise.

var isOne

(

)

Indicates whether this vector contains all ones.

true if this vector contains all ones, false otherwise.

local isOne

(

)

Indicates whether this vector contains all ones.

true if this vector contains all ones, false otherwise.

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

static

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

The first vector. The second vector. The angle between the two vectors (in radians).

var angle ( var  v1, var  v2  )

static

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

The first vector. The second vector. The angle between the two vectors (in radians).

local angle ( local  v1, local  v2  )

static

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

The first vector. The second vector. The angle between the two vectors (in radians).

void add

(

const Vec4 &

v

)

Adds the elements of the specified vector to this one.

The vector to add.

var add

(

var

v

)

Adds the elements of the specified vector to this one.

The vector to add.

local add

(

local

v

)

Adds the elements of the specified vector to this one.

The vector to add.

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

static

Adds the specified vectors and stores the result in dst.

The first vector. The second vector. A vector to store the result in.

var add ( var  v1, var  v2, var  dst  )

static

Adds the specified vectors and stores the result in dst.

The first vector. The second vector. A vector to store the result in.

local add ( local  v1, local  v2, local  dst  )

static

Adds the specified vectors and stores the result in dst.

The first vector. The second vector. A vector to store the result in.

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

Clamps this vector within the specified range.

The minimum value. The maximum value.

var clamp	(	var	min,
		var	max
	)

Clamps this vector within the specified range.

The minimum value. The maximum value.

local clamp	(	local	min,
		local	max
	)

Clamps this vector within the specified range.

The minimum value. The maximum value.

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

static

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

The vector to clamp. The minimum value. The maximum value. A vector to store the result in.

var clamp ( var  v, var  min, var  max, var  dst  )

static

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

The vector to clamp. The minimum value. The maximum value. A vector to store the result in.

local clamp ( local  v, local  min, local  max, local  dst  )

static

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

The vector to clamp. The minimum value. The maximum value. A vector to store the result in.

float distance

(

const Vec4 &

v

)

const

Returns the distance between this point and v.

The other point. The distance between this point and v.

var distance

(

var

v

)

Returns the distance between this point and v.

The other point. The distance between this point and v.

local distance

(

local

v

)

Returns the distance between this point and v.

The other point. The distance between this point and v.

float distanceSquared

(

const Vec4 &

v

)

const

Returns the squared distance between this point and v.

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

The other point. The squared distance between this point and v.

var distanceSquared

(

var

v

)

Returns the squared distance between this point and v.

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

The other point. The squared distance between this point and v.

local distanceSquared

(

local

v

)

Returns the squared distance between this point and v.

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

The other point. The squared distance between this point and v.

float dot

(

const Vec4 &

v

)

const

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

The vector to compute the dot product with. The dot product.

var dot

(

var

v

)

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

The vector to compute the dot product with. The dot product.

local dot

(

local

v

)

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

The vector to compute the dot product with. The dot product.

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

static

Returns the dot product between the specified vectors.

The first vector. The second vector. The dot product between the vectors.

var dot ( var  v1, var  v2  )

static

Returns the dot product between the specified vectors.

The first vector. The second vector. The dot product between the vectors.

local dot ( local  v1, local  v2  )

static

Returns the dot product between the specified vectors.

The first vector. The second vector. The dot product between the vectors.

float length

(

)

const

Computes the length of this vector.

The length of the vector.

var length

(

)

Computes the length of this vector.

The length of the vector.

local length

(

)

Computes the length of this vector.

The length of the vector.

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.

The squared length of the vector.

var lengthSquared

(

)

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.

The squared length of the vector.

local lengthSquared

(

)

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.

The squared length of the vector.

void normalize

(

)

Normalizes this vector.

This method normalizes this Vec4 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.

var normalize

(

)

Normalizes this vector.

This method normalizes this Vec4 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.

local normalize

(

)

Normalizes this vector.

This method normalizes this Vec4 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.

void scale

(

float

scalar

)

Scales all elements of this vector by the specified value.

The scalar value.

var scale

(

var

scalar

)

Scales all elements of this vector by the specified value.

The scalar value.

local scale

(

local

scalar

)

Scales all elements of this vector by the specified value.

The scalar value.

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

Sets the elements of this vector to the specified values.

The new x coordinate. The new y coordinate. The new z coordinate. The new w coordinate.

var set	(	var	xx,
		var	yy,
		var	zz,
		var	ww
	)

Sets the elements of this vector to the specified values.

The new x coordinate. The new y coordinate. The new z coordinate. The new w coordinate.

local set	(	local	xx,
		local	yy,
		local	zz,
		local	ww
	)

Sets the elements of this vector to the specified values.

The new x coordinate. The new y coordinate. The new z coordinate. The new w coordinate.

void set

(

const float *

array

)

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

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

var set

(

var

array

)

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

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

local set

(

local

array

)

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

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

void set

(

const Vec4 &

v

)

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

The vector to copy.

var set

(

var

v

)

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

The vector to copy.

local set

(

local

v

)

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

The vector to copy.

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

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

The first point. The second point.

var set	(	var	p1,
		var	p2
	)

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

The first point. The second point.

local set	(	local	p1,
		local	p2
	)

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

The first point. The second point.

void subtract

(

const Vec4 &

v

)

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

The vector to subtract.

var subtract

(

var

v

)

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

The vector to subtract.

local subtract

(

local

v

)

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

The vector to subtract.

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

static

Subtracts the specified vectors and stores the result in dst.

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

The first vector. The second vector. The destination vector.

var subtract ( var  v1, var  v2, var  dst  )

static

Subtracts the specified vectors and stores the result in dst.

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

The first vector. The second vector. The destination vector.

local subtract ( local  v1, local  v2, local  dst  )

static

Subtracts the specified vectors and stores the result in dst.

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

The first vector. The second vector. The destination vector.

const Vec4 operator+ ( const Vec4 &  v ) const

inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

The vector to add. The vector sum.

const Vec4 operator+ ( var  v )

inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

The vector to add. The vector sum.

const Vec4 operator+ ( local  v )

inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

The vector to add. The vector sum.

Vec4& operator+= ( const Vec4 &  v )

inline

Adds the given vector to this vector.

The vector to add. This vector, after the addition occurs.

Vec4& operator+= ( var  v )

inline

Adds the given vector to this vector.

The vector to add. This vector, after the addition occurs.

Vec4& operator+= ( local  v )

inline

Adds the given vector to this vector.

The vector to add. This vector, after the addition occurs.

const Vec4 operator- ( const Vec4 &  v ) const

inline

Calculates the difference of this vector with the given vector.

Note: this does not modify this vector. The vector to minus. The vector difference.

const Vec4 operator- ( var  v )

inline

Calculates the difference of this vector with the given vector.

Note: this does not modify this vector. The vector to minus. The vector difference.

const Vec4 operator- ( local  v )

inline

Calculates the difference of this vector with the given vector.

Note: this does not modify this vector. The vector to minus. The vector difference.

Vec4& operator-= ( const Vec4 &  v )

inline

Subtracts the given vector from this vector.

The vector to subtract. This vector, after the subtraction occurs.

Vec4& operator-= ( var  v )

inline

Subtracts the given vector from this vector.

The vector to subtract. This vector, after the subtraction occurs.

Vec4& operator-= ( local  v )

inline

Subtracts the given vector from this vector.

The vector to subtract. This vector, after the subtraction occurs.

const Vec4 operator- ( ) const

inline

Calculates the negation of this vector.

Note: this does not modify this vector. The negation of this vector.

const Vec4 operator- ( )

inline

Calculates the negation of this vector.

Note: this does not modify this vector. The negation of this vector.

const Vec4 operator- ( )

inline

Calculates the negation of this vector.

Note: this does not modify this vector. The negation of this vector.

const Vec4 operator* ( float  s ) const

inline

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

Note: this does not modify this vector. The value to scale by. The scaled vector.

const Vec4 operator* ( var  s )

inline

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

Note: this does not modify this vector. The value to scale by. The scaled vector.

const Vec4 operator* ( local  s )

inline

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

Note: this does not modify this vector. The value to scale by. The scaled vector.

Vec4& operator*= ( float  s )

inline

Scales this vector by the given value.

The value to scale by. This vector, after the scale occurs.

Vec4& operator*= ( var  s )

inline

Scales this vector by the given value.

The value to scale by. This vector, after the scale occurs.

Vec4& operator*= ( local  s )

inline

Scales this vector by the given value.

The value to scale by. This vector, after the scale occurs.

const Vec4 operator/ ( float  s ) const

inline

Returns the components of this vector divided by the given constant Note: this does not modify this vector.

the constant to divide this vector with the result is this vector divided by the given constant.

const Vec4 operator/ ( var  s )

inline

Returns the components of this vector divided by the given constant Note: this does not modify this vector.

the constant to divide this vector with the result is this vector divided by the given constant.

const Vec4 operator/ ( local  s )

inline

Returns the components of this vector divided by the given constant Note: this does not modify this vector.

the constant to divide this vector with the result is this vector divided by the given constant.

bool operator< ( const Vec4 &  v ) const

inline

Determines if this vector is less than the given vector.

The vector to compare against. True if this vector is less than the given vector, false otherwise.

bool operator< ( var  v )

inline

Determines if this vector is less than the given vector.

The vector to compare against. True if this vector is less than the given vector, false otherwise.

bool operator< ( local  v )

inline

Determines if this vector is less than the given vector.

The vector to compare against. True if this vector is less than the given vector, false otherwise.

bool operator== ( const Vec4 &  v ) const

inline

Determines if this vector is equal to the given vector.

The vector to compare against. True if this vector is equal to the given vector, false otherwise.

bool operator== ( var  v )

inline

Determines if this vector is equal to the given vector.

The vector to compare against. True if this vector is equal to the given vector, false otherwise.

bool operator== ( local  v )

inline

Determines if this vector is equal to the given vector.

The vector to compare against. True if this vector is equal to the given vector, false otherwise.

bool operator!= ( const Vec4 &  v ) const

inline

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

The vector to compare against. True if this vector is not equal to the given vector, false otherwise.

bool operator!= ( var  v )

inline

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

The vector to compare against. True if this vector is not equal to the given vector, false otherwise.

bool operator!= ( local  v )

inline

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

The vector to compare against. True if this vector is not equal to the given vector, false otherwise.

---

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

• Vec4.h