C++ API Reference
|
Matrix array function set for dependency node data. More...
#include <MFnMatrixArrayData.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. More... | |
virtual | ~MFnMatrixArrayData () |
Destructor. | |
MFnMatrixArrayData () | |
Default constructor. | |
MFnMatrixArrayData (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
unsigned int | length (MStatus *ReturnStatus=NULL) const |
Return the number of matrices in the instance. More... | |
MStatus | set (MMatrix &element, unsigned int index) |
Set the matrix element at the specified index. More... | |
MStatus | copyTo (MMatrixArray &) const |
Copy all the matrices in the instance into the given MMatrixArray. More... | |
MStatus | set (const MMatrixArray &newArray) |
Set the instance to contain the matrices defined in the given MMatrixArray. More... | |
MMatrixArray | array (MStatus *ReturnStatus=NULL) |
Get an MMatrixArray containing the matrices stored in this instance. More... | |
MObject | create (MStatus *ReturnStatus=NULL) |
Create a new MObject, attach it to this instance, and initialize it to contain no points. More... | |
MObject | create (const MMatrixArray &in, MStatus *ReturnStatus=NULL) |
Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MMatrixArray. More... | |
MFnMatrixArrayData (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MMatrix & | operator[] (unsigned int index) |
NO SCRIPT SUPPORT. More... | |
const MMatrix & | operator[] (unsigned int index) const |
NO SCRIPT SUPPORT. More... | |
Public Member Functions inherited from MFnData | |
virtual | ~MFnData () |
Destructor. | |
MFnData (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MFnData () | |
Default class constructor. | |
MFnData (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
Public Member Functions inherited from MFnBase | |
virtual | ~MFnBase () |
Class Destructor. More... | |
bool | hasObj (MFn::Type) const |
Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
bool | hasObj (const MObject &) const |
Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
MObject | object (MStatus *ReturnStatus=nullptr) const |
Returns the MObject that is attached to the Function Set. More... | |
virtual MStatus | setObject (MObject &object) |
Attaches the Function Set to the specified Maya Object. More... | |
virtual MStatus | setObject (const MObject &object) |
NO SCRIPT SUPPORT. More... | |
Static Public Member Functions | |
static const char * | className () |
Returns the name of this class. More... | |
Static Public Member Functions inherited from MFnData | |
static const char * | className () |
Returns the name of this class. More... | |
Static Public Member Functions inherited from MFnBase | |
static const char * | className () |
Returns the name of this class. More... | |
static const char * | typeString (MFn::Type) |
Returns the type string for a given type. More... | |
static bool | isValid (MFn::Type) |
Returns true if type is in the range of valid types. More... | |
Additional Inherited Members | |
Public Types inherited from MFnData | |
enum | Type { kInvalid, kNumeric, kPlugin, kPluginGeometry, kString, kMatrix, kStringArray, kDoubleArray, kFloatArray, kIntArray, kPointArray, kVectorArray, kMatrixArray, kComponentList, kMesh, kLattice, kNurbsCurve, kNurbsSurface, kSphere, kDynArrayAttrs, kDynSweptGeometry, kSubdSurface, kNObject, kNId, kAny, kFalloffFunction } |
Types of dependency graph data. More... | |
Matrix array function set for dependency node data.
MFnMatrixArrayData allows the creation and manipulation of MMatrixArray data objects for use in the dependency graph.
If a user written dependency node either accepts or produces MMatrixArrays, 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 kMatrixArray 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 MFnMatrixArrayData.
MFnMatrixArrayData | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnMatrixArrayData | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kMatrixArrayData.
Reimplemented from MFnData.
|
static |
Returns the name of this class.
Return the class name : "MFnMatrixArrayData".
unsigned int length | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return the number of matrices in the instance.
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
MStatus copyTo | ( | MMatrixArray & | dest | ) | const |
Copy all the matrices in the instance into the given MMatrixArray.
No checking is done by this class on sizes, so it is up to the user to ensure that the given MMatrixArray is large enough to hold the number of MPoints in the instance.
[out] | dest | the MMatrixArray to populate |
MStatus set | ( | const MMatrixArray & | array | ) |
Set the instance to contain the matrices defined in the given MMatrixArray.
[in] | array | the MMatrixArray containing the data to set into this instance |
MMatrixArray array | ( | MStatus * | ReturnStatus = NULL | ) |
Get an MMatrixArray containing the matrices stored in this instance.
The MMatrixArray returned by this method is editable, so any changes to the return instance also affects the MObject operated upon by this function set.
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
MObject create | ( | const MMatrixArray & | arr, |
MStatus * | ReturnStatus = NULL |
||
) |
Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MMatrixArray.
[in] | arr | the data to use when initializing this instance |
[out] | ReturnStatus | kSuccess |
MMatrix & operator[] | ( | unsigned int | index | ) |
NO SCRIPT SUPPORT.
Extract the indicated MMatrix from the instance.
The MMatrix returned by this method is editable, so any changes to the return instance also affects the MObject operated upon by this function set.
No checking is done by this class to ensure that the index is valid - use the length method to determine the size of the array. If the instance is not attached to an MObject, this method will return an MMatrix containing the identity.
[in] | index | the index of the MMatrix to extract |
const MMatrix & operator[] | ( | unsigned int | index | ) | const |
NO SCRIPT SUPPORT.
Extract the indicated MMatrix from the const instance.
No checking is done by this class to ensure that the index is valid - use the length method to determine the size of the array. If the instance is not attached to an MObject, this method will return an MMatrix containing the identity.
[in] | index | the index of the MMatrix to extract |