C++ API Reference
|
int array function set for dependency node data. More...
#include <MFnVectorArrayData.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. More... | |
virtual | ~MFnVectorArrayData () |
Destructor. | |
MFnVectorArrayData () | |
Default constructor. | |
MFnVectorArrayData (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
unsigned int | length (MStatus *ReturnStatus=NULL) const |
Return the number of vectors in the instance. More... | |
MStatus | set (MVector &element, unsigned int index) |
Set the element at the specified index. More... | |
MStatus | copyTo (MVectorArray &) const |
Copy all the vectors in the instance into the given MVectorArray. More... | |
MStatus | set (const MVectorArray &newArray) |
Set the instance to contain the vectors defined in the given MVectorArray. More... | |
MVectorArray | array (MStatus *ReturnStatus=NULL) |
Return an MVectorArray containing the vector array currently operated upon by the function set. More... | |
MObject | create (MStatus *ReturnStatus=NULL) |
Create a new MObject, attach it to this instance, and initialize it to be empty. More... | |
MObject | create (const MVectorArray &in, MStatus *ReturnStatus=NULL) |
Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MVectorArray. More... | |
MFnVectorArrayData (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
const MVector & | operator[] (unsigned int index) const |
NO SCRIPT SUPPORT. More... | |
MVector & | operator[] (unsigned int index) |
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... | |
int array function set for dependency node data.
MFnVectorArrayData allows the creation and manipulation of MVectorArray data objects for use in the dependency graph.
If a user written dependency node either accepts or produces MVectorArrays, 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 kVectorArray 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 MFnVectorArrayData.
MFnVectorArrayData | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnVectorArrayData | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kVectorArrayData.
Reimplemented from MFnData.
|
static |
Returns the name of this class.
Return the class name : "MFnVectorArrayData".
unsigned int length | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return the number of vectors in the instance.
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
Set the element at the specified index.
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.
[in] | element | the element |
[in] | index | the index of the vector to set |
MStatus copyTo | ( | MVectorArray & | dest | ) | const |
Copy all the vectors in the instance into the given MVectorArray.
[out] | dest | the MVectorArray to populate |
MStatus set | ( | const MVectorArray & | array | ) |
Set the instance to contain the vectors defined in the given MVectorArray.
[in] | array | the MVectorArray containing the data to set into this instance |
MVectorArray array | ( | MStatus * | ReturnStatus = NULL | ) |
Return an MVectorArray containing the vector array currently operated upon by the function set.
The MVectorArray 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 MVectorArray & | arr, |
MStatus * | ReturnStatus = NULL |
||
) |
Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MVectorArray.
[in] | arr | the data to use when initializing this instance |
[out] | ReturnStatus | kSuccess |
const MVector & operator[] | ( | unsigned int | index | ) | const |
NO SCRIPT SUPPORT.
Extract the indicated int 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 empty vector.
[in] | index | the index of the vector to extract |
MVector & operator[] | ( | unsigned int | index | ) |
NO SCRIPT SUPPORT.
Extract the indicated vector from the instance.
by the function set. The vector returned by this method is editable, so any changes to the returned 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 a zero vector.
[in] | index | the index of the vector to extract |