C++ API Reference
|
Double indexed component function set. More...
#include <MFnDoubleIndexedComponent.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. More... | |
virtual | ~MFnDoubleIndexedComponent () |
Destructor. | |
MFnDoubleIndexedComponent () | |
Default constructor. | |
MFnDoubleIndexedComponent (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MObject | create (MFn::Type compType, MStatus *ReturnStatus=NULL) |
Create a double indexed component of the given type. More... | |
MStatus | addElement (int uIndex, int vIndex) |
Add the specified element to the component. More... | |
MStatus | addElements (const MIntArray &uIndexArray, const MIntArray &vIndexArray) |
Add the specified elements to the component. More... | |
MStatus | getElement (int index, int &uIndex, int &vIndex) const |
Get the specified element from the component. More... | |
MStatus | getElements (MIntArray &uIndexArray, MIntArray &vIndexArray) const |
Get all of the element indices from the component. More... | |
MStatus | setCompleteData (int maxU, int maxV) |
Marks the component as complete (meaning all items are selected) and uses the argument to identify the total number of elements selected. More... | |
MStatus | getCompleteData (int &maxU, int &maxV) const |
Returns the number of elements for the complete component. More... | |
MFnDoubleIndexedComponent (const MObject &object, MStatus *ReturnStatus=NULL) | |
NO SCRIPT SUPPORT. More... | |
Public Member Functions inherited from MFnComponent | |
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 MFnComponent | |
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... | |
Double indexed component function set.
This function set allows you to create, edit, and query double indexed components. Double indexed components store 2 dimensional index values.
MFnDoubleIndexedComponent | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnDoubleIndexedComponent | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kDoubleIndexedComponent.
Reimplemented from MFnComponent.
|
static |
Returns the name of this class.
Return the class name : "MFnDoubleIndexedComponent".
Create a double indexed component of the given type.
Allowable types are
MFn::kSurfaceCVComponent MFn::kSurfaceEPComponent MFn::kSurfaceKnotComponent MFn::kMeshVtxFaceComponent
[in] | compType | the type of component to create |
[out] | ReturnStatus | status code |
MStatus addElement | ( | int | uIndex, |
int | vIndex | ||
) |
Add the specified element to the component.
[in] | uIndex | the u index to add |
[in] | vIndex | the v index to add |
Add the specified elements to the component.
[in] | uIndices | the array of u indices to be added |
[in] | vIndices | the array of v indices to be added |
MStatus getElement | ( | int | index, |
int & | uIndex, | ||
int & | vIndex | ||
) | const |
Get the specified element from the component.
[in] | index | the index of the element to retrieve |
[out] | uIndex | the u index of the component |
[out] | vIndex | the v index of the component |
Get all of the element indices from the component.
[out] | uIndices | storage for the array of u indices |
[out] | vIndices | storage for the array of v indices |
MStatus setCompleteData | ( | int | maxU, |
int | maxV | ||
) |
Marks the component as complete (meaning all items are selected) and uses the argument to identify the total number of elements selected.
If the component should contain N element indices, then the range would be [0,N-1].
Also sets the complete state of the component to 'true' (i.e. setComplete(true)).
[in] | maxU | the maximum number of U elements |
[in] | maxV | the maximum number of V elements |
MStatus getCompleteData | ( | int & | maxU, |
int & | maxV | ||
) | const |
Returns the number of elements for the complete component.
A complete component means that all elements are selected.
[out] | maxU | storage for the maximum number of U elements |
[out] | maxV | storage for the maximum number of V elements |