scripted sequence
The scripted sequence module provides the most power and flexibility for creating sequences, but requires creating a Python script which sets the states of all modules contained in the sequence.
The process for using this module is:
- Determine which modules’ output will be affected (controlled) by the Python script and therefore contained in one or more states.
- Connect the red output ports of those modules to scripted sequence instead of the viewer.
- Set the number of states and their names. This can be done manually or in a secondary Python script.
- Choose and set the State Control type (Slider, Combo Box, or List Box).
- Create and test the Python script which will control all modules, which must be set under Filename.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Objects | Renderable | Any number of renderable objects to transform. |
| Input | Input Value N1 | Number | A value to use as a variable. |
| Input | Input Value N2 | Number | A value to use as a variable. |
| Input | Input Value N3 | Number | A value to use as a variable. |
| Input | Input Value N4 | Number | A value to use as a variable. |
| Output | Output Value N1 | Number | A value to use as a variable. |
| Output | Output Value N2 | Number | A value to use as a variable. |
| Output | Output Value N3 | Number | A value to use as a variable. |
| Output | Output Value N4 | Number | A value to use as a variable. |
| Output | Current State Title | String | Text containing the title of the current state. |
| Output | Output Object | Renderable | A renderable object displaying the transformed group. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | Determines whether the module is allowed to execute. Set to True to allow this module to run. |
| Filename | String | The script which is run to set the current state contents. |
| Execute | Button | Accept all values and perform the sequence computation. If this button is clicked and the application saved, the module will run when the application is loaded. |
| Current State | Choice | The current state to be passed to the script. |
| Visibility | Boolean | The Visibility toggle will turn on or off the visible state of the output objects. |
| Favorite In Export | Boolean | Include this sequence as a favorite when exporting to web scenes. |
Sequence Options
| Property | Type | Description |
|---|---|---|
| State Control | Choice: Slider, Combo Box, List Box | Determines which style of control is used for selecting the current state. |
| Allow Cycles | Boolean | Allows the state control to be cycled in CTWS files. |
| State Names | String | The names of each state used in the UI. |
Variables
| Property | Type | Description |
|---|---|---|
| Available Variables | String | The variables available to use to set the values during computation. |
| N1 | Double | Number passed into script. |
| N2 | Double | Number passed into script. |
| N3 | Double | Number passed into script. |
| N4 | Double | Number passed into script. |