Public Member Functions | Protected Member Functions

MFnSingleIndexedComponent Class Reference

This reference page is linked to from the following overview topics: Components.


Search for all occurrences

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.

Examples:

apiMeshData.cpp, apiMeshShape.cpp, apiMeshShapeUI.cpp, apiSimpleShapeUI.cpp, meshOpCmd.cpp, meshOpNode.cpp, OpenGLViewportRenderer.cpp, splitUVCmd.cpp, and splitUVNode.cpp.

#include <MFnSingleIndexedComponent.h>

Inheritance diagram for MFnSingleIndexedComponent:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnSingleIndexedComponent ()
 Destructor.
 MFnSingleIndexedComponent ()
 Default constructor.
 MFnSingleIndexedComponent (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (MFn::Type compType, MStatus *ReturnStatus=NULL)
 Create a single indexed component of the given type.
MStatus addElement (int element)
 Add the specified element to the component.
MStatus addElements (MIntArray &elements)
 Add the specified elements to the component.
int element (int index, MStatus *ReturnStatus=NULL) const
 Returns the specified element from the component.
MStatus getElements (MIntArray &elements) const
 Get all of the element indices from the component.
MStatus 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.
MStatus getCompleteData (int &numElements) const
 Returns the number of elements for the complete component.
 MFnSingleIndexedComponent (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnSingleIndexedComponent ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnSingleIndexedComponent ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kSingleIndexedComponent.

Reimplemented from MFnComponent.

const char * className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnSingleIndexedComponent".

Reimplemented from MFnComponent.

MObject create ( MFn::Type  compType,
MStatus ReturnStatus = NULL 
)

Create a single indexed component of the given type.

Allowable types are

MFn::kCurveCVComponent MFn::kCurveEPComponent MFn::kCurveKnotComponent MFn::kMeshEdgeComponent MFn::kMeshPolygonComponent MFn::kMeshVertComponent MFn::kMeshMapComponent

Parameters:
[in]compTypethe type of component to create
[out]ReturnStatusstatus code
Returns:
The new component
Status Codes:
Examples:
apiMeshShape.cpp, apiMeshShapeUI.cpp, apiSimpleShapeUI.cpp, OpenGLViewportRenderer.cpp, and splitUVCmd.cpp.
MStatus addElement ( int  element)

Add the specified element to the component.

Parameters:
[in]elementthe element index to be added
Returns:
Status code
Status Codes:
Examples:
apiMeshShape.cpp, apiMeshShapeUI.cpp, apiSimpleShapeUI.cpp, and OpenGLViewportRenderer.cpp.
MStatus addElements ( MIntArray elements)

Add the specified elements to the component.

Parameters:
[in]elementsthe array of element indices to be added
Returns:
Status code
Status Codes:
Examples:
splitUVCmd.cpp.
int element ( int  index,
MStatus ReturnStatus = NULL 
) const

Returns the specified element from the component.

Parameters:
[in]indexthe index of the element to retrieve
[out]ReturnStatusstatus code
Returns:
The index of the specified component
Status Codes:
MStatus getElements ( MIntArray elements) const

Get all of the element indices from the component.

Parameters:
[out]elementsstorage for the array of indices
Returns:
Status code
Status Codes:
MStatus 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]numElementsthe maximum number of elements in the component
Returns:
Status code
Status Codes:
Examples:
apiMeshShape.cpp.
MStatus getCompleteData ( int &  numElements) const

Returns the number of elements for the complete component.

A complete component means that all elements are selected.

Parameters:
[out]numElementsstorage for the maximum number of elements
Returns:
Status code
Status Codes:

MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent
MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent MFnSingleIndexedComponent