Package autodesk_toxik :: Module graph :: Class MultiInput

Class MultiInput

 object --+            
          |            
Boost.Python.instance --+        
              |        
         Socket --+    
                  |    
              Input --+
                      |
                     MultiInput

Multi-valued input. An input socket that represents a vector of other input sockets of the same data type.

Instance Methods

__getitem__(...)

Input

addInput(...)
Creates and adds an input to the inputs vector and returns it.

connect(...)
Connect this input to the specified output.

disconnect(...)
Disconnect all the inputs in the vector.

int

getInputIndex(...)
Returns: The position of the given input in the vector or -1 if the given input cannot be found.

[Input]

getInputs(...)
Returns: A list of the inputs in the vector.

int

getNbInputs(...)
Returns: The number of inputs in the socket vector.

Input

insertInput(...)
Inserts a new input into the inputs vector before the given input.

moveInput(...)
Moves an input in the inputs vector before the given input.

removeInput(...)
Remove the specified input from the inputs vector.

Input

retrieveInput(...)
Returns: The input in the vector at the specified index.

Inherited from Input: __rshift__, getInputPolicy, getOutput, getOwnerInput

Inherited from Socket: __cmp__, __init__, __reduce__, getDataType, getDirection, getGraph, getId, getLayout, getLifeScope, getName, getNode, getQualifiedName, isConnected, setName

Inherited from Boost.Python.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

addInput(...)

Creates and adds an input to the inputs vector and returns it.

Returns: Input: The new input.

connect(...)

Connect this input to the specified output. This is a special connect method that is aware of the multivalued input connection.

Parameters:

output (Output)

Overrides: Input.connect

disconnect(...)

Disconnect all the inputs in the vector.

Overrides: Input.disconnect

getInputIndex(...)

Parameters:

input (Input) - Input to find.

Returns: int

The position of the given input in the vector or -1 if the given input cannot be found.

getInputs(...)

Returns: [Input]: A list of the inputs in the vector.

getNbInputs(...)

Returns: int: The number of inputs in the socket vector.

insertInput(...)

Inserts a new input into the inputs vector before the given input. The input is inserted at the end of the vector if the given input is None.

Parameters:

beforeInput (Input) - Input to insert the new input before or None to insert at the end.

Returns: Input

The new input.

moveInput(...)

Moves an input in the inputs vector before the given input. The input is moved to the end of the vector if the given input is None.

Parameters:

movedInput (Input) - Input to move.
beforeInput (Input) - Input is moved before this input or to the end if set to None.

removeInput(...)

Remove the specified input from the inputs vector.

Parameters:

input (Input)

retrieveInput(...)

Parameters:

index (int) - Index of input to retrieve.

Returns: Input

The input in the vector at the specified index.