csVector3 Class Reference
[Geometry utilities]
A 3D vector.
More...
#include <csgeom/vector3.h>
Public Member Functions | |
void | Cross (const csVector3 &px, const csVector3 &py) |
Take cross product of two vectors and put result in this vector. | |
csVector3 (const csDVector3 &) | |
Conversion from double precision vector to single. | |
csVector3 (const csVector3 &v) | |
Copy Constructor. | |
csVector3 (float ix, float iy, float iz=0) | |
Make a new vector and initialize with the given values. | |
csVector3 (float m) | |
Make a new initialized vector. | |
csVector3 () | |
Make a new vector. | |
csString | Description () const |
Return a textual representation of the vector in the form "x,y,z". | |
void | Get (float *v) |
Get the value of this vector. | |
bool | IsZero (float precision=SMALL_EPSILON) const |
Query if the vector is zero. | |
float | Norm () const |
Returns the norm of this vector. | |
void | Normalize () |
Scale this vector to length = 1.0;. | |
csVector3 & | operator *= (float f) |
Multiply this vector by a scalar. | |
csVector3 | operator+ () const |
Unary + operator. | |
csVector3 & | operator+= (const csVector3 &v) |
Add another vector to this vector. | |
csVector3 | operator- () const |
Unary - operator. | |
csVector3 & | operator-= (const csVector3 &v) |
Subtract another vector from this vector. | |
csVector3 & | operator/= (float f) |
Divide this vector by a scalar. | |
float & | operator[] (int n) |
Returns n-th component of the vector. | |
float | operator[] (int n) const |
Returns n-th component of the vector. | |
void | Set (float v) |
Set the value of this vector so that all components are the same. | |
void | Set (float const *v) |
Set the value of this vector. | |
void | Set (csVector3 const &v) |
Set the value of this vector. | |
void | Set (float sx, float sy, float sz) |
Set the value of this vector. | |
float | SquaredNorm () const |
Return the squared norm (magnitude) of this vector. | |
csVector3 | Unit () const |
Returns the unit vector in the direction of this vector. | |
Static Public Member Functions | |
static float | Norm (const csVector3 &v) |
Returns the norm (magnitude) of a vector. | |
static csVector3 | Unit (const csVector3 &v) |
Normalizes a vector to a unit vector. | |
Friends | |
csVector3 | operator * (int f, const csVector3 &v) |
Multiply a vector and a scalar int. | |
csVector3 | operator * (const csVector3 &v, int f) |
Multiply a vector and a scalar int. | |
csDVector3 | operator * (double f, const csVector3 &v) |
Multiply a vector and a scalar double. Upgrade v to DVector. | |
csDVector3 | operator * (const csVector3 &v, double f) |
Multiply a vector and a scalar double. Upgrade v to DVector. | |
csVector3 | operator * (float f, const csVector3 &v) |
Multiply a vector and a scalar. | |
csVector3 | operator * (const csVector3 &v, float f) |
Multiply a vector and a scalar. | |
float | operator * (const csVector3 &v1, const csVector3 &v2) |
Take the dot product of two vectors. | |
bool | operator!= (const csVector3 &v1, const csVector3 &v2) |
Check if two vectors are not equal. | |
csVector3 | operator% (const csVector3 &v1, const csVector3 &v2) |
Take the cross product of two vectors. | |
csDVector3 | operator+ (const csVector3 &v1, const csDVector3 &v2) |
Add two vectors of differing type, raise the csVector3 to DVector3. | |
csDVector3 | operator+ (const csDVector3 &v1, const csVector3 &v2) |
Add two vectors of differing type, raise the csVector3 to DVector3. | |
csVector3 | operator+ (const csVector3 &v1, const csVector3 &v2) |
Add two vectors. | |
csDVector3 | operator- (const csDVector3 &v1, const csVector3 &v2) |
Subtract two vectors of differing type, cast to double. | |
csDVector3 | operator- (const csVector3 &v1, const csDVector3 &v2) |
Subtract two vectors of differing type, cast to double. | |
csVector3 | operator- (const csVector3 &v1, const csVector3 &v2) |
Subtract two vectors. | |
csVector3 | operator/ (const csVector3 &v, int f) |
Divide a vector by a scalar int. | |
csDVector3 | operator/ (const csVector3 &v, double f) |
Divide a vector by a scalar double. Upgrade v to DVector. | |
csVector3 | operator/ (const csVector3 &v, float f) |
Divide a vector by a scalar. | |
bool | operator< (const csVector3 &v, float f) |
Test if each component of a vector is less than a small epsilon value. | |
csVector3 | operator<< (const csVector3 &v1, const csVector3 &v2) |
Project one vector onto another. | |
bool | operator== (const csVector3 &v1, const csVector3 &v2) |
Check if two vectors are equal. | |
bool | operator> (float f, const csVector3 &v) |
Test if each component of a vector is less than a small epsilon value. | |
csVector3 | operator>> (const csVector3 &v1, const csVector3 &v2) |
Project one vector onto another. |
Detailed Description
A 3D vector.
Definition at line 55 of file vector3.h.
Constructor & Destructor Documentation
|
Make a new vector.
|
|
Make a new initialized vector. Creates a new vector and initializes it to m*<1,1,1>. To create a vector initialized to the zero vector, use csVector3(0) |
|
Make a new vector and initialize with the given values.
|
|
Copy Constructor.
|
|
Conversion from double precision vector to single.
|
Member Function Documentation
|
Take cross product of two vectors and put result in this vector.
|
|
Return a textual representation of the vector in the form "x,y,z".
|
|
Get the value of this vector.
|
|
Query if the vector is zero.
Definition at line 295 of file vector3.h. References ABS. |
|
Returns the norm (magnitude) of a vector.
Definition at line 286 of file vector3.h. References Norm(). |
|
Returns the norm of this vector.
Referenced by csMath3::DoubleArea3(), and Norm(). |
|
Scale this vector to length = 1.0;.
|
|
Multiply this vector by a scalar.
|
|
Unary + operator.
|
|
Add another vector to this vector.
|
|
Unary - operator.
|
|
Subtract another vector from this vector.
|
|
Divide this vector by a scalar.
|
|
Returns n-th component of the vector.
|
|
Returns n-th component of the vector.
|
|
Set the value of this vector so that all components are the same.
|
|
Set the value of this vector.
|
|
Set the value of this vector.
|
|
Set the value of this vector.
Definition at line 257 of file vector3.h. Referenced by csShaderVariable::GetValue(). |
|
Return the squared norm (magnitude) of this vector.
Definition at line 275 of file vector3.h. Referenced by csSpotLightProc< AttenuationProc >::ProcessVertex(), csDirectionalLightProc< AttenuationProc >::ProcessVertex(), and csPointLightProc< AttenuationProc >::ProcessVertex(). |
|
Normalizes a vector to a unit vector.
Definition at line 289 of file vector3.h. References Unit(). |
|
Returns the unit vector in the direction of this vector. Attempting to normalize a zero-vector will result in a divide by zero error. This is as it should be... fix the calling code. Definition at line 283 of file vector3.h. Referenced by Unit(). |
Friends And Related Function Documentation
|
Multiply a vector and a scalar int.
|
|
Multiply a vector and a scalar int.
|
|
Multiply a vector and a scalar double. Upgrade v to DVector.
|
|
Multiply a vector and a scalar double. Upgrade v to DVector.
|
|
Multiply a vector and a scalar.
|
|
Multiply a vector and a scalar.
|
|
Take the dot product of two vectors.
|
|
Check if two vectors are not equal.
|
|
Take the cross product of two vectors.
|
|
Add two vectors of differing type, raise the csVector3 to DVector3.
|
|
Add two vectors of differing type, raise the csVector3 to DVector3.
|
|
Add two vectors.
|
|
Subtract two vectors of differing type, cast to double.
|
|
Subtract two vectors of differing type, cast to double.
|
|
Subtract two vectors.
|
|
Divide a vector by a scalar int.
|
|
Divide a vector by a scalar double. Upgrade v to DVector.
|
|
Divide a vector by a scalar.
|
|
Test if each component of a vector is less than a small epsilon value.
|
|
Project one vector onto another.
|
|
Check if two vectors are equal.
|
|
Test if each component of a vector is less than a small epsilon value.
|
|
Project one vector onto another.
|
Member Data Documentation
|
All components.
|
|
|
|
The documentation for this class was generated from the following file:
- csgeom/vector3.h
Generated for Crystal Space by doxygen 1.4.4