#include
<MFnSingleIndexedComponent.h>
List
of all members.
Detailed Description
Single indexed component function set.
This function set allows you to create, edit, and query single
indexed components. Single indexed components store 1 dimensional
index values.
Constructor & Destructor Documentation
MFnSingleIndexedComponent::MFnSingleIndexedComponent |
( |
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:
-
MFnSingleIndexedComponent::MFnSingleIndexedComponent |
( |
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
MFnSingleIndexedComponent::type |
( |
|
) |
const [virtual] |
const char *
MFnSingleIndexedComponent::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnSingleIndexedComponent"
Reimplemented from MFnComponent.
MStatus
MFnSingleIndexedComponent::addElement |
( |
int |
element |
) |
|
Add the specified element to the component.
- Parameters:
-
[in] |
element |
the element index to be added |
- Returns:
- Status code
- Status Codes:
-
Add the specified elements to the component.
- Parameters:
-
[in] |
elements |
the array of element indices to be added |
- Returns:
- Status code
- Status Codes:
-
int MFnSingleIndexedComponent::element |
( |
int |
index, |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
const |
Returns the specified element from the component.
- Parameters:
-
[in] |
index |
the index of the element to retrieve |
[out] |
ReturnStatus |
status code |
- Returns:
- The index of the specified component
- Status Codes:
-
Get all of the element indices from the component.
- Parameters:
-
[out] |
elements |
storage for the array of indices |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnSingleIndexedComponent::setCompleteData |
( |
int |
numElements |
) |
|
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)).
- Parameters:
-
[in] |
numElements |
the maximum number of elements in the component |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnSingleIndexedComponent::getCompleteData |
( |
int & |
numElements |
) |
const |
Returns the number of elements for the complete component. A
complete component means that all elements are selected.
- Parameters:
-
[out] |
numElements |
storage for the maximum number of elements |
- Returns:
- Status code
- Status Codes:
-