Python API 2.0 Reference
OpenMaya.MArrayDataBuilder Class Reference
+ Inheritance diagram for OpenMaya.MArrayDataBuilder:

Public Member Functions

def __init__ ()
 
def __len__ ()
 
def addElement ()
 
def addElementArray ()
 
def addLast ()
 
def addLastArray ()
 
def copy ()
 
def growArray ()
 
def removeElement ()
 
def setGrowSize ()
 

Static Public Member Functions

def __new__ ()
 

Detailed Description

Array builder for arrays in data blocks.

Constructor & Destructor Documentation

def OpenMaya.MArrayDataBuilder.__init__ ( )
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMaya.MArrayDataBuilder.__len__ ( )
Return len(self).
def OpenMaya.MArrayDataBuilder.__new__ ( )
static
Create and return a new object.  See help(type) for accurate signature.
def OpenMaya.MArrayDataBuilder.addElement ( )
addElement(index) -> MDataHandle

Adds a new element to the array at the given index.

* index (int) - the index at which we wish to add the new element

Returns The handle for the new element
def OpenMaya.MArrayDataBuilder.addElementArray ( )
addElementArray(index) -> MArrayDataHandle

Adds a new element to the array at the given index.  The added element is also an array.

* index (int) - the index at which we wish to add the new element

Returns The handle for the new array element
def OpenMaya.MArrayDataBuilder.addLast ( )
addLast() -> MDataHandle

Adds a new element to the end of the array.  The index of the element will be the current highest index + 1.

Returns The handle for the new element
def OpenMaya.MArrayDataBuilder.addLastArray ( )
addLastArray() -> MArrayDataHandle

Adds a new element to the end of the array.  The added element is also an array.  The index of the element will the current highest index + 1.

Returns The handle for the new array element
def OpenMaya.MArrayDataBuilder.copy ( )
copy(source) -> self

Copy data from source builder.

* source (MArrayDataBuilder) - The source object to copy from
def OpenMaya.MArrayDataBuilder.growArray ( )
growArray(amount) -> self

Grows the array storage by the given amount.

* amount (int) - the amount to grow the array by
def OpenMaya.MArrayDataBuilder.removeElement ( )
removeElement(index) -> self

Removes the specified element from the array

* index (int) - the element of the array to remove
def OpenMaya.MArrayDataBuilder.setGrowSize ( )
setGrowSize(size) -> self

Sets the grow size of the array.  As elements are added to the array, the builder will allocate memory in chunks.  This method tells the builder how many elements to allocate each time it grows the array.

* size (int) - the number of elements to allocate when growing the array