Python API 2.0 Reference: OpenMaya.MFnSingleIndexedComponent Class Reference

OpenMaya.MFnSingleIndexedComponent Class Reference
+ Inheritance diagram for OpenMaya.MFnSingleIndexedComponent:

Public Member Functions

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

Properties

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

Detailed Description

This function set allows you to create, edit, and query single indexed components.
Single indexed components store 1 dimensional index values.

__init__()
Initializes a new, empty MFnSingleIndexedComponent object

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

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

Base Class

MFnComponent

 


Constructor & Destructor Documentation

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

Member Function Documentation

OpenMaya.MFnSingleIndexedComponent.addElement ( )
addElement(int element) -> self

Adds the specified element to the component.
OpenMaya.MFnSingleIndexedComponent.addElements ( )
addElements([int]) -> self
addElements(MIntArray) -> self

Adds the specified elements to the component.
OpenMaya.MFnSingleIndexedComponent.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.MFnSingleIndexedComponent.element ( )
element(index) -> int

Returns the index'th element of the component.
OpenMaya.MFnSingleIndexedComponent.getCompleteData ( )
getCompleteData() -> int

Returns the number of elements in the complete component, or 0 if the component is not complete.
OpenMaya.MFnSingleIndexedComponent.getElements ( )
getElements() -> MIntArray

Returns all of the component's elements.
OpenMaya.MFnSingleIndexedComponent.setCompleteData ( )
setCompleteData(numElements) -> self

Marks the component as complete (i.e. contains all possible elements).
numElements indicates the number of elements in the complete component.

Property Documentation

OpenMaya.MFnSingleIndexedComponent.elementMax
static
 Biggest element plus 1 in the component.