Public Member Functions | Protected Member Functions

MFnMeshData Class Reference

This reference page is linked to from the following overview topics: Data creators.


Search for all occurrences

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, polyPrimitiveCmd.cpp, shellNode.cpp, and testNobjectNode.cpp.

#include <MFnMeshData.h>

Inheritance diagram for MFnMeshData:
Inheritance graph
[legend]

List of all members.

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)
 Create a new MObject, attach it to this instance and initialize it with a data block capable of holding a Mesh.
 MFnMeshData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

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

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kMeshData.

Reimplemented from MFnGeometryData.

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

Class name.

Return the class name : "MFnMeshData".

Reimplemented from MFnGeometryData.

MObject 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]ReturnStatuskSuccess
Returns:
The new MObject
Examples:
animCubeNode.cpp, blindDataMesh.cpp, polyPrimitiveCmd.cpp, shellNode.cpp, and testNobjectNode.cpp.

MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData
MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData MFnMeshData