Public Member Functions | Protected Member Functions

MFnGeometryData Class Reference

Search for all occurrences

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.

#include <MFnGeometryData.h>

Inheritance diagram for MFnGeometryData:
Inheritance graph
[legend]

List of all members.

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 &)
 Reset the matrix the the specified matrix and set the identity flag if the new matrix is the identity.
MStatus getMatrix (MMatrix &) const
 Get the matrix associated with the geometry data.
bool matrixIsIdentity (MStatus *ReturnStatus=NULL) const
 Return true if the matrix is the identity.
bool matrixIsNotIdentity (MStatus *ReturnStatus=NULL) const
 Return true if the matrix is different from identity.
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.
MStatus addObjectGroup (unsigned int)
 This method adds an object group with the given id to the object.
MStatus removeObjectGroup (unsigned int)
 This method removes an object group with the given id from the object.
MStatus changeObjectGroupId (unsigned int, unsigned int)
 This method changes the id of the object group with the given id to the new id.
unsigned int objectGroupCount (MStatus *ReturnStatus=NULL) const
 This method returns the number of object groups contained by the object.
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.
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.
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.
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.
MStatus addObjectGroupComponent (unsigned int, MObject &)
 This method adds the members of the given component to the object group with the given id.
MStatus removeObjectGroupComponent (unsigned int, MObject &)
 This method removes the members of the given component from the object group with the given id.
MStatus copyObjectGroups (MObject &inGeom)
 Copies the object groups from the given geometry data object.
 MFnGeometryData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

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

Reimplemented from MFnData.

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

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

Class name.

Return the class name : "MFnGeometryData".

Reimplemented from MFnData.

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

MStatus 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]matrixthe new matrix to be set
Returns:
Status code
Status Codes:
MStatus getMatrix ( MMatrix matrix) const

Get the matrix associated with the geometry data.

Parameters:
[out]matrixstorage for the returned matrix
Returns:
Status code
Status Codes:
bool matrixIsIdentity ( MStatus ReturnStatus = NULL) const

Return true if the matrix is the identity.

Parameters:
[out]ReturnStatusreturn status
Returns:
True if the matrix for the geometry is identity, false otherwise
Status Codes:
bool matrixIsNotIdentity ( MStatus ReturnStatus = NULL) const

Return true if the matrix is different from identity.

Parameters:
[out]ReturnStatusreturn status
Returns:
True if the matrix for the geometry is NOT the identity, false otherwise
Status Codes:
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.

Parameters:
[in]idgroup id.
[out]ReturnStatusreturn status
Returns:
True is there is an object group with the given id, false otherwise
Status Codes:
MStatus addObjectGroup ( unsigned int  id)

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

Parameters:
[in]idgroup id.
Returns:
Status code
Status Codes:
MStatus removeObjectGroup ( unsigned int  id)

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

Parameters:
[in]idgroup id.
Returns:
Status code
Status Codes:
MStatus 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]sourceIdid to change
[in]destIdnew id to set
Returns:
Status code
Status Codes:
unsigned int objectGroupCount ( MStatus ReturnStatus = NULL) const

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

Parameters:
[out]ReturnStatusreturn status
Returns:
The number of object groups
Status Codes:
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.

Parameters:
[out]indexindex in the group array.
[out]ReturnStatusreturn status
Returns:
The id of the i'th object group
Status Codes:
MFn::Type 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]idgroup id.
[out]ReturnStatusreturn status
Returns:
The type of the specified object group component
Status Codes:
MObject 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]idgroup id.
[out]ReturnStatusreturn status
Returns:
A component containing the members of the specified object group
Status Codes:
MStatus 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]idid of object group to set
[in]componentnew 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 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]idid of object group to add to
[in]componentnew 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 removeObjectGroupComponent ( unsigned int  id,
MObject component 
)

This method removes the members of the given component from the object group with the given id.

Parameters:
[in]idid of object group to be changed
[in]componentcomponent 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 copyObjectGroups ( MObject inGeom)

Copies the object groups from the given geometry data object.

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

MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData
MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData MFnGeometryData