C++ API Reference

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

#include <MFnMeshData.h>

+ Inheritance diagram for MFnMeshData:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnMeshData ()
 Destructor.
 
 MFnMeshData ()
 Default constructor.
 
 MFnMeshData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
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. More...
 
 MFnMeshData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
- Public Member Functions inherited from MFnGeometryData
virtual ~MFnGeometryData ()
 Destructor.
 
 MFnGeometryData ()
 Default constructor.
 
 MFnGeometryData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MStatus setMatrix (const MMatrix &)
 Reset the matrix the the specified matrix and set the identity flag if the new matrix is the identity. More...
 
MStatus getMatrix (MMatrix &) const
 Get the matrix associated with the geometry data. More...
 
bool matrixIsIdentity (MStatus *ReturnStatus=NULL) const
 Return true if the matrix is the identity. More...
 
bool matrixIsNotIdentity (MStatus *ReturnStatus=NULL) const
 Return true if the matrix is different from identity. More...
 
bool hasObjectGroup (unsigned int id, MStatus *ReturnStatus=NULL) const
 This method returns true if an object group with the given id is contained in the data. More...
 
MStatus addObjectGroup (unsigned int)
 This method adds an object group with the given id to the object. More...
 
MStatus removeObjectGroup (unsigned int)
 This method removes an object group with the given id from the object. More...
 
MStatus changeObjectGroupId (unsigned int, unsigned int)
 This method changes the id of the object group with the given id to the new id. More...
 
unsigned int objectGroupCount (MStatus *ReturnStatus=NULL) const
 This method returns the number of object groups contained by the object. More...
 
unsigned int objectGroup (unsigned int index, MStatus *ReturnStatus=NULL) const
 This method returns the id of the i'th object group contained by the object. More...
 
MFn::Type objectGroupType (unsigned int, MStatus *ReturnStatus=NULL) const
 This method returns the type of the component that the object group with the given id contains. More...
 
MObject objectGroupComponent (unsigned int, MStatus *ReturnStatus=NULL) const
 This method returns a component which contains the members of the object group with the given id. More...
 
MStatus setObjectGroupComponent (unsigned int, MObject &)
 This method sets the members of the object group with the given id to be only those in the given component. More...
 
MStatus addObjectGroupComponent (unsigned int, MObject &)
 This method adds the members of the given component to the object group with the given id. More...
 
MStatus removeObjectGroupComponent (unsigned int, MObject &)
 This method removes the members of the given component from the object group with the given id. More...
 
SubsetState objectGroupSubsetState (unsigned int, MStatus *ReturnStatus=NULL) const
 This method returns the state of the contents of the component that the object group with the given id contains. More...
 
MStatus copyObjectGroups (MObject &inGeom)
 Copies the object groups from the given geometry data object. More...
 
MStatus componentTags (MStringArray &keys) const
 Get the componentTag keys associated with the geometry data. More...
 
bool hasComponentTag (const MString &key, MStatus *ReturnStatus=NULL) const
 This method returns true if a componentTag with the given key is contained in the data. More...
 
MStatus addComponentTag (const MString &key)
 This method adds a componentTag with the given key to the object. More...
 
MStatus removeComponentTag (const MString &key)
 This method removes a componentTag with the given key from the object. More...
 
MStatus renameComponentTag (const MString &key, const MString &newKey)
 This method renames a componentTag with the given key to a new key. More...
 
MObject componentTagContents (const MString &key, MStatus *ReturnStatus=NULL) const
 This method returns a component which contains the members of the object group with the given id. More...
 
MStatus setComponentTagContents (const MString &key, MObject &)
 This method sets the members of the object group with the given id to be only those in the given component. More...
 
MFn::Type componentTagType (const MString &key, MStatus *ReturnStatus=NULL) const
 This method returns the type of the component the componentTag with the given key contains. More...
 
ComponentTagCategory componentTagCategory (const MString &key, MStatus *ReturnStatus=NULL) const
 This method returns the category of the component the componentTag with the given key contains. More...
 
SubsetState componentTagExpressionSubsetState (const MString &expression, ComponentTagCategory ctg=MFnGeometryData::ComponentTagCategory::kAuto, MStatus *ReturnStatus=NULL) const
 This method returns the state of the contents of the component that is defined by the given componentTag expression. More...
 
MObject resolveComponentTagExpression (const MString &expression, ComponentTagCategory ctg=MFnGeometryData::ComponentTagCategory::kAuto, MStatus *ReturnStatus=NULL) const
 This method returns the resolved component that is defined by the given componentTag expression. More...
 
 MFnGeometryData (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 MFnGeometryData
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)
 Returns the type string for a given type. More...
 
static bool isValid (MFn::Type)
 Returns true if type is in the range of valid types. More...
 

Additional Inherited Members

- Public Types inherited from MFnGeometryData
enum  ComponentTagCategory
 Component tag type.
 
enum  SubsetState
 Group contents.
 
- 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
}
 Types of dependency graph data. More...
 

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:
AbcImport/AlembicNode.cpp, animCubeNode/animCubeNode.cpp, blindDataShader/blindDataMesh.cpp, gpuCache/CacheReaderAlembic.cpp, gpuCache/CacheReaderAlembic.h, gpuCache/gpuCacheCmd.cpp, polyPrimitiveCmd/polyPrimitiveCmd.cpp, shellNode/shellNode.cpp, and testNobjectNode/testNobjectNode.cpp.

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:
  • 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 ( 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:
  • 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::kMeshData.

Returns
the class type.

Reimplemented from MFnGeometryData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnMeshData".

Returns
Name of this class.
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:
AbcImport/AlembicNode.cpp, animCubeNode/animCubeNode.cpp, blindDataShader/blindDataMesh.cpp, gpuCache/CacheReaderAlembic.cpp, gpuCache/gpuCacheCmd.cpp, polyPrimitiveCmd/polyPrimitiveCmd.cpp, shellNode/shellNode.cpp, and testNobjectNode/testNobjectNode.cpp.

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