C++ API Reference
|
String array function set for dependency node data. More...
#include <MFnStringArrayData.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. More... | |
virtual | ~MFnStringArrayData () |
Destructor. | |
MFnStringArrayData () | |
Default constructor. | |
MFnStringArrayData (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
unsigned int | length (MStatus *ReturnStatus=NULL) const |
Return the number of strings in the instance. More... | |
MStatus | set (const MString &element, unsigned int index) |
Set the element at the specified index of the array. More... | |
MStatus | copyTo (MStringArray &) const |
Copy all the strings in the instance into the given MStringArray. More... | |
MStatus | set (const MStringArray &newArray) |
Set the instance to contain the strings defined in the given MStringArray. More... | |
MStringArray | array (MStatus *ReturnStatus=NULL) |
Return an MStringArray containing the string 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 contain no strings. More... | |
MObject | create (const MStringArray &in, MStatus *ReturnStatus=NULL) |
Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MStringArray. More... | |
const MString & | operator[] (unsigned int index) const |
Extract the indicated MString from the const instance. More... | |
MFnStringArrayData (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MString & | 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... | |
String array function set for dependency node data.
MFnStringArrayData allows the creation and manipulation of MStringArray data objects for use in the dependency graph.
If a user written dependency node either accepts or produces MStringArrays, 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 kStringArray 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 MFnStringArrayData.
MFnStringArrayData | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnStringArrayData | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kStringArrayData.
Reimplemented from MFnData.
|
static |
Returns the name of this class.
Return the class name : "MFnStringArrayData".
unsigned int length | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return the number of strings 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 of the array.
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 MString to set |
MStatus copyTo | ( | MStringArray & | dest | ) | const |
Copy all the strings in the instance into the given MStringArray.
[out] | dest | the MStringArray to populate |
MStatus set | ( | const MStringArray & | array | ) |
Set the instance to contain the strings defined in the given MStringArray.
[in] | array | the MStringArray containing the data to set into this instance |
MStringArray array | ( | MStatus * | ReturnStatus = NULL | ) |
Return an MStringArray containing the string array currently operated upon by the function set.
The MStringArray 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 MStringArray & | arr, |
MStatus * | ReturnStatus = NULL |
||
) |
Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MStringArray.
[in] | arr | the data to use when initializing this instance |
[out] | ReturnStatus | kSuccess |
const MString & operator[] | ( | unsigned int | index | ) | const |
Extract the indicated MString 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 MString containing "".
[in] | index | the index of the MString to extract |
MString & operator[] | ( | unsigned int | index | ) |
NO SCRIPT SUPPORT.
Extract the indicated MString from the instance.
by the function set. The MString 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 MString containing "".
[in] | index | the index of the MString to extract |