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

#include <MFnGeometryData.h>
Inheritance diagram for MFnGeometryData:
Inheritance graph
[legend]
Collaboration diagram for MFnGeometryData:
Collaboration graph
[legend]

List of all members.


Detailed Description

Geometry data function set.

This class is the function set for geometry data.

Geometry data adds matrix and grouping (set) information to regular data and is used to pass geometry types such as mesh, lattice, and NURBS shape data through DG connections.

User defined geometry data types ( MPxGeometryData) are also supported by this class.

The matrix within geometry data is the matrix used to convert the object into local space.


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnGeometryData ()
  Destructor.
  MFnGeometryData ()
  Default constructor.
  MFnGeometryData (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
MStatus  setMatrix (const MMatrix &)
MStatus  getMatrix (MMatrix &) const
bool  matrixIsIdentity (MStatus *ReturnStatus=NULL) const
bool  matrixIsNotIdentity (MStatus *ReturnStatus=NULL) const
bool  hasObjectGroup (unsigned int id, MStatus *ReturnStatus=NULL) const
MStatus  addObjectGroup (unsigned int)
MStatus  removeObjectGroup (unsigned int)
MStatus  changeObjectGroupId (unsigned int, unsigned int)
unsigned int  objectGroupCount (MStatus *ReturnStatus=NULL) const
unsigned int  objectGroup (unsigned int index, MStatus *ReturnStatus=NULL) const
MFn::Type  objectGroupType (unsigned int, MStatus *ReturnStatus=NULL) const
MObject  objectGroupComponent (unsigned int, MStatus *ReturnStatus=NULL) const
MStatus  setObjectGroupComponent (unsigned int, MObject &)
MStatus  addObjectGroupComponent (unsigned int, MObject &)
MStatus  removeObjectGroupComponent (unsigned int, MObject &)
MStatus  copyObjectGroups (MObject &inGeom)
  MFnGeometryData (const MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

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

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

Function set type.

Return the class type : MFn::kGeometryData

Reimplemented from MFnData.

Reimplemented in MFnLatticeData, MFnMeshData, MFnNurbsCurveData, MFnNurbsSurfaceData, and MFnSubdData.

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

Class name.

Return the class name : "MFnGeometryData"

Reimplemented from MFnData.

Reimplemented in MFnLatticeData, MFnMeshData, MFnNurbsCurveData, MFnNurbsSurfaceData, and MFnSubdData.

MStatus MFnGeometryData::setMatrix ( const MMatrix matrix  ) 

Reset the matrix the the specified matrix and set the identity flag if the new matrix is the identity.

Parameters:
[in]  matrix  the new matrix to be set
Returns:
Status code
Status Codes:

MStatus MFnGeometryData::getMatrix ( MMatrix matrix  )  const

Get the matrix associated with the geometry data.

Parameters:
[out]  matrix  storage for the returned matrix
Returns:
Status code
Status Codes:

bool MFnGeometryData::matrixIsIdentity ( MStatus ReturnStatus = NULL  )  const

Return true if the matrix is the identity.

Parameters:
[out]  ReturnStatus  return status
Returns:
True if the matrix for the geometry is identity, false otherwise
Status Codes:

bool MFnGeometryData::matrixIsNotIdentity ( MStatus ReturnStatus = NULL  )  const

Return true if the matrix is different from identity.

Parameters:
[out]  ReturnStatus  return status
Returns:
True if the matrix for the geometry is NOT the identity, false otherwise
Status Codes:

bool MFnGeometryData::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.

Parameters:
[in]  id  group id.
[out]  ReturnStatus  return status
Returns:
True is there is an object group with the given id, false otherwise
Status Codes:

MStatus MFnGeometryData::addObjectGroup ( unsigned int  id  ) 

This method adds an object group to the object with the given id.

Parameters:
[in]  id  group id.
Returns:
Status code
Status Codes:

MStatus MFnGeometryData::removeObjectGroup ( unsigned int  id  ) 

This method removes an object group with the given id from the object.

Parameters:
[in]  id  group id.
Returns:
Status code
Status Codes:

MStatus MFnGeometryData::changeObjectGroupId ( unsigned int  sourceId,
unsigned int  destId  
)

This method changes the id of the object group with the given id to the new id.

Parameters:
[in]  sourceId  id to change
[in]  destId  new id to set
Returns:
Status code
Status Codes:

unsigned int MFnGeometryData::objectGroupCount ( MStatus ReturnStatus = NULL  )  const

This method returns the number of object groups contained by the object.

Parameters:
[out]  ReturnStatus  return status
Returns:
The number of object groups
Status Codes:

unsigned int MFnGeometryData::objectGroup ( unsigned int  index,
MStatus ReturnStatus = NULL  
) const

This method returns the id of the i'th object group contained by the object.

Parameters:
[out]  index  index in the group array.
[out]  ReturnStatus  return status
Returns:
The id of the i'th object group
Status Codes:

MFn::Type MFnGeometryData::objectGroupType ( unsigned int  id,
MStatus ReturnStatus = NULL  
) const

This method returns the type of the component that the object group with the given id contains.

Parameters:
[in]  id  group id.
[out]  ReturnStatus  return status
Returns:
The type of the specified object group component
Status Codes:

MObject MFnGeometryData::objectGroupComponent ( unsigned int  id,
MStatus ReturnStatus = NULL  
) const

This method returns a component which contains the members of the object group with the given id.

Parameters:
[in]  id  group id.
[out]  ReturnStatus  return status
Returns:
A component containing the members of the specified object group
Status Codes:

MStatus MFnGeometryData::setObjectGroupComponent ( unsigned int  id,
MObject component  
)

This method sets the members of the object group with the given id to be only those in the given component.

Parameters:
[in]  id  id of object group to set
[in]  component  new component for specified object group. The component should be an MObject created from any function set derived from MFnComponent (ie. MFnSingleIndexedComponent, MFnDoubleIndexedComponent, MFnTripleIndexedComponent)
Returns:
Status code
Status Codes:

MStatus MFnGeometryData::addObjectGroupComponent ( unsigned int  id,
MObject component  
)

This method adds the members of the given component to the object group with the given id.

Parameters:
[in]  id  id of object group to add to
[in]  component  new component to be added to the specified object group. The component should be an MObject created from any function set derived from MFnComponent (ie. MFnSingleIndexedComponent, MFnDoubleIndexedComponent, MFnTripleIndexedComponent)
Returns:
Status code
Status Codes:

MStatus MFnGeometryData::removeObjectGroupComponent ( unsigned int  id,
MObject component  
)

This method removes the members of the given Tcomponent to the object group with the given id.

Parameters:
[in]  id  id of object group to be changed
[in]  component  component specifying the members to be removed. The component should be an MObject created from any function set derived from MFnComponent (ie. MFnSingleIndexedComponent, MFnDoubleIndexedComponent, MFnTripleIndexedComponent)
Returns:
Status code
Status Codes:

MStatus MFnGeometryData::copyObjectGroups ( MObject inGeom  ) 

Copies the object groups from the given geometry data object.

Parameters:
[in]  inGeom  the geometry data to be copied
Returns:
Status code
Status Codes:

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