Home | Download | Screen shots | Discussion | Documentation |
---|
#include <openvrml/basetypes.h>
Public Member Functions | |
vec3f () throw () | |
Construct. | |
vec3f (const float(&vec)[3]) throw () | |
Construct from an array. | |
vec3f (float x, float y, float z) throw () | |
Construct from x , y , and z components. | |
vec3f & | operator *= (const vec3f &vec) throw () |
Cross multiply. | |
vec3f & | operator *= (const mat4f &mat) throw () |
Multiply by a matrix. | |
vec3f & | operator *= (float scalar) throw () |
Multiply by a scalar. | |
vec3f & | operator/= (float scalar) throw () |
Divide by a scalar. | |
vec3f & | operator+= (const vec3f &vec) throw () |
Add a vector. | |
vec3f & | operator-= (const vec3f &vec) throw () |
Subtract a vector. | |
const vec3f | operator- () const throw () |
Negate. | |
const float & | operator[] (size_t index) const throw () |
Index-based component access. | |
float | x () const throw () |
Get the x component. | |
void | x (float value) throw () |
Set the x component. | |
float | y () const throw () |
Get the y component. | |
void | y (float value) throw () |
Set the y component. | |
float | z () const throw () |
Get the z component. | |
void | z (float value) throw () |
Set the z component. | |
float | dot (const vec3f &vec) const throw () |
Dot product. | |
float | length () const throw () |
Geometric length. | |
const vec3f | normalize () const throw () |
Normalize. | |
Private Attributes | |
float | vec [3] |
Vector components. | |
Friends | |
std::istream & | operator>> (std::istream &in, vec3f &v) |
Stream input. | |
Related Functions | |
(Note that these are not member functions.) | |
const openvrml::vec3f | operator * (const vec3f &lhs, const vec3f &rhs) throw() |
Cross multiply two vectors. | |
const openvrml::vec3f | operator * (const vec3f &vec, const mat4f &mat) throw() |
Multiply a vector by a matrix. | |
const openvrml::vec3f | operator * (const mat4f &mat, const vec3f &vec) throw() |
Multiply a matrix by a vector. | |
const openvrml::vec3f | operator * (const vec3f &lhs, const float rhs) throw() |
Multiply a vector by a scalar. | |
const openvrml::vec3f | operator * (const float lhs, const vec3f &rhs) throw() |
Multiply a vector by a scalar. | |
const openvrml::vec3f | operator/ (const vec3f &lhs, const float rhs) throw() |
Divide a vector by a scalar. | |
const openvrml::vec3f | operator+ (const vec3f &lhs, const vec3f &rhs) throw() |
Add two vectors. | |
const openvrml::vec3f | operator- (const vec3f &lhs, const vec3f &rhs) throw() |
Subtract two vectors. | |
bool | operator== (const vec3f &lhs, const vec3f &rhs) throw() |
Compare for equality. | |
bool | operator!= (const vec3f &lhs, const vec3f &rhs) throw() |
Compare for inequality. | |
std::ostream & | operator<< (std::ostream &out, const vec3f &v) |
Stream output. |
openvrml::vec3f::vec3f | ( | ) | throw () |
Construct.
openvrml::vec3f::vec3f | ( | const float & | vec[3] | ) | throw () [explicit] |
Construct from an array.
vec
are valid numeric values (i.e., not NaN).[in] | vec | an array comprising the vector components. |
openvrml::vec3f::vec3f | ( | float | x, | |
float | y, | |||
float | z | |||
) | throw () |
Construct from x
, y
, and z
components.
x
, y
, and z
are valid numeric values (i.e., not NaN).[in] | x | x component. |
[in] | y | y component. |
[in] | z | z component. |
openvrml::vec3f & openvrml::vec3f::operator *= | ( | const vec3f & | vec | ) | throw () |
Cross multiply.
[in] | vec | vector by which to multiply. |
openvrml::vec3f & openvrml::vec3f::operator *= | ( | const mat4f & | mat | ) | throw () |
Multiply by a matrix.
[in] | mat | matrix by which to multiply. |
openvrml::vec3f & openvrml::vec3f::operator *= | ( | float | scalar | ) | throw () |
Multiply by a scalar.
[in] | scalar | factor by which to multiply. |
openvrml::vec3f & openvrml::vec3f::operator/= | ( | float | scalar | ) | throw () |
Divide by a scalar.
scalar
is nonzero.[in] | scalar | divisor. |
openvrml::vec3f & openvrml::vec3f::operator+= | ( | const vec3f & | vec | ) | throw () |
Add a vector.
[in] | vec | the vector to add. |
openvrml::vec3f & openvrml::vec3f::operator-= | ( | const vec3f & | vec | ) | throw () |
Subtract a vector.
[in] | vec | the vector to subtract. |
const openvrml::vec3f openvrml::vec3f::operator- | ( | ) | const throw () |
Negate.
const float & openvrml::vec3f::operator[] | ( | size_t | index | ) | const throw () [inline] |
Index-based component access.
[in] | index | 0 corresponds to the x component; 1 corresponds to the y component; 2 corresponds to the z component. |
index
.index
is less than 3. float openvrml::vec3f::x | ( | ) | const throw () [inline] |
Get the x component.
void openvrml::vec3f::x | ( | float | value | ) | throw () [inline] |
Set the x component.
value
is a valid numeric value (i.e., not NaN).[in] | value | new x component value. |
float openvrml::vec3f::y | ( | ) | const throw () [inline] |
Get the y component.
void openvrml::vec3f::y | ( | float | value | ) | throw () [inline] |
Set the y component.
value
is a valid numeric value (i.e., not NaN).[in] | value | new y component value. |
float openvrml::vec3f::z | ( | ) | const throw () [inline] |
Get the z component.
void openvrml::vec3f::z | ( | float | value | ) | throw () [inline] |
Set the z component.
value
is a valid numeric value (i.e., not NaN).[in] | value | new z component value. |
float openvrml::vec3f::dot | ( | const vec3f & | vec | ) | const throw () |
Dot product.
[in] | vec |
vec
. float openvrml::vec3f::length | ( | ) | const throw () |
Geometric length.
const openvrml::vec3f openvrml::vec3f::normalize | ( | ) | const throw () |
Normalize.
std::istream& operator>> | ( | std::istream & | in, | |
vec3f & | v | |||
) | [friend] |
Stream input.
Consistent with the VRML97 convention, commas (“,”) in the input are treated as whitespace.
[in,out] | in | input stream. |
[out] | v | a vec3f . |
in
. const openvrml::vec3f operator * | ( | const vec3f & | lhs, | |
const vec3f & | rhs | |||
) | throw() [related] |
Cross multiply two vectors.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
const openvrml::vec3f operator * | ( | const vec3f & | vec, | |
const mat4f & | mat | |||
) | throw() [related] |
Multiply a vector by a matrix.
[in] | vec | a vector. |
[in] | mat | a matrix. |
const openvrml::vec3f operator * | ( | const mat4f & | mat, | |
const vec3f & | vec | |||
) | throw() [related] |
Multiply a matrix by a vector.
[in] | mat | a matrix. |
[in] | vec | a 3-component vector. |
const openvrml::vec3f operator * | ( | const vec3f & | lhs, | |
const float | rhs | |||
) | throw() [related] |
Multiply a vector by a scalar.
[in] | lhs | left-hand operand (the vector). |
[in] | rhs | right-hand operand (the scalar). |
const openvrml::vec3f operator * | ( | const float | lhs, | |
const vec3f & | rhs | |||
) | throw() [related] |
Multiply a vector by a scalar.
[in] | lhs | left-hand operand (the scalar). |
[in] | rhs | right-hand operand (the vector). |
const openvrml::vec3f operator/ | ( | const vec3f & | lhs, | |
const float | rhs | |||
) | throw() [related] |
Divide a vector by a scalar.
rhs
is nonzero.[in] | lhs | left-hand operand (the vector). |
[in] | rhs | right-hand operand (the scalar). |
const openvrml::vec3f operator+ | ( | const vec3f & | lhs, | |
const vec3f & | rhs | |||
) | throw() [related] |
Add two vectors.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
const openvrml::vec3f operator- | ( | const vec3f & | lhs, | |
const vec3f & | rhs | |||
) | throw() [related] |
Subtract two vectors.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
Compare for equality.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
true
if lhs
and rhs
have the same value; false
otherwise. Compare for inequality.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
true
if lhs
and rhs
dot not have the same value; false
otherwise. std::ostream & operator<< | ( | std::ostream & | out, | |
const vec3f & | v | |||
) | [related] |
Stream output.
[in,out] | out | output stream. |
[in] | v | a 3-component vector. |
out
.
float openvrml::vec3f::vec[3] [private] |
Vector components.
For internal use only.