OpenMayaUI.MMaterialArray Class Reference

OpenMayaUI.MMaterialArray Class Reference

Class Description

An array of MMaterial.
+ Inheritance diagram for OpenMayaUI.MMaterialArray:

Public Member Functions

__getitem__ ()
 
__init__ ()
 
__len__ ()
 
append ()
 
clear ()
 
copy ()
 
insert ()
 
remove ()
 
set ()
 
setLength ()
 

Properties

 sizeIncrement
 

Constructor & Destructor Documentation

OpenMayaUI.MMaterialArray.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMayaUI.MMaterialArray.__getitem__ ( )
x.__getitem__(y) <==> x[y]
OpenMayaUI.MMaterialArray.__len__ ( )
x.__len__() <==> len(x)
OpenMayaUI.MMaterialArray.append ( )
append(element) -> self

Adds a new element to the end of the array.

* element (MMaterial) - the value for the new last element.
OpenMayaUI.MMaterialArray.clear ( )
clear() -> self

Clear the contents of the array. After this operation the length will be 0.  This does not change the amount of memory allocated to the array, only the number of valid elements in it.
OpenMayaUI.MMaterialArray.copy ( )
copy(source) -> self

Copy the contents of the source array to this array.

* source (MMaterialArray) - array to copy from.
OpenMayaUI.MMaterialArray.insert ( )
insert(element, index) -> self

Inserts a new value into the array at the given index. The initial element at that index, and all following elements, are shifted towards the last.

* element (MMaterial) - the new value to insert into the array.
* index (int) - the index of the element to set.
OpenMayaUI.MMaterialArray.remove ( )
remove(index) -> self

Removes the element in the array at the given index.

* index (int) - the index of the element to remove.
OpenMayaUI.MMaterialArray.set ( )
set(element, index) -> self

Sets the value of the specified element to the given attribute spec.

* element (MMaterial) - the new value for the specified element.
* index (int) - the index of the element to be set.
OpenMayaUI.MMaterialArray.setLength ( )
setLength(length) -> self

Set the length of the array. This will grow and shrink the array as desired. Elements that are grown have uninitialized values, while those which are shrunk will lose the data contained in the deleted elements

* length (int) - the new size of the array.

Property Documentation

OpenMayaUI.MMaterialArray.sizeIncrement
static
 The size by which the array will be expanded whenever expansion is necessary.