MFnDoubleIndexedComponent Class Reference
[OpenMaya - API module for common classesFunctionSet classes]

#include <MFnDoubleIndexedComponent.h>
Inheritance diagram for MFnDoubleIndexedComponent:
Inheritance graph
[legend]
Collaboration diagram for MFnDoubleIndexedComponent:
Collaboration graph
[legend]

List of all members.


Detailed Description

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.


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnDoubleIndexedComponent ()
  Destructor.
  MFnDoubleIndexedComponent ()
  Default constructor.
  MFnDoubleIndexedComponent (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
MObject  create (MFn::Type compType, MStatus *ReturnStatus=NULL)
MStatus  addElement (int uIndex, int vIndex)
MStatus  addElements (const MIntArray &uIndexArray, const MIntArray &vIndexArray)
MStatus  getElement (int index, int &uIndex, int &vIndex) const
MStatus  getElements (MIntArray &uIndexArray, MIntArray &vIndexArray) const
MStatus  setCompleteData (int maxU, int maxV)
MStatus  getCompleteData (int &maxU, int &maxV) const
  MFnDoubleIndexedComponent (const MObject &object, MStatus *ReturnStatus=NULL)
  NO SCRIPT SUPPORT.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

MFnDoubleIndexedComponent::MFnDoubleIndexedComponent ( 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:

MFnDoubleIndexedComponent::MFnDoubleIndexedComponent ( const MObject object,
MStatus ReturnStatus = NULL  
)

NO SCRIPT SUPPORT.

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 MFnDoubleIndexedComponent::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kDoubleIndexedComponent

Reimplemented from MFnComponent.

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

Class name.

Return the class name : "MFnDoubleIndexedComponent"

Reimplemented from MFnComponent.

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

Create a double indexed component of the given type. Allowable types are

MFn::kSurfaceCVComponent MFn::kSurfaceEPComponent MFn::kSurfaceKnotComponent MFn::kMeshVtxFaceComponent

Parameters:
[in]  compType  the type of component to create
[out]  ReturnStatus  status code
Returns:
The new component
Status Codes:

MStatus MFnDoubleIndexedComponent::addElement ( int  uIndex,
int  vIndex  
)

Add the specified element to the component.

Parameters:
[in]  uIndex  the u index to add
[in]  vIndex  the v index to add
Returns:
Status code
Status Codes:

MStatus MFnDoubleIndexedComponent::addElements ( const MIntArray uIndices,
const MIntArray vIndices  
)

Add the specified elements to the component.

Parameters:
[in]  uIndices  the array of u indices to be added
[in]  vIndices  the array of v indices to be added
Returns:
Status code
Status Codes:

MStatus MFnDoubleIndexedComponent::getElement ( int  index,
int &  uIndex,
int &  vIndex  
) const

Get the specified element from the component.

Parameters:
[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
Returns:
Status code
Status Codes:

MStatus MFnDoubleIndexedComponent::getElements ( MIntArray uIndices,
MIntArray vIndices  
) const

Get all of the element indices from the component.

Parameters:
[out]  uIndices  storage for the array of u indices
[out]  vIndices  storage for the array of v indices
Returns:
Status code
Status Codes:

MStatus MFnDoubleIndexedComponent::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)).

Parameters:
[in]  maxU  the maximum number of U elements
[in]  maxV  the maximum number of V elements
Returns:
Status code
Status Codes:

MStatus MFnDoubleIndexedComponent::getCompleteData ( int &  maxU,
int &  maxV  
) const

Returns the number of elements for the complete component. A complete component means that all elements are selected.

Parameters:
[out]  maxU  storage for the maximum number of U elements
[out]  maxV  storage for the maximum number of V elements
Returns:
Status code
Status Codes:

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6