C++ API Reference
|
Base class for component function sets. More...
#include <MFnComponent.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. More... | |
virtual | ~MFnComponent () |
Destructor. | |
MFnComponent (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MFnComponent () | |
Default class constructor. | |
int | elementCount (MStatus *ReturnStatus=NULL) const |
Returns the number of elements that this component contains. More... | |
MFn::Type | componentType (MStatus *ReturnStatus=NULL) const |
Returns the MFn type of the component. More... | |
bool | isEmpty (MStatus *ReturnStatus=NULL) const |
Determines if this component is empty, i.e. More... | |
bool | isEqual (MObject &, MStatus *ReturnStatus=NULL) const |
Compares this component with the given component. More... | |
bool | isComplete (MStatus *ReturnStatus=NULL) const |
Returns the complete state of the component. More... | |
MStatus | setComplete (bool) |
Sets the complete state of the component. More... | |
bool | hasWeights () const |
Query this component for the existance of attached weight data. More... | |
MWeight | weight (int index, MStatus *ReturnStatus=NULL) const |
Return the weight data for a given element within this component. More... | |
MStatus | setWeight (int index, const MWeight &weight) |
Set the weight data for a given element within this component. More... | |
MStatus | setWeights (const MWeight &weight) |
Set the weight data for all elements within this component. More... | |
MFnComponent (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MFn::Type | type (MStatus *ReturnStatus=NULL) |
This method is obsolete. 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 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... | |
Base class for component function sets.
This is the base class for all function sets which deal with component objects.
Components are MObjects which hold index information for shapes. The component object does not contain any information about the shape, it just contains index values and type information.
Components can be marked as complete meaning that the component represents a complete set of indices from 0 to numElements-1;
Components come is 3 varieties based upon the dimensions of the index. The types are single, double, and triple indexed. Examples of these types are mesh vertices (single indexed), nurbs surface CVs (double indexed), and lattice points (triple indexed).
To create, edit, or query a specific type of component, use the derived classes MFnSingleIndexedComponent, MFnDoubleIndexedComponent, and MFnTripleIndexedComponent.
MFnComponent | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnComponent | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kComponent.
Reimplemented from MFnBase.
Reimplemented in MFnDoubleIndexedComponent, MFnSingleIndexedComponent, MFnTripleIndexedComponent, and MFnUint64SingleIndexedComponent.
|
static |
Returns the name of this class.
Return the class name : "MFnComponent".
int elementCount | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the number of elements that this component contains.
[out] | ReturnStatus | Status code |
Returns the MFn type of the component.
[out] | ReturnStatus | Status code |
bool isEmpty | ( | MStatus * | ReturnStatus = NULL | ) | const |
Determines if this component is empty, i.e.
there are no index elements.
[out] | ReturnStatus | Status code |
Compares this component with the given component.
[in] | component | component to compare |
[out] | ReturnStatus | Status code |
bool isComplete | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the complete state of the component.
Components can be marked as complete meaning that the component represents a complete set of indices from 0 to numElements-1;
[out] | ReturnStatus | Status code |
MStatus setComplete | ( | bool | complete | ) |
Sets the complete state of the component.
Components can be marked as complete meaning that the component represents a complete set of indices from 0 to numElements-1;
Important: if the component is set as complete, setCompleteData must also be called with the appropriate parameter (the total number of elements in the object). Note that setCompleteData(...) also sets the component as complete, thus 'setComplete(true)' may never need to appear in your code.
setCompleteData(...) is defined in derived classes.
[in] | complete | true sets the component as complete |
bool hasWeights | ( | ) | const |
Query this component for the existance of attached weight data.
Weight data will be added to a component as part of soft selection and/or symmetry. Note that this method does not test for the existance of external weight information (e.g. deformer weights stored in separate attributes).
Return the weight data for a given element within this component.
Note that this method does not return external weight data (e.g. deformer weights stored in separate attributes).
[in] | index | The element to return weight data for (note that this is the linear index between 0 and elementCount()-1) |
[out] | ReturnStatus | Status code |
Set the weight data for a given element within this component.
[in] | index | The element to set weight data for (note that this is the linear index between 0 and elementCount()-1) |
[in] | weight | The new weight for the element |
Set the weight data for all elements within this component.
[in] | weight | The new weight for all element |
This method is obsolete.
This method is not available in Python.
[as of Maya 2019]
[out] | ReturnStatus | Return status. |