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

Class ModSeq

source code

The ModSeq object

This object provides access to list of modifiers for a particular object. Only accessed from Object.Object.modifiers.

Instance Methods [hide private]
Modifier
__getitem__(index)
This operator returns one of the object's modifiers.
source code
int
__len__()
Returns the number of modifiers in the object's modifier stack.
source code
Modifier
append(type)
Appends a new modifier to the end of the object's modifier stack.
source code
 
remove(modifier)
Remove a modifier from this objects modifier sequence.
source code
None
moveUp(modifier)
Moves the modifier up in the object's modifier stack.
source code
None
moveDown(modifier)
Moves the modifier down in the object's modifier stack.
source code
Method Details [hide private]

__getitem__(index)
(Indexing operator)

source code 

This operator returns one of the object's modifiers.

Parameters:
  • index (int)
Returns: Modifier
an Modifier object
Raises:
  • KeyError - index was out of range

__len__()
(Length operator)

source code 

Returns the number of modifiers in the object's modifier stack.

Returns: int
number of Modifiers

append(type)

source code 

Appends a new modifier to the end of the object's modifier stack.

Parameters:
  • type (a constant specifying the type of modifier to create. as from Types)
Returns: Modifier
the new Modifier

remove(modifier)

source code 

Remove a modifier from this objects modifier sequence.

Parameters:
  • modifier (a modifier from this sequence to remove.)

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

moveUp(modifier)

source code 

Moves the modifier up in the object's modifier stack.

Parameters:
  • modifier (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.

moveDown(modifier)

source code 

Moves the modifier down in the object's modifier stack.

Parameters:
  • modifier (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.