MFnUint64SingleIndexedComponent Class Reference
[OpenMaya - API
module for common classes, FunctionSet classes]
#include
<MFnUint64SingleIndexedComponent.h>
Detailed Description
Single MUint64 indexed component function set.This function set allows you to create, edit, and query single MUint64 indexed components. Single indexed components store 1 dimensional index values, where each value is an MUint64.
Public Member Functions |
|
| virtual MFn::Type | type () const |
| Function set type. |
|
| virtual | ~MFnUint64SingleIndexedComponent () |
| Destructor. |
|
| MFnUint64SingleIndexedComponent () | |
| Default constructor. |
|
| MFnUint64SingleIndexedComponent (MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. |
|
| MObject | create (MFn::Type compType, MStatus *ReturnStatus=NULL) |
| MStatus | addElement (MUint64 element) |
| MStatus | addElements (const MUint64Array &elements) |
| MUint64 | element (int index, MStatus *ReturnStatus=NULL) const |
| MStatus | getElements (MUint64Array &elements) const |
| MStatus | setCompleteData (MUint64 numElements) |
| MStatus | getCompleteData (MUint64 &numElements) const |
| MFnUint64SingleIndexedComponent (const MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. |
|
Protected Member Functions |
|
| virtual const char * | className () const |
| Class name. |
|
Constructor & Destructor Documentation
| MFnUint64SingleIndexedComponent::MFnUint64SingleIndexedComponent | ( | 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:
-
- MS::kSuccess if the function set is successfully attached
- MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
| MFnUint64SingleIndexedComponent::MFnUint64SingleIndexedComponent | ( | 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:
-
- MS::kSuccess if the function set is successfully attached
- MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
Member Function Documentation
| MFn::Type MFnUint64SingleIndexedComponent::type | ( | ) | const [virtual] |
Function set type.
Return the class type : MFn::kUint64SingleIndexedComponent
Reimplemented from MFnComponent.
| const char * MFnUint64SingleIndexedComponent::className | ( | ) | const [protected, virtual] |
Class name.
Return the class name : "MFnUint64SingleIndexedComponent"
Reimplemented from MFnComponent.
| MObject MFnUint64SingleIndexedComponent::create | ( | MFn::Type | compType, | |
| MStatus * | ReturnStatus =
NULL |
|||
| ) |
Create a single indexed component of the given type. Allowable types are
MFn::kSubdivCVComponent MFn::kSubdivEdgeComponent MFn::kSubdivFaceComponent
- Parameters:
-
[in] compType the type of component to create [out] ReturnStatus status code
- Returns:
- The new component
- Status Codes:
-
- MS::kSuccess the method was successful.
- MS::kInvalidParameter invalid component type
| MStatus MFnUint64SingleIndexedComponent::addElement | ( | MUint64 | element | ) |
Add the specified element to the component.
- Parameters:
-
[in] element the element index to be added
- Returns:
- Status code
- Status Codes:
-
- MS::kSuccess the method was successful
- MS::kFailure an object error has occurred
| MStatus MFnUint64SingleIndexedComponent::addElements | ( | const MUint64Array & | elements | ) |
Add the specified elements to the component.
- Parameters:
-
[in] elements the array of element indices to be added
- Returns:
- Status code
- Status Codes:
-
- MS::kSuccess the method was successful
- MS::kFailure an object error has occurred
| MUint64 MFnUint64SingleIndexedComponent::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:
-
- MS::kSuccess the method was successful
- MS::kFailure an object error has occurred
| MStatus MFnUint64SingleIndexedComponent::getElements | ( | MUint64Array & | elements | ) | const |
Get all of the element indices from the component.
- Parameters:
-
[in] elements storage for the array of indices
- Returns:
- Status code
- Status Codes:
-
- MS::kSuccess the method was successful
- MS::kFailure an object error has occurred
| MStatus MFnUint64SingleIndexedComponent::setCompleteData | ( | MUint64 | 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:
-
- MS::kSuccess the method was successful
- MS::kFailure an object error has occurred
| MStatus MFnUint64SingleIndexedComponent::getCompleteData | ( | MUint64 & | 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:
-
- MS::kSuccess the method was successful
- MS::kFailure an object error has occurred
