C++ API Reference

String array function set for dependency node data. More...

#include <MFnStringArrayData.h>

+ Inheritance diagram for MFnStringArrayData:

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 MStringoperator[] (unsigned int index) const
 Extract the indicated MString from the const instance. More...
 
 MFnStringArrayData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MStringoperator[] (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...
 

Detailed Description

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.

Examples:
AbcBullet/AttributesWriter.cpp, AbcExport/AbcExport.cpp, AbcExport/AttributesWriter.cpp, AbcImport/AlembicNode.cpp, AbcImport/NodeIteratorVisitorHelper.cpp, cgFx/cgfxShaderNode.cpp, dx11Shader/dx11Shader.cpp, glslShader/GLSLShader.cpp, and hlslShader/hlslShader.cpp.

Constructor & Destructor Documentation

MFnStringArrayData ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
MFnStringArrayData ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

Member Function Documentation

MFn::Type type ( ) const
virtual

Function set type.

Return the class type : MFn::kStringArrayData.

Returns
the class type.

Reimplemented from MFnData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnStringArrayData".

Returns
Name of this class.
unsigned int length ( MStatus ReturnStatus = NULL) const

Return the number of strings in the instance.

Parameters
[out]ReturnStatuskFailure if the instance is not attached to an MObject, and kSuccess otherwise.
Returns
The number of strings in the instance
Examples:
AbcBullet/AttributesWriter.cpp, and AbcExport/AttributesWriter.cpp.
MStatus set ( const MString element,
unsigned int  index 
)

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.

Parameters
[in]elementthe element
[in]indexthe index of the MString to set
Returns
  • kSuccess operation successful
  • kFailure instance is not attached to an MObject
MStatus copyTo ( MStringArray dest) const

Copy all the strings in the instance into the given MStringArray.

Parameters
[out]destthe MStringArray to populate
Returns
  • kSuccess operation successful
  • kFailure instance is not attached to an MObject
MStatus set ( const MStringArray array)

Set the instance to contain the strings defined in the given MStringArray.

Parameters
[in]arraythe MStringArray containing the data to set into this instance
Returns
  • kSuccess operation successful
  • kFailure instance is not attached to an MObject
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.

Parameters
[out]ReturnStatuskFailure if the instance is not attached to an MObject, and kSuccess otherwise.
Returns
A copy of the MStringArray held in this instance
MObject create ( MStatus ReturnStatus = NULL)

Create a new MObject, attach it to this instance, and initialize it to contain no strings.

Parameters
[out]ReturnStatuskSuccess
Returns
The newly created MObject
Examples:
AbcImport/AlembicNode.cpp, AbcImport/NodeIteratorVisitorHelper.cpp, cgFx/cgfxShaderNode.cpp, dx11Shader/dx11Shader.cpp, glslShader/GLSLShader.cpp, and hlslShader/hlslShader.cpp.
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.

Parameters
[in]arrthe data to use when initializing this instance
[out]ReturnStatuskSuccess
Returns
The newly created MObject
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 "".

Parameters
[in]indexthe index of the MString to extract
Returns
The indicated MString
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 "".

Parameters
[in]indexthe index of the MString to extract
Returns
The indicated MString

The documentation for this class was generated from the following files: