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

#include <MFnSubdData.h>

Inheritance diagram for MFnSubdData:

Inheritance graph
[legend]
Collaboration diagram for MFnSubdData:

Collaboration graph
[legend]

List of all members.


Detailed Description

Subdiv Surface function set for dependency node data.

MFnSubdData allows the creation and manipulation of Subdivision Surface data objects for use in the dependency graph.

If a user written dependency node either accepts or produces Subdivision Surfaces, 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 kSubdiv when data of this type is present.

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

If a node is to create a Subdivision Surface and send it via an output attribute, a new MFnSubdData 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 MFnSubd::create method as the parentOrOwner parameter so that the Subdivision Surface will be constructed inside the data block. The MDataHandle::set routine is then used to pass the data block down the connection.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnSubdData ()
 Destructor.
 MFnSubdData ()
 Default constructor.
 MFnSubdData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 MFnSubdData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.


Constructor & Destructor Documentation

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

MFnSubdData::MFnSubdData ( 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 MFnSubdData::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kSubdivData

Reimplemented from MFnGeometryData.

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

Class name.

Return the class name : "MFnSubdData"

Reimplemented from MFnGeometryData.

MObject MFnSubdData::create ( MStatus ReturnStatus = NULL  ) 

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

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


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