General Module Function
The loop module iterates an operation. For example, you could use a loop object to control the movement of an object in your application; such as incrementing the movement of a slider for a slice plane.
Module Input Ports
This module has five input ports which accept other loop counter information. From left to right they are:
Start
End
Increment
count
done
Module Output Ports
The output ports are identical to the input ports.
Module Control Panel
The user interface for loop is shown above.
The Run toggle when set will kick off an iteration of the loop. It is reset to off when it is finished.
The Step toggle will make one increment of the loop as specified int the Increment type-in.
Reset, when toggled, resets the count subobject to the value of the start_val subobject. This value is reset to off right after it is changed.
The Run Backwards, Step Backwards and Reset Back are self explanatory.
The Cycle Options allow for Once (one iteration), Cycle (keep running from beginning), and Bounce (run to end, then backwards, then forwards, etc.)
The Loop count is updated during running of the module, but the user may jump to any part of the specified iteration by typing in a valid value. It is available as a slider and a type-in. The slider is particularly useful as you can control the output of loop by moving it in real-time.
Start Value indicates the starting value of the iteration and refers to the slider value of the module to which loop is outputting.
End Value indicates the ending value of the iteration and refers to the slider value of the module to which loop is outputting.
Increment indicates the interval at which to count from the starting value to the ending value. For example, to move a slice plane in 10 steps from -50.0 (Start Value) to 40.0 (End Value) the user would choose an increment of 10.00. These increments may have non-integer values.