C++ API Reference
|
Point array function set for dependency node data. More...
#include <MFnPointArrayData.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. More... | |
virtual | ~MFnPointArrayData () |
Destructor. | |
MFnPointArrayData () | |
Default constructor. | |
MFnPointArrayData (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
unsigned int | length (MStatus *ReturnStatus=NULL) const |
Return the number of points in the instance. More... | |
MStatus | set (MPoint &element, unsigned int index) |
Set the point element at the specified index. More... | |
MStatus | copyTo (MPointArray &) const |
Copy all the points in the instance into the given MPointArray. More... | |
MStatus | set (const MPointArray &newArray) |
Set the instance to contain the points defined in the given MPointArray. More... | |
MPointArray | array (MStatus *ReturnStatus=NULL) |
Get an MPointArray containing the points 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 MPointArray &in, MStatus *ReturnStatus=NULL) |
Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MPointArray. More... | |
MFnPointArrayData (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MPoint & | operator[] (unsigned int index) |
NO SCRIPT SUPPORT. More... | |
const MPoint & | 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... | |
Point array function set for dependency node data.
MFnPointArrayData allows the creation and manipulation of MPointArray data objects for use in the dependency graph.
If a user written dependency node either accepts or produces MPointArrays, 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 kPointArray 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 MFnPointArrayData.
MFnPointArrayData | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnPointArrayData | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kPointArrayData.
Reimplemented from MFnData.
|
static |
Returns the name of this class.
Return the class name : "MFnPointArrayData".
unsigned int length | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return the number of points in the instance.
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
MStatus copyTo | ( | MPointArray & | dest | ) | const |
Copy all the points in the instance into the given MPointArray.
No checking is done by this class on sizes, so it is up to the user to ensure that the given MPointArray is large enough to hold the number of MPoints in the instance.
[out] | dest | the MPointArray to populate |
MStatus set | ( | const MPointArray & | array | ) |
Set the instance to contain the points defined in the given MPointArray.
[in] | array | the MPointArray containing the data to set into this instance |
MPointArray array | ( | MStatus * | ReturnStatus = NULL | ) |
Get an MPointArray containing the points stored in this instance.
The MPointArray 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. |
Create a new MObject, attach it to this instance, and initialize it to contain no points.
[out] | ReturnStatus | kSuccess |
MObject create | ( | const MPointArray & | arr, |
MStatus * | ReturnStatus = NULL |
||
) |
Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MPointArray.
[in] | arr | the data to use when initializing this instance |
[out] | ReturnStatus | kSuccess |
MPoint & operator[] | ( | unsigned int | index | ) |
NO SCRIPT SUPPORT.
Extract the indicated MPoint from the instance.
The MPoint 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 MPoint containing (0.0, 0.0, 0.0, 1.0).
[in] | index | the index of the MPoint to extract |
const MPoint & operator[] | ( | unsigned int | index | ) | const |
NO SCRIPT SUPPORT.
Extract the indicated MPoint 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 MPoint containing (0.0, 0.0, 0.0, 1.0).
[in] | index | the index of the MPoint to extract |