#include <MFnGeometryData.h>
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. More... | |
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... | |
MStatus | copyObjectGroups (MObject &inGeom) |
Copies the object groups from the given geometry data object. 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=NULL) 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... | |
Protected Member Functions | |
virtual const char * | className () const |
Class name. More... | |
Additional Inherited Members | |
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, kLast } |
Types of dependency graph data. More... | |
Static Public Member Functions inherited from MFnBase | |
static const char * | className () |
Returns the name of this class. More... | |
MFnGeometryData | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnGeometryData | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kGeometryData.
Reimplemented from MFnData.
Reimplemented in MFnNurbsSurfaceData, MFnNurbsCurveData, MFnSubdData, MFnMeshData, and MFnLatticeData.
|
protectedvirtual |
Class name.
Return the class name : "MFnGeometryData".
Reimplemented from MFnData.
Reimplemented in MFnNurbsSurfaceData, MFnNurbsCurveData, MFnSubdData, MFnMeshData, and MFnLatticeData.
Reset the matrix the the specified matrix and set the identity flag if the new matrix is the identity.
[in] | matrix | the new matrix to be set |
Get the matrix associated with the geometry data.
[out] | matrix | storage for the returned matrix |
bool matrixIsIdentity | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return true if the matrix is the identity.
[out] | ReturnStatus | return status |
bool matrixIsNotIdentity | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return true if the matrix is different from identity.
[out] | ReturnStatus | return status |
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.
[in] | id | group id. |
[out] | ReturnStatus | return status |
MStatus addObjectGroup | ( | unsigned int | id | ) |
This method adds an object group with the given id to the object.
[in] | id | group id. |
MStatus removeObjectGroup | ( | unsigned int | id | ) |
This method removes an object group with the given id from the object.
[in] | id | group id. |
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.
[in] | sourceId | id to change |
[in] | destId | new id to set |
unsigned int objectGroupCount | ( | MStatus * | ReturnStatus = NULL | ) | const |
This method returns the number of object groups contained by the object.
[out] | ReturnStatus | return status |
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.
[out] | index | index in the group array. |
[out] | ReturnStatus | return status |
This method returns the type of the component that the object group with the given id contains.
[in] | id | group id. |
[out] | ReturnStatus | return status |
This method returns a component which contains the members of the object group with the given id.
[in] | id | group id. |
[out] | ReturnStatus | return status |
This method sets the members of the object group with the given id to be only those in the given component.
[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) |
This method adds the members of the given component to the object group with the given id.
[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) |
This method removes the members of the given component from the object group with the given id.
[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) |
Copies the object groups from the given geometry data object.
[in] | inGeom | the geometry data to be copied |