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

#include <MFnStringData.h>

Inheritance diagram for MFnStringData:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

virtual	~MFnStringData ()
	Destructor.

	MFnStringData ()
	Default constructor.

	MFnStringData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MString	string (MStatus *ReturnStatus=NULL) const
	Return a copy of the string held in this instance. More...

MStatus	set (const MString &newString)
	Set this instance to hold a copy of the given string. More...

MObject	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. More...

MObject	create (MStatus *ReturnStatus=NULL)
	Create a new MObject, attach it to this instance and initialize it to the null string. More...

	MFnStringData (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. 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)
	Introduced in 2020.0 More...

static bool	isValid (MFn::Type)
	Introduced in 2020.0 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, kLast }
	Types of dependency graph data. More...

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:: AbcImport/AlembicNode.cpp, AbcImport/CreateSceneHelper.cpp, AbcImport/NodeIteratorVisitorHelper.cpp, cgFx/cgfxShaderNode.cpp, dx11Shader/dx11Shader.cpp, fileTexture/fileTexture.cpp, findFileTexturesCmd/findFileTexturesCmd.cpp, glslShader/GLSLShader.cpp, hlslShader/hlslShader.cpp, MayaPluginForSpreticle/spReticleLoc.cpp, sceneAssembly/adskPrepareRenderGlobals.cpp, stringFormatNode/stringFormatNode.cpp, and uiDrawManager/uiDrawManager.cpp.

Constructor & Destructor Documentation

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:

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	(	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:

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::kStringData.

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 : "MFnStringData".

Returns: Name of this class.

MString 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:: findFileTexturesCmd/findFileTexturesCmd.cpp.

MStatus 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 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:: AbcImport/AlembicNode.cpp, AbcImport/CreateSceneHelper.cpp, AbcImport/NodeIteratorVisitorHelper.cpp, cgFx/cgfxShaderNode.cpp, dx11Shader/dx11Shader.cpp, fileTexture/fileTexture.cpp, glslShader/GLSLShader.cpp, hlslShader/hlslShader.cpp, MayaPluginForSpreticle/spReticleLoc.cpp, sceneAssembly/adskPrepareRenderGlobals.cpp, stringFormatNode/stringFormatNode.cpp, and uiDrawManager/uiDrawManager.cpp.

MObject 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

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

MFnStringData.h
MFnStringData.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation