C++ API Reference
|
A vector math class for vectors of doubles. More...
#include <MVector.h>
Public Types | |
enum | Axis { kXaxis, kYaxis, kZaxis, kWaxis } |
Axes. More... | |
Public Member Functions | |
MVector () | |
The default class constructor. More... | |
MVector (const MVector &) | |
The copy constructor. More... | |
MVector (const MFloatVector &) | |
Class constructor. More... | |
MVector (const MPoint &) | |
Class constructor. More... | |
MVector (const MFloatPoint &) | |
Class constructor. More... | |
MVector (double xx, double yy, double zz=0.0) | |
Class constructor. More... | |
MVector (const double d[3]) | |
Class constructor. More... | |
MVector (const float f[3]) | |
Class constructor. More... | |
~MVector () | |
Class destructor. | |
MVector & | operator= (const MVector &src) |
The assignment operator. More... | |
double | operator() (unsigned int i) const |
The index operator. More... | |
double | operator[] (unsigned int i) const |
The index operator. More... | |
MVector | operator^ (const MVector &right) const |
The cross product operator. More... | |
double | operator* (const MVector &right) const |
The dot product operator. More... | |
MVector & | operator/= (double scalar) |
The in place division operator. More... | |
MVector | operator/ (double scalar) const |
The division operator. More... | |
MVector & | operator*= (int scalar) |
The in place multiplication operator. More... | |
MVector & | operator*= (short scalar) |
The in place multiplication operator. More... | |
MVector & | operator*= (unsigned int scalar) |
The in place multiplication operator. More... | |
MVector & | operator*= (unsigned short scalar) |
The in place multiplication operator. More... | |
MVector & | operator*= (float scalar) |
The in place multiplication operator. More... | |
MVector & | operator*= (double scalar) |
The in place multiplication operator. More... | |
MVector | operator* (int scalar) const |
The multiplication operator. More... | |
MVector | operator* (short scalar) const |
The multiplication operator. More... | |
MVector | operator* (unsigned int scalar) const |
The multiplication operator. More... | |
MVector | operator* (unsigned short scalar) const |
The multiplication operator. More... | |
MVector | operator* (float scalar) const |
The multiplication operator. More... | |
MVector | operator* (double scalar) const |
The multiplication operator. More... | |
MVector | operator+ (const MVector &other) const |
The vector addition operator. More... | |
MVector & | operator+= (const MVector &other) |
The in place vector addition operator. More... | |
MVector | operator- () const |
The unary minus operator. More... | |
MVector & | operator-= (const MVector &other) |
The in place vector subtraction operator. More... | |
MVector | operator- (const MVector &other) const |
The vector subtraction operator. More... | |
MVector | operator* (const MMatrix &) const |
The matrix multiplication operator. | |
MVector & | operator*= (const MMatrix &) |
The in place matrix multiplication operator. | |
bool | operator!= (const MVector &other) const |
The vector inequality operator. More... | |
bool | operator== (const MVector &other) const |
The vector equality operator. More... | |
MVector | rotateBy (double x, double y, double z, double w) const |
Returns the vector that represents the rotation of this vector by the given quaternion. More... | |
MVector | rotateBy (const double rotXYZ[3], MTransformationMatrix::RotationOrder order) const |
Returns the vector that represents the rotation of this vector by the given XYZ rotational values, applied according to the given rotation order. More... | |
MVector | rotateBy (MVector::Axis axis, const double angle) const |
Returns the vector that represents the rotation of this vector by the given angle about the given axis. More... | |
MVector | rotateBy (const MQuaternion &) const |
Returns the vector that represents the rotation of this vector by the given quaternion. More... | |
MVector | rotateBy (const MEulerRotation &) const |
Returns the vector that represents the rotation of this vector by the given euler rotation. More... | |
MQuaternion | rotateTo (const MVector &) const |
Returns the quaternion that represents the rotation of this vector into the other vector about their mutually perpendicular axis. More... | |
MStatus | get (double[3]) const |
Extracts the x, y, and z components of the vector and places them in elements 0, 1, and 2 of the double array passed. More... | |
double | length () const |
Return the length of the vector. | |
MVector | normal () const |
Return a normalized copy of this vector. | |
MStatus | normalize () |
Performs an in place normalization of the vector. More... | |
double | angle (const MVector &other) const |
Returns the angle in radians between the vector and the one passed as an argument. More... | |
bool | isEquivalent (const MVector &other, double tolerance=MVector_kTol) const |
Returns true if the vector and the one passed as an argument are equal to each other within the specified tolerance. More... | |
bool | isParallel (const MVector &other, double tolerance=MVector_kTol) const |
Returns true if the current vector and the one passed as an argument are parallel to each other within the specified tolerance. More... | |
MVector | transformAsNormal (const MMatrix &matrix) const |
This method treats the vector as a normal vector and returns a transformed copy of the vector. More... | |
double & | operator() (unsigned int i) |
NO SCRIPT SUPPORT. More... | |
double & | operator[] (unsigned int i) |
NO SCRIPT SUPPORT. More... | |
Public Attributes | |
double | x |
The x component of the vector. | |
double | y |
The y component of the vector. | |
double | z |
The z component of the vector. | |
Static Public Attributes | |
static const MVector | zero |
The null vector. | |
static const MVector | one |
The vector <1,1,1> | |
static const MVector | xAxis |
Unit vector in the positive x direction. | |
static const MVector | yAxis |
Unit vector in the positive y direction. | |
static const MVector | zAxis |
Unit vector in the positive z direction. | |
static const MVector | xNegAxis |
Unit vector in the negative z direction. | |
static const MVector | yNegAxis |
Unit vector in the negative z direction. | |
static const MVector | zNegAxis |
Unit vector in the negative z direction. | |
Friends | |
OPENMAYA_EXPORT MVector | operator* (const MMatrix &, const MVector &) |
NO SCRIPT SUPPORT. More... | |
OPENMAYA_EXPORT MVector | operator* (int, const MVector &) |
NO SCRIPT SUPPORT. More... | |
OPENMAYA_EXPORT MVector | operator* (short, const MVector &) |
NO SCRIPT SUPPORT. More... | |
OPENMAYA_EXPORT MVector | operator* (unsigned int, const MVector &) |
NO SCRIPT SUPPORT. More... | |
OPENMAYA_EXPORT MVector | operator* (unsigned short, const MVector &) |
NO SCRIPT SUPPORT. More... | |
OPENMAYA_EXPORT MVector | operator* (float, const MVector &) |
NO SCRIPT SUPPORT. More... | |
OPENMAYA_EXPORT MVector | operator* (double, const MVector &) |
NO SCRIPT SUPPORT. More... | |
OPENMAYA_EXPORT std::ostream & | operator<< (std::ostream &os, const MVector &v) |
NO SCRIPT SUPPORT. More... | |
A vector math class for vectors of doubles.
This class provides access to Maya's internal vector math library allowing vectors to be handled easily, and in a manner compatible with internal Maya data structures.
All methods that query the vector are threadsafe, all methods that modify the vector are not threadsafe.
enum Axis |
|
inline |
The default class constructor.
Creates a null vector.
The copy constructor.
Create a new vector and initialize it to the same values as the given vector.
[in] | src | the vector object to copy |
|
inline |
Class constructor.
Create a new vector and initialize it to the same values as the given MFloatVector.
[in] | src | the vector object to copy |
Class constructor.
Create a new vector and initialize it to the same x, y, z values as the given MPoint.
[in] | src | the point object to copy |
|
inline |
Class constructor.
Create a new vector and initialize it to the same x, y, z values as the given point.
[in] | src | the point object to copy |
|
inline |
Class constructor.
Initializes the vector with the explicit x, y and z values provided as arguments.
[in] | xx | the x component of the vector |
[in] | yy | the y component of the vector |
[in] | zz | the z component of the vector. Defaults to 0.0. |
|
inline |
Class constructor.
Initializes the vector with the explicit x, y and z values provided in the given double array.
[in] | d | the 3 element array containing the initial x, y, and z values |
|
inline |
Class constructor.
Initializes the vector with the explicit x, y and z values provided in the given float array.
[in] | f | the 3 element array containing the initial x, y, and z values |
The assignment operator.
Allows assignment between MVectors.
[in] | src | Vector to copy from. |
|
inline |
The index operator.
If its argument is 0 it will return the x component of the vector. If its argument is 1 it will return the y component of the vector. Otherwise it will return the z component of the vector.
[in] | i | value indicating which component to return |
|
inline |
The index operator.
If its argument is 0 it will return the x component of the vector. If its argument is 1 it will return the y component of the vector. Otherwise it will return the z component of the vector.
[in] | i | value indicating which component to return |
The cross product operator.
[in] | right | Vector to take the cross product with. |
|
inline |
The dot product operator.
[in] | right | Vector to take the dot product with. |
|
inline |
The in place division operator.
[in] | scalar | Division factor. |
|
inline |
The division operator.
[in] | scalar | Division factor. |
|
inline |
The in place multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The in place multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The in place multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The in place multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The in place multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The in place multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The multiplication operator.
[in] | scalar | Scale factor. |
|
inline |
The multiplication operator.
[in] | scalar | Scale factor. |
The vector addition operator.
[in] | other | Vector to add. |
The in place vector addition operator.
[in] | other | Vector to add. |
|
inline |
The unary minus operator.
Negates the value of each of the x, y, and z components of the vector.
The in place vector subtraction operator.
[in] | other | Vector to subtract. |
The vector subtraction operator.
[in] | other | Vector to substract. |
|
inline |
The vector inequality operator.
This returns false if all three of the x, y, and z components are identical.
[in] | other | The vector to compare to. |
|
inline |
The vector equality operator.
This returns true if all three of the x, y, and z components are identical.
[in] | other | The vector to compare to. |
MVector rotateBy | ( | double | x, |
double | y, | ||
double | z, | ||
double | w | ||
) | const |
Returns the vector that represents the rotation of this vector by the given quaternion.
[in] | x | The x component of the quaternion. |
[in] | y | The y component of the quaternion. |
[in] | z | The z component of the quaternion. |
[in] | w | The w component of the quaternion. |
MVector rotateBy | ( | const double | rotXYZ[3], |
MTransformationMatrix::RotationOrder | order | ||
) | const |
Returns the vector that represents the rotation of this vector by the given XYZ rotational values, applied according to the given rotation order.
[in] | rotXYZ | Array containing the X, Y, and Z axis rotations, respectively. |
[in] | order | Order in which to apply the XYZ components of the rotation. |
MVector rotateBy | ( | MVector::Axis | axis, |
const double | angle | ||
) | const |
Returns the vector that represents the rotation of this vector by the given angle about the given axis.
[in] | axis | The axis to rotate about. |
[in] | angle | The rotation angle about the axis. |
MVector rotateBy | ( | const MQuaternion & | q | ) | const |
Returns the vector that represents the rotation of this vector by the given quaternion.
[in] | q | The quaternion rotation by which the vector will be rotated to produce the resulting vector. |
MVector rotateBy | ( | const MEulerRotation & | e | ) | const |
Returns the vector that represents the rotation of this vector by the given euler rotation.
[in] | e | The euler rotation by which the vector will be rotated to produce the resulting vector. |
MQuaternion rotateTo | ( | const MVector & | other | ) | const |
Returns the quaternion that represents the rotation of this vector into the other vector about their mutually perpendicular axis.
[in] | other | The other vector into which this vector will be rotated to produce the resulting quaternion rotation. |
|
inline |
Extracts the x, y, and z components of the vector and places them in elements 0, 1, and 2 of the double array passed.
[out] | dest | the array of 3 doubles into which the results are placed. |
|
inline |
Performs an in place normalization of the vector.
double angle | ( | const MVector & | other | ) | const |
Returns the angle in radians between the vector and the one passed as an argument.
[in] | other | the vector from which to compute the angle. |
|
inline |
Returns true if the vector and the one passed as an argument are equal to each other within the specified tolerance.
[in] | other | The vector to compare to. |
[in] | tol | The tolerance to use during the comparison. |
bool isParallel | ( | const MVector & | other, |
double | tol = MVector_kTol |
||
) | const |
Returns true if the current vector and the one passed as an argument are parallel to each other within the specified tolerance.
[in] | other | the vector to compare to |
[in] | tol | the tolerance to use during the comparison |
This method treats the vector as a normal vector and returns a transformed copy of the vector.
Normal vectors are not transformed in the same way as position vectors or points. If this vector is treated as a normal vector then it needs to be transformed by post multiplying it by the inverse tanspose of the transformation matrix. This method will apply the proper transformation to the vector as if it were a normal.
[in] | matrix | the transformation matrix |
|
inline |
NO SCRIPT SUPPORT.
The index operator.
If its argument is 0 it will return the x component of the vector. If its argument is 1 it will return the y component of the vector. Otherwise it will return the z component of the vector.
[in] | i | value indicating which component to return |
|
inline |
NO SCRIPT SUPPORT.
The index operator.
If its argument is 0 it will return the x component of the vector. If its argument is 1 it will return the y component of the vector. Otherwise it will return the z component of the vector.
[in] | i | value indicating which component to return |
NO SCRIPT SUPPORT.
[in] | scalar | Scale factor. |
[in] | other | Vector to scale. |
NO SCRIPT SUPPORT.
[in] | scalar | Scale factor. |
[in] | other | Vector to scale. |
NO SCRIPT SUPPORT.
[in] | scalar | Scale factor. |
[in] | other | Vector to scale. |
NO SCRIPT SUPPORT.
[in] | scalar | Scale factor. |
[in] | other | Vector to scale. |
NO SCRIPT SUPPORT.
[in] | scalar | Scale factor. |
[in] | other | Vector to scale. |
NO SCRIPT SUPPORT.
[in] | scalar | Scale factor. |
[in] | other | Vector to scale. |
|
friend |
NO SCRIPT SUPPORT.
The format used is [x, y, z].
[in] | os | the ostream to print to |
[in] | v | the MVector whose value is to be printed |