class MFnStringData

Jump to documentation

: public MFnData String function set for dependency node data. (OpenMaya) (OpenMaya.py)

Inheritance:

MFnStringData < MFnData < MFnBase

public members:

MFnStringData ()
MFnStringData ( MObject & object, MStatus * ReturnStatus = NULL )
virtual ~MFnStringData ()
virtual MFn::Type type () const
MString string ( MStatus * ReturnStatus = NULL ) const
MStatus set ( const MString & newString )
MObject create ( const MString & str, MStatus * ReturnStatus = NULL )
MObject create ( MStatus * ReturnStatus = NULL )
MFnStringData ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnData:

public members:

enum Type
kInvalid
kNumeric
Numeric, use MFnNumericData extract the node data.
kPlugin
Plugin Blind Data, use MFnPluginData to extract the node data.
kPluginGeometry
Plugin Geometry, use MFnGeometryData to extract the node data.
kString
String, use MFnStringData to extract the node data.
kMatrix
Matrix, use MFnMatrixData to extract the node data.
kStringArray
String Array, use MFnStringArrayData to extract the node data.
kDoubleArray
Double Array, use MFnDoubleArrayData to extract the node data.
kIntArray
Int Array, use MFnIntArrayData to extract the node data.
kPointArray
Point Array, use MFnPointArrayData to extract the node data.
kVectorArray
Vector Array, use MFnVectorArrayData to extract the node data.
kComponentList
Component List, use MFnComponentListData to extract the node data.
kMesh
Mesh, use MFnMeshData to extract the node data.
kLattice
Lattice, use MFnLatticeData to extract the node data.
kNurbsCurve
Nurbs Curve, use MFnNurbsCurveData to extract the node data.
kNurbsSurface
Nurbs Surface, use MFnNurbsSurfaceData to extract the node data.
kSphere
Sphere, use MFnSphereData to extract the node data.
kDynArrayAttrs
ArrayAttrs, use MFnArrayAttrsData to extract the node data.
kDynSweptGeometry
SweptGeometry, use MFnDynSweptGeometryData to extract the node data.
kSubdSurface
Subdivision Surface, use MFnSubdData to extract the node data.
kNObject
nObject data, use MFnNObjectData to extract node data
kLast

Inherited from MFnBase:

public members:

virtual MFn::Type type () const
bool hasObj ( MFn::Type ) const
bool hasObj ( const MObject & ) const
MObject object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( MObject & object )
virtual MStatus setObject ( const MObject & object )

Documentation

Create and manipulate MString dependency node data
Description

MFnStringData allows the creation and manipulation of MString data objects for use in the dependency graph.

If a user written dependency node either accepts or produces MString, 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 kStringData 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 MFnStringData.

Functions

MFnStringData:: MFnStringData ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnStringData:: MFnStringData ( MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

  • object the MObject to attach the function set to
  • ReturnStatus the return status
    • 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

MFnStringData:: MFnStringData ( const MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

  • object the const MObject to attach the function set to
  • ReturnStatus the return status
    • 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

MFnStringData:: ~MFnStringData ()

Description

The class destructor.

MFn::Type MFnStringData:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kStringData

MString MFnStringData:: string ( MStatus * ReturnStatus ) const

Description

Return a copy of the string held in this instance.

Arguments

  • ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Return Value

  • an MString containing the string

MStatus MFnStringData:: set ( const MString & string )

Description

Set this instance to hold a copy of the given string.

Arguments

  • string the MString to copy

Return Value

  • kSuccess operation successfull.
  • kFailure instance is not attached to an MObject

MObject MFnStringData:: create ( MStatus * ReturnStatus )

Description

Create a new MObject, attach it to this instance and initialize it to the null string.

Arguments

  • ReturnStatus kSuccess

Return Value

  • the new MObject

MObject MFnStringData:: create ( const MString & str, MStatus * ReturnStatus )

Description

Create a new MObject, attach it to this instance and initialize it to a copy of the given string.

Arguments

  • str the string to copy
  • ReturnStatus kSuccess

Return Value

  • the new MObject

This class has no child classes.


Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright