Public Member Functions | Protected Member Functions

MFnTripleIndexedComponent Class Reference

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


Search for all occurrences

Detailed Description

Triple indexed component function set.

This function set allows you to create, edit, and query triple indexed components. Triple indexed components store 3 dimensional index values.

#include <MFnTripleIndexedComponent.h>

Inheritance diagram for MFnTripleIndexedComponent:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnTripleIndexedComponent ()
 Destructor.
 MFnTripleIndexedComponent ()
 Default constructor.
 MFnTripleIndexedComponent (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (MFn::Type compType, MStatus *ReturnStatus=NULL)
 Create a triple indexed component of the given type.
MStatus addElement (int sIndex, int tIndex, int uIndex)
 Add the specified element to the component.
MStatus addElements (const MIntArray &sIndexArray, const MIntArray &tIndexArray, const MIntArray &uIndexArray)
 Add the specified elements to the component.
MStatus getElement (int index, int &sIndex, int &tIndex, int &uIndex) const
 Get the specified element from the component.
MStatus getElements (MIntArray &sIndexArray, MIntArray &tIndexArray, MIntArray &uIndexArray) const
 Get all of the element indices from the component.
MStatus setCompleteData (int maxS, int maxT, int maxU)
 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 &maxS, int &maxT, int &maxU) const
 Returns the number of elements for the complete component.
 MFnTripleIndexedComponent (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnTripleIndexedComponent ( 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:
MFnTripleIndexedComponent ( 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::kTripleIndexedComponent.

Reimplemented from MFnComponent.

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

Class name.

Return the class name : "MFnTripleIndexedComponent".

Reimplemented from MFnComponent.

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

Create a triple indexed component of the given type.

Allowable types are

MFn::kLatticeComponent

Parameters:
[in]compTypethe type of component to create
[out]ReturnStatusstatus code
Returns:
The new component
Status Codes:
MStatus addElement ( int  sIndex,
int  tIndex,
int  uIndex 
)

Add the specified element to the component.

Parameters:
[in]sIndexthe s index to add
[in]tIndexthe t index to add
[in]uIndexthe u index to add
Returns:
Status code
Status Codes:
MStatus addElements ( const MIntArray sIndices,
const MIntArray tIndices,
const MIntArray uIndices 
)

Add the specified elements to the component.

Parameters:
[in]sIndicesthe array of s indices to be added
[in]tIndicesthe array of t indices to be added
[in]uIndicesthe array of u indices to be added
Returns:
Status code
Status Codes:
MStatus getElement ( int  index,
int &  sIndex,
int &  tIndex,
int &  uIndex 
) const

Get the specified element from the component.

Parameters:
[in]indexthe index of the element to retrieve
[out]sIndexthe s index of the component
[out]tIndexthe t index of the component
[out]uIndexthe u index of the component
Returns:
Status code
Status Codes:
MStatus getElements ( MIntArray sIndices,
MIntArray tIndices,
MIntArray uIndices 
) const

Get all of the element indices from the component.

Parameters:
[out]sIndicesstorage for the array of s indices
[out]tIndicesstorage for the array of t indices
[out]uIndicesstorage for the array of u indices
Returns:
Status code
Status Codes:
MStatus setCompleteData ( int  maxS,
int  maxT,
int  maxU 
)

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]maxSthe maximum number of S elements
[in]maxTthe maximum number of T elements
[in]maxUthe maximum number of U elements
Returns:
Status code
Status Codes:
MStatus getCompleteData ( int &  maxS,
int &  maxT,
int &  maxU 
) const

Returns the number of elements for the complete component.

A complete component means that all elements are selected.

Parameters:
[out]maxSstorage for the maximum number of S elements
[out]maxTstorage for the maximum number of T elements
[out]maxUstorage for the maximum number of U elements
Returns:
Status code
Status Codes:

MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent
MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent MFnTripleIndexedComponent