Python API 2.0 Reference: OpenMaya.MFnTripleIndexedComponent Class Reference

OpenMaya.MFnTripleIndexedComponent Class Reference
+ Related help topics:
+ Inheritance diagram for OpenMaya.MFnTripleIndexedComponent:

Public Member Functions

__init__ ()
 
addElement ()
 
addElements ()
 
create ()
 
getCompleteData ()
 
getElement ()
 
getElements ()
 
setCompleteData ()
 
- Public Member Functions inherited from OpenMaya.MFnComponent
__init__ ()
 
isEqual ()
 
weight ()
 
- Public Member Functions inherited from OpenMaya.MFnBase
__init__ ()
 
hasObj ()
 
object ()
 
setObject ()
 
type ()
 

Additional Inherited Members

- Properties inherited from OpenMaya.MFnComponent
 componentType
 
 elementCount
 
 hasWeights
 
 isComplete
 
 isEmpty
 

Detailed Description

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

__init__()
Initializes a new, empty MFnTripleIndexedComponent object

__init__(MObject component)
Initializes a new MFnTripleIndexedComponent function set, attached
to the specified component.

Method resolution order:
-   MFnTripleIndexedComponent
-   MFnComponent
-   MFnBase
-   __builtin__.object

Base Class

MFnComponent

 


Constructor & Destructor Documentation

OpenMaya.MFnTripleIndexedComponent.__init__ ( )
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Member Function Documentation

OpenMaya.MFnTripleIndexedComponent.addElement ( )
addElement(sIndex, tIndex, uIndex) -> self
addElement([sIndex, tIndex, uIndex]) -> self

Adds the element identified by (sIndex, tIndex, uIndex) to the component.
OpenMaya.MFnTripleIndexedComponent.addElements ( )
addElements(sequence of [sIndex, tIndex, uIndex]) -> self

Adds the specified elements to the component. Each item in the
elements sequence is itself a sequence of three ints which are the
S, T and U indices of an element to be added.
OpenMaya.MFnTripleIndexedComponent.create ( )
create(MFn Type constant) -> MObject

Creates a new, empty component, attaches it to the function set and
returns an MObject which references it.
OpenMaya.MFnTripleIndexedComponent.getCompleteData ( )
getCompleteData() -> (numS, numT, numU)

Returns a tuple containing the number of S, T and U indices in
the complete component, or (0,0,0) if the component is not complete.
OpenMaya.MFnTripleIndexedComponent.getElement ( )
getElement(index) -> (sIndex, tIndex, uIndex)

Returns the index'th element of the component as a tuple containing the
element's S, T and U indices.
OpenMaya.MFnTripleIndexedComponent.getElements ( )
getElements() -> list of (sIndex, tIndex, uIndex)

Returns all of the component's elements as a list of tuples with each
tuple containing the S, T and U indices of a single element.
OpenMaya.MFnTripleIndexedComponent.setCompleteData ( )
setCompleteData(numS, numT, numU) -> self

Marks the component as complete (i.e. contains all possible elements).
numS, numT and numU indicate the number of S, T and U indices
in the complete component (i.e. the max S index is numS-1, the max T
index is numT-1 and the max U index is numU-1).