#include
<MFnMatrixData.h>
List of all
members.
Detailed Description
Matrix function set for dependency node data.
MFnMatrixData
allows the creation and manipulation of MMatrix data
objects for use in the dependency graph.
If a user written dependency node either accepts or produces
MMatrix,
then this class is used to extract or create the data that comes
from or goes to other dependency graph nodes. The MDataHandle::type
method will return kMatrix when data of this type is present. To
access it, the MDataHandle::data
method is used to get an MObject for the data and this should then
be used to initialize an instance of MFnMatrixData.
Constructor & Destructor Documentation
MFnMatrixData::MFnMatrixData |
( |
MObject & |
object, |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Constructor.
Class constructor that initializes the function set to the given
MObject.
- Parameters:
-
[in] |
object |
The MObject to
attach the function set to |
[out] |
ReturnStatus |
the return status |
- Status Codes:
-
MFnMatrixData::MFnMatrixData |
( |
const MObject & |
object, |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Constructor.
Class constructor that initializes the function set to the given
MObject.
- Parameters:
-
[in] |
object |
The MObject to
attach the function set to |
[out] |
ReturnStatus |
the return status |
- Status Codes:
-
Member Function Documentation
MFn::Type
MFnMatrixData::type |
( |
|
) |
const [virtual] |
const char * MFnMatrixData::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnMatrixData"
Reimplemented from MFnData.
bool MFnMatrixData::isTransformation |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Determine if the matrix held in this instance is a transform
matrix.
- Parameters:
-
[out] |
ReturnStatus |
kFailure if the instance is not attached to an MObject, and kSuccess
otherwise. |
- Returns:
- true if the instance holds a transform matrix, false
otherwise
Return a copy of the transform matrix held in this instance.
- Parameters:
-
[out] |
ReturnStatus |
kFailure if the instance is not attached to an MObject, and kSuccess
otherwise. |
- Returns:
- A copy of the MTransformationMatrix held in this
instance
const MMatrix & MFnMatrixData::matrix |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Return a constant reference to the matrix held in this
instance.
- Parameters:
-
[out] |
ReturnStatus |
kFailure if the instance is not attached to an MObject, and kSuccess
otherwise. |
- Returns:
- A const reference to the MMatrix
Set this instance to hold a copy of the given transform
matrix.
- Parameters:
-
- Returns:
-
- kSuccess operation successfull.
- kFailure instance is not attached to an MObject
Set this instance to hold a copy of the given matrix.
- Parameters:
-
[in] |
mat |
the MMatrix
matrix to copy the data from |
- Returns:
-
- kSuccess operation successfull.
- kFailure instance is not attached to an MObject
Create a new MObject, attach it to this instance and
initialize it to the identity matrix. The result is not a transform
matrix
- Parameters:
-
[out] |
ReturnStatus |
kSuccess |
- Returns:
- The new MObject
Create a new MObject, attach it to this instance and
initialize it to the given matrix. The result is not a transform
matrix.
- Parameters:
-
[in] |
mat |
the MMatrix to
copy the data from |
[out] |
ReturnStatus |
kSuccess |
- Returns:
- The new MObject
Create a new MObject, attach it to this instance and
initialize it to the given transform matrix.
- Parameters:
-
- Returns:
- The new MObject