Sequences

Subsections of Sequences

driven sequence

The driven sequence module controls the semi-automatic creation of sequences for modules that support sequence driving, such as slice, cut, plume, and plume shell. Control over these modules is via the purple Sequence Output ports on the driven modules and the Sequence Input port on driven sequence.

All modules to be grouped in the sequence must have their red output ports connected to driven sequence instead of the viewer. In this way, driven sequence acts like a group objects module.

Other modules not listed above may be included if one of the driven modules controls those modules. Examples include titles, isolines, and band data.

The driven modules have the bulk of the settings which determine what controls and states will be available, such as Use Sequencing (which must be enabled), State Control type (Slider, Combo Box, or List Box), and Sequence Type (By Count or By Step Size). State titles are automatically generated.

Ports

DirectionNameTypeDescription
InputSequence InputSequenceThe sequence to drive with this module.
InputInput ObjectsRenderableAny number of renderable objects to transform.
OutputCurrent State TitleStringText containing the title of the current state.
OutputOutput ObjectRenderableA renderable object displaying the transformed group.

Properties

PropertyTypeDescription
Allow RunBooleanDetermines whether the module is allowed to execute. Set to True to allow this module to run.
Current StateChoiceThe current state to be passed to the script.
VisibilityBooleanThe Visibility toggle will turn on or off the visible state of the output objects.
Favorite In ExportBooleanInclude this sequence as a favorite when exporting to web scenes.

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:

  1. Determine which modules’ output will be affected (controlled) by the Python script and therefore contained in one or more states.
  2. Connect the red output ports of those modules to scripted sequence instead of the viewer.
  3. Set the number of states and their names. This can be done manually or in a secondary Python script.
  4. Choose and set the State Control type (Slider, Combo Box, or List Box).
  5. Create and test the Python script which will control all modules, which must be set under Filename.

Ports

DirectionNameTypeDescription
InputInput ObjectsRenderableAny number of renderable objects to transform.
InputInput Value N1NumberA value to use as a variable.
InputInput Value N2NumberA value to use as a variable.
InputInput Value N3NumberA value to use as a variable.
InputInput Value N4NumberA value to use as a variable.
OutputOutput Value N1NumberA value to use as a variable.
OutputOutput Value N2NumberA value to use as a variable.
OutputOutput Value N3NumberA value to use as a variable.
OutputOutput Value N4NumberA value to use as a variable.
OutputCurrent State TitleStringText containing the title of the current state.
OutputOutput ObjectRenderableA renderable object displaying the transformed group.

Properties

PropertyTypeDescription
Allow RunBooleanDetermines whether the module is allowed to execute. Set to True to allow this module to run.
FilenameStringThe script which is run to set the current state contents.
ExecuteButtonAccept 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 StateChoiceThe current state to be passed to the script.
VisibilityBooleanThe Visibility toggle will turn on or off the visible state of the output objects.
Favorite In ExportBooleanInclude this sequence as a favorite when exporting to web scenes.

Sequence Options

PropertyTypeDescription
State ControlChoice: Slider, Combo Box, List BoxDetermines which style of control is used for selecting the current state.
Allow CyclesBooleanAllows the state control to be cycled in CTWS files.
State NamesStringThe names of each state used in the UI.

Variables

PropertyTypeDescription
Available VariablesStringThe variables available to use to set the values during computation.
N1DoubleNumber passed into script.
N2DoubleNumber passed into script.
N3DoubleNumber passed into script.
N4DoubleNumber passed into script.

object sequence

The object sequence module is the simplest of the sequence modules. You create states by connecting modules (including groups) to the input port. Each connected object becomes an individual state in the sequence. This module works much like a group objects module, in that you can rearrange the order of the modules within, each of which creates a state named with that module’s (or group’s) name.

Ports

DirectionNameTypeDescription
InputInput ObjectsRenderableAny number of renderable objects to transform.
OutputCurrent State TitleStringText containing the title of the current state.
OutputOutput ObjectRenderableA renderable object displaying the transformed group.

Properties

PropertyTypeDescription
Current StateChoiceThe current state to be passed to the script.
VisibilityBooleanThe Visibility toggle will turn on or off the visible state of the output objects.
Favorite In ExportBooleanInclude this sequence as a favorite when exporting to web scenes.

Sequence Options

PropertyTypeDescription
State ControlChoice: Slider, Combo Box, List BoxDetermines which style of control is used for selecting the current state.
Allow CyclesBooleanAllows the state control to be cycled in CTWS files.