Defines a 3-element floating point vector. More...
Public Member Functions | |
Vec3 () | |
Constructs a new vector initialized to all zeros. | |
Vec3 () | |
Constructs a new vector initialized to all zeros. | |
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. More... | |
Vec3 ( var xx, var yy, var zz) | |
Constructs a new vector initialized to the specified values. More... | |
Vec3 ( local xx, local yy, local 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 ©) | |
Constructs a new vector that is a copy of the specified vector. More... | |
Vec3 ( var copy) | |
Constructs a new vector that is a copy of the specified vector. More... | |
Vec3 ( local copy) | |
Constructs a new vector that is a copy of the specified vector. More... | |
~Vec3 () | |
Destructor. | |
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... | |
var | add ( var v) |
Adds the elements of the specified vector to this one. More... | |
local | add ( local v) |
Adds the elements of the specified vector to this one. More... | |
void | add (float xx, float yy, float zz) |
Adds the elements of this vector to the specified values. More... | |
var | add ( var xx, var yy, var zz) |
Adds the elements of this vector to the specified values. More... | |
local | add ( local xx, local yy, local zz) |
Adds the elements of this vector to the specified values. 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... | |
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... | |
Vec3 | 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) |
Sets the elements of this vector to the specified values. More... | |
var | set ( var xx, var yy, var zz) |
Sets the elements of this vector to the specified values. More... | |
local | set ( local xx, local yy, local 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. | |
void | setZero () |
Sets the elements of this vector to zero. | |
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... | |
Vec3 | lerp (const Vec3 &target, float alpha) const |
Linear interpolation between two vectors A and B by alpha which is in the range [0,1]. | |
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... | |
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... | |
var | operator-= ( var v) |
Subtracts the given vector from this vector. More... | |
local | operator-= ( local v) |
Subtracts the given vector from this vector. More... | |
Vec3 | operator- () const |
Calculates the negation of this vector. More... | |
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... | |
Vec3 | operator/ (float s) const |
Returns the components of this vector divided by the given constant. More... | |
bool | operator< (const Vec3 &rhs) const |
Returns true if the vector's scalar components are all greater that the ones of the vector it is compared against. | |
bool | operator> (const Vec3 &rhs) const |
Returns true if the vector's scalar components are all smaller that the ones of the vector it is compared against. | |
var | operator> ( var rhs) |
Returns true if the vector's scalar components are all smaller that the ones of the vector it is compared against. | |
local | operator> ( local rhs) |
Returns true if the vector's scalar components are all smaller that the ones of the vector it is compared against. | |
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... | |
local | add ( local v1, local v2, local 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... | |
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 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... | |
local | cross ( local v1, local v2, local 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... | |
local | dot ( local v1, local 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... | |
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. | |
Static Public Attributes | |
static const Vec3 | ZERO |
equals to Vec3(0,0,0) | |
static const Vec3 | ONE |
equals to Vec3(1,1,1) | |
var | ONE |
equals to Vec3(1,1,1) | |
local | ONE |
equals to Vec3(1,1,1) | |
static const Vec3 | UNIT_X |
equals to Vec3(1,0,0) | |
var | UNIT_X |
equals to Vec3(1,0,0) | |
local | UNIT_X |
equals to Vec3(1,0,0) | |
static const Vec3 | UNIT_Y |
equals to Vec3(0,1,0) | |
var | UNIT_Y |
equals to Vec3(0,1,0) | |
local | UNIT_Y |
equals to Vec3(0,1,0) | |
static const Vec3 | UNIT_Z |
equals to Vec3(0,0,1) | |
var | UNIT_Z |
equals to Vec3(0,0,1) | |
local | UNIT_Z |
equals to Vec3(0,0,1) | |
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.
Vec3 | ( | float | xx, |
float | yy, | ||
float | zz | ||
) |
Constructs a new vector initialized to the specified values.
xx | The x coordinate. |
yy | The y coordinate. |
zz | The z coordinate. |
var Vec3 | ( | var | xx, |
var | yy, | ||
var | zz | ||
) |
Constructs a new vector initialized to the specified values.
xx | The x coordinate. |
yy | The y coordinate. |
zz | The z coordinate. |
local Vec3 | ( | local | xx, |
local | yy, | ||
local | zz | ||
) |
Constructs a new vector initialized to the specified values.
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.
array | An array containing the elements of the vector in the order x, y, z. |
var Vec3 | ( | var | array | ) |
Constructs a new vector from the values in the specified array.
array | An array containing the elements of the vector in the order x, y, z. |
local Vec3 | ( | local | array | ) |
Constructs a new vector from the values in the specified array.
array | An array containing the elements of the vector in the order x, y, z. |
Constructs a vector that describes the direction between the specified points.
p1 | The first point. |
p2 | The second point. |
var Vec3 | ( | var | p1, |
var | p2 | ||
) |
Constructs a vector that describes the direction between the specified points.
p1 | The first point. |
p2 | The second point. |
local Vec3 | ( | local | p1, |
local | p2 | ||
) |
Constructs a vector that describes the direction between the specified points.
p1 | The first point. |
p2 | The second point. |
Constructs a new vector that is a copy of the specified vector.
copy | The vector to copy. |
var Vec3 | ( | var | copy | ) |
Constructs a new vector that is a copy of the specified vector.
copy | The vector to copy. |
local Vec3 | ( | local | copy | ) |
Constructs a new vector that is a copy of the specified vector.
copy | The vector to copy. |
|
static |
Creates a new vector from an integer interpreted as an RGB value.
E.g. 0xff0000 represents red or the vector (1, 0, 0).
color | The integer to interpret as an RGB value. |
|
static |
Creates a new vector from an integer interpreted as an RGB value.
E.g. 0xff0000 represents red or the vector (1, 0, 0).
color | The integer to interpret as an RGB value. |
|
static |
Creates a new vector from an integer interpreted as an RGB value.
E.g. 0xff0000 represents red or the vector (1, 0, 0).
color | The integer to interpret as an RGB value. |
|
inline |
Indicates whether this vector contains all zeros.
|
inline |
Indicates whether this vector contains all zeros.
|
inline |
Indicates whether this vector contains all zeros.
|
inline |
Indicates whether this vector contains all ones.
|
inline |
Indicates whether this vector contains all ones.
|
inline |
Indicates whether this vector contains all ones.
Returns the angle (in radians) between the specified vectors.
v1 | The first vector. |
v2 | The second vector. |
|
static |
Returns the angle (in radians) between the specified vectors.
v1 | The first vector. |
v2 | The second vector. |
|
static |
Returns the angle (in radians) between the specified vectors.
v1 | The first vector. |
v2 | The second vector. |
|
inline |
Adds the elements of the specified vector to this one.
v | The vector to add. |
|
inline |
Adds the elements of the specified vector to this one.
v | The vector to add. |
|
inline |
Adds the elements of the specified vector to this one.
v | The vector to add. |
|
inline |
Adds the elements of this vector to the specified values.
xx | The add x coordinate. |
yy | The add y coordinate. |
zz | The add z coordinate. |
|
inline |
Adds the elements of this vector to the specified values.
xx | The add x coordinate. |
yy | The add y coordinate. |
zz | The add z coordinate. |
|
inline |
Adds the elements of this vector to the specified values.
xx | The add x coordinate. |
yy | The add y coordinate. |
zz | The add z coordinate. |
Adds the specified vectors and stores the result in dst.
v1 | The first vector. |
v2 | The second vector. |
dst | A vector to store the result in. |
|
static |
Adds the specified vectors and stores the result in dst.
v1 | The first vector. |
v2 | The second vector. |
dst | A vector to store the result in. |
|
static |
Adds the specified vectors and stores the result in dst.
v1 | The first vector. |
v2 | The second vector. |
dst | A vector to store the result in. |
Clamps this vector within the specified range.
min | The minimum value. |
max | The maximum value. |
var clamp | ( | var | min, |
var | max | ||
) |
Clamps this vector within the specified range.
min | The minimum value. |
max | The maximum value. |
local clamp | ( | local | min, |
local | max | ||
) |
Clamps this vector within the specified range.
min | The minimum value. |
max | The maximum value. |
Clamps the specified vector within the specified range and returns it in dst.
v | The vector to clamp. |
min | The minimum value. |
max | The maximum value. |
dst | A vector to store the result in. |
|
static |
Clamps the specified vector within the specified range and returns it in dst.
v | The vector to clamp. |
min | The minimum value. |
max | The maximum value. |
dst | A vector to store the result in. |
|
static |
Clamps the specified vector within the specified range and returns it in dst.
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.
v | The vector to compute the cross product with. |
var cross | ( | var | v | ) |
Sets this vector to the cross product between itself and the specified vector.
v | The vector to compute the cross product with. |
local cross | ( | local | v | ) |
Sets this vector to the cross product between itself and the specified vector.
v | The vector to compute the cross product with. |
Computes the cross product of the specified vectors and stores the result in dst.
v1 | The first vector. |
v2 | The second vector. |
dst | A vector to store the result in. |
|
static |
Computes the cross product of the specified vectors and stores the result in dst.
v1 | The first vector. |
v2 | The second vector. |
dst | A vector to store the result in. |
|
static |
Computes the cross product of the specified vectors and stores the result in dst.
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.
v | The other vector. |
var distance | ( | var | v | ) |
Returns the distance between this vector and v.
v | The other vector. |
local distance | ( | local | v | ) |
Returns the distance between this vector and v.
v | The other vector. |
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.
v | The other vector. |
var distanceSquared | ( | var | v | ) |
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.
v | The other vector. |
local distanceSquared | ( | local | v | ) |
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.
v | The other vector. |
float dot | ( | const Vec3 & | v | ) | const |
Returns the dot product of this vector and the specified vector.
v | The vector to compute the dot product with. |
var dot | ( | var | v | ) |
Returns the dot product of this vector and the specified vector.
v | The vector to compute the dot product with. |
local dot | ( | local | v | ) |
Returns the dot product of this vector and the specified vector.
v | The vector to compute the dot product with. |
Returns the dot product between the specified vectors.
v1 | The first vector. |
v2 | The second vector. |
|
static |
Returns the dot product between the specified vectors.
v1 | The first vector. |
v2 | The second vector. |
|
static |
Returns the dot product between the specified vectors.
v1 | The first vector. |
v2 | The second vector. |
|
inline |
|
inline |
|
inline |
|
inline |
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.
|
inline |
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.
|
inline |
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.
void normalize | ( | ) |
Normalizes this vector.
This method normalizes this Vec3 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 Vec3 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 Vec3 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.
|
inline |
Scales all elements of this vector by the specified value.
scalar | The scalar value. |
|
inline |
Scales all elements of this vector by the specified value.
scalar | The scalar value. |
|
inline |
Scales all elements of this vector by the specified value.
scalar | The scalar value. |
|
inline |
Sets the elements of this vector to the specified values.
xx | The new x coordinate. |
yy | The new y coordinate. |
zz | The new z coordinate. |
|
inline |
Sets the elements of this vector to the specified values.
xx | The new x coordinate. |
yy | The new y coordinate. |
zz | The new z coordinate. |
|
inline |
Sets the elements of this vector to the specified values.
xx | The new x coordinate. |
yy | The new y coordinate. |
zz | The new z coordinate. |
|
inline |
Sets the elements of this vector from the values in the specified array.
array | An array containing the elements of the vector in the order x, y, z. |
|
inline |
Sets the elements of this vector from the values in the specified array.
array | An array containing the elements of the vector in the order x, y, z. |
|
inline |
Sets the elements of this vector from the values in the specified array.
array | An array containing the elements of the vector in the order x, y, z. |
|
inline |
Sets the elements of this vector to those in the specified vector.
v | The vector to copy. |
|
inline |
Sets the elements of this vector to those in the specified vector.
v | The vector to copy. |
|
inline |
Sets the elements of this vector to those in the specified vector.
v | The vector to copy. |
|
inline |
Subtracts this vector and the specified vector as (this - v) and stores the result in this vector.
v | The vector to subtract. |
|
inline |
Subtracts this vector and the specified vector as (this - v) and stores the result in this vector.
v | The vector to subtract. |
|
inline |
Subtracts this vector and the specified vector as (this - v) and stores the result in this vector.
v | The vector to subtract. |
Subtracts the specified vectors and stores the result in dst.
The resulting vector is computed as (v1 - v2).
v1 | The first vector. |
v2 | The second vector. |
dst | The destination vector. |
|
static |
Subtracts the specified vectors and stores the result in dst.
The resulting vector is computed as (v1 - v2).
v1 | The first vector. |
v2 | The second vector. |
dst | The destination vector. |
|
static |
Subtracts the specified vectors and stores the result in dst.
The resulting vector is computed as (v1 - v2).
v1 | The first vector. |
v2 | The second vector. |
dst | The destination vector. |
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.
target | target value. |
elapsedTime | elapsed time between calls. |
responseTime | response time (in the same units as elapsedTime). |
var smooth | ( | var | target, |
var | elapsedTime, | ||
var | 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.
target | target value. |
elapsedTime | elapsed time between calls. |
responseTime | response time (in the same units as elapsedTime). |
local smooth | ( | local | target, |
local | elapsedTime, | ||
local | 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.
target | target value. |
elapsedTime | elapsed time between calls. |
responseTime | response time (in the same units as elapsedTime). |
Calculates the sum of this vector with the given vector.
Note: this does not modify this vector.
v | The vector to add. |
|
inline |
Calculates the sum of this vector with the given vector.
Note: this does not modify this vector.
v | The vector to add. |
|
inline |
Calculates the sum of this vector with the given vector.
Note: this does not modify this vector.
v | The vector to add. |
Adds the given vector to this vector.
v | The vector to add. |
|
inline |
Adds the given vector to this vector.
v | The vector to add. |
|
inline |
Adds the given vector to this vector.
v | The vector to add. |
Calculates the difference of this vector with the given vector.
Note: this does not modify this vector.
v | The vector to subtract. |
|
inline |
Calculates the difference of this vector with the given vector.
Note: this does not modify this vector.
v | The vector to subtract. |
|
inline |
Calculates the difference of this vector with the given vector.
Note: this does not modify this vector.
v | The vector to subtract. |
Subtracts the given vector from this vector.
v | The vector to subtract. |
|
inline |
Subtracts the given vector from this vector.
v | The vector to subtract. |
|
inline |
Subtracts the given vector from this vector.
v | The vector to subtract. |
|
inline |
Calculates the negation of this vector.
Note: this does not modify this vector.
|
inline |
Calculates the negation of this vector.
Note: this does not modify this vector.
|
inline |
Calculates the negation of this vector.
Note: this does not modify this vector.
|
inline |
Calculates the scalar product of this vector with the given value.
Note: this does not modify this vector.
s | The value to scale by. |
|
inline |
Calculates the scalar product of this vector with the given value.
Note: this does not modify this vector.
s | The value to scale by. |
|
inline |
Calculates the scalar product of this vector with the given value.
Note: this does not modify this vector.
s | The value to scale by. |
|
inline |
Scales this vector by the given value.
s | The value to scale by. |
|
inline |
Scales this vector by the given value.
s | The value to scale by. |
|
inline |
Scales this vector by the given value.
s | The value to scale by. |
|
inline |
Returns the components of this vector divided by the given constant.
Note: this does not modify this vector.
s | the constant to divide this vector with |
|
inline |
Returns the components of this vector divided by the given constant.
Note: this does not modify this vector.
s | the constant to divide this vector with |
|
inline |
Returns the components of this vector divided by the given constant.
Note: this does not modify this vector.
s | the constant to divide this vector with |
|
inline |
Determines if this vector is equal to the given vector.
v | The vector to compare against. |
|
inline |
Determines if this vector is equal to the given vector.
v | The vector to compare against. |
|
inline |
Determines if this vector is equal to the given vector.
v | The vector to compare against. |
|
inline |
Determines if this vector is not equal to the given vector.
v | The vector to compare against. |
|
inline |
Determines if this vector is not equal to the given vector.
v | The vector to compare against. |
|
inline |
Determines if this vector is not equal to the given vector.
v | The vector to compare against. |