Module Modifier :: Class ModSeq
[frames | no frames]

Class ModSeq


The ModSeq object

This object provides access to list of modifiers for a particular object. Only accessed from Object.Object.modifiers.
Method Summary
Modifier __getitem__(index)
This operator returns one of the object's modifiers.
int __len__()
Returns the number of modifiers in the object's modifier stack.
Modifier append(type)
Appends a new modifier to the end of the object's modifier stack.
None moveDown(modifier)
Moves the modifier down in the object's modifier stack.
None moveUp(modifier)
Moves the modifier up in the object's modifier stack.
  remove(modifier)
Remove a modifier from this objects modifier sequence.

Method Details

__getitem__(index)
(Indexing operator)

This operator returns one of the object's modifiers.
Parameters:
index
           (type=int)
Returns:
an Modifier object
           (type=Modifier)
Raises:
KeyError - index was out of range

__len__()
(Length operator)

Returns the number of modifiers in the object's modifier stack.
Returns:
number of Modifiers
           (type=int)

append(type)

Appends a new modifier to the end of the object's modifier stack.
Parameters:
type
           (type=a constant specifying the type of modifier to create. as from Types)
Returns:
the new Modifier
           (type=Modifier)

moveDown(modifier)

Moves the modifier down in the object's modifier stack.
Parameters:
modifier
           (type=a modifier from this sequence to remove.)
Returns:
None
Raises:
RuntimeError - request to move modifier beyond a non-deforming modifier

Note: Accessing attributes of the modifier after removing will raise an error.

moveUp(modifier)

Moves the modifier up in the object's modifier stack.
Parameters:
modifier
           (type=a modifier from this sequence to remove.)
Returns:
None
Raises:
RuntimeError - request to move above another modifier requiring original data

Note: Accessing attributes of the modifier after removing will raise an error.

remove(modifier)

Remove a modifier from this objects modifier sequence.
Parameters:
modifier
           (type=a modifier from this sequence to remove.)

Note: Accessing attributes of the modifier after removing will raise an error.


Generated by Epydoc 2.1 on Sun Feb 11 13:30:19 2007 http://epydoc.sf.net