MFnStringData Class Reference
[OpenMaya - API module for common classesFunctionSet classes]

#include <MFnStringData.h>

Inheritance diagram for MFnStringData:

Inheritance graph
[legend]
Collaboration diagram for MFnStringData:

Collaboration graph
[legend]

List of all members.


Detailed Description

String function set for dependency node data.

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.

Examples:

cgfxShaderNode.cpp, findFileTexturesCmd.cpp, GLSLShaderNode.cpp, hlslShader.cpp, and stringFormatNode.cpp.


Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnStringData ()
 Destructor.
 MFnStringData ()
 Default constructor.
 MFnStringData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
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)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnStringData::MFnStringData ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in] object The MObject to attach the function set to
[out] ReturnStatus the return status
Status Codes:

MFnStringData::MFnStringData ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in] object The MObject to attach the function set to
[out] ReturnStatus the return status
Status Codes:


Member Function Documentation

MFn::Type MFnStringData::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kStringData

Reimplemented from MFnData.

const char * MFnStringData::className (  )  const [protected, virtual]

Class name.

Return the class name : "MFnStringData"

Reimplemented from MFnData.

MString MFnStringData::string ( MStatus ReturnStatus = NULL  )  const

Return a copy of the string held in this instance.

Parameters:
[out] ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.
Returns:
An MString containing the string
Examples:

MStatus MFnStringData::set ( const MString string  ) 

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

Parameters:
[in] string the MString to copy
Returns:
  • kSuccess operation successfull.
  • kFailure instance is not attached to an MObject

MObject MFnStringData::create ( const MString str,
MStatus ReturnStatus = NULL 
)

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

Parameters:
[in] str the string to copy
[out] ReturnStatus kSuccess
Returns:
The new MObject
Examples:

MObject MFnStringData::create ( MStatus ReturnStatus = NULL  ) 

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

Parameters:
[out] ReturnStatus kSuccess
Returns:
The new MObject


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6