MFnMeshData Class Reference
[OpenMaya - API module for common classes, FunctionSet classes]

#include <MFnMeshData.h>

Inheritance diagram for MFnMeshData:

[legend]

Collaboration diagram for MFnMeshData:

[legend]

List of all members.

---

Detailed Description

Mesh function set for dependency node data.

MFnMeshData allows the creation and manipulation of Mesh data objects for use in the dependency graph.

If a user written dependency node either accepts or produces Meshes, then this class is used to create data blocks into which Meshes can be constructed before being passed to other dependency graph nodes. The MDataHandle::type method will return kMesh when data of this type is present.

If a node is receiving a Mesh via an input attribute, the asMesh method of MDataHandle can be used to access that input Mesh.

If a node is to create a Mesh and send it via an output attribute, a new MFnMeshData must be instantiated and then the create method called to build the actual data block as an MObject. This MObject should be passed to the MFnMesh::create method as the parentOrOwner parameter so that the Mesh will be constructed inside the data block. The MDataHandle::set routine is then used to pass the data block down the connection.

Examples:

animCubeNode.cpp, blindDataMesh.cpp, shellNode.cpp, and testNobjectNode.cpp.

Public Member Functions
virtual MFn::Type	type () const
	Function set type.
virtual	~MFnMeshData ()
	Destructor.
	MFnMeshData ()
	Default constructor.
	MFnMeshData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
MObject	create (MStatus *ReturnStatus=NULL)
	MFnMeshData (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
Protected Member Functions
virtual const char *	className () const
	Class name.

---

Constructor & Destructor Documentation

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

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

(

)

const [virtual]

Function set type.

Return the class type : MFn::kMeshData

Reimplemented from MFnGeometryData.

const char * MFnMeshData::className

(

)

const [protected, virtual]

Class name.

Return the class name : "MFnMeshData"

Reimplemented from MFnGeometryData.

MObject MFnMeshData::create

(

MStatus *

ReturnStatus = NULL

)

Create a new MObject, attach it to this instance and initialize it with a data block capable of holding a Mesh.

Parameters:

[out]

ReturnStatus

kSuccess

Returns:

The new MObject

Examples:

animCubeNode.cpp, blindDataMesh.cpp, shellNode.cpp, and testNobjectNode.cpp.