Interfaces
Interfaces define the inputs and outputs of the CGI Application. Depending on the module type either one or both types of interfaces are available.
By selecting the corresponding tab, interfaces can be added, removed or rearranged using the buttons at the top of the interface list.
General Properties
The following general properties are available for all interfaces.
Property Name
Description
Name Name of the interface. Only characters from ‘a’-‘z’, ‘A’-Z’, ‘0’-‘9’, ‘ ‘ and ‘_’ are allowed, though the name must start with a character. UId The UId is used to identify the interface. It can be seen as the tooltip of the ‘UId’ button. When the button is clicked a new UId will be generated. Type Defines the type of interface. The available options depend on the specific target tool. Data-TypeThe used basic data type of the interface to transfer data. This value is automatically calculated depending on the used interface type and set properties.
For arrays the length is indicated in brackets.
Types
The following general interface types are available.
Input:
Output:
Note that depending on the used module type, some interface types might not be available or special interface types might be supported. Please refer to the target tool specific section for more details.
Scene Interface
The Scene interface allows to control the state of a scene or group of scenes. Depending on the set value the scene/scenes will change to a different state. By default, the values have the following meaning:
Property Name
Description
0 Destroyed (No data loaded) 1 Loaded (Scene data is loaded to system memory) 2 Uploaded (Scene data is uploaded to VRAM) 3Active (Scene and related behaviors are updated)
Icon:
Properties:
Property Name
Description
Single Instance When selected only a single instance of this action will be queue. If the action is triggered again before the previous instance is executed it will overwrite the previous action in the queue instead. Value Check If enabled, the sent value will be compared to the previous value and processing will be skipped if it has not changed. This can improve performance if the sent value is often the same/different. Scenes Scene controlled by the interface. A scene is defined by the following expression:[FOLDERNAME/…./]SCENENAME or [FOLDERNAME#….#]SCENENAME
It is also possible to only specify a folder name directly. In this case all scenes in this folder or a child folder will be controlled by this interface.
Multiple scenes can be specified by adding or removing additional lines with the ‘+’ and ‘-‘ buttons.
Scene Table Interface
The Scene-Table signal allows to specify a collection of scenes and assigns them a certain Id. The interface value represents this Id and will ‘activate’ all scenes that match this Id while ‘deactivating’ all scenes which were previously activated using this interface. If a scene was part of the previous set of scenes and is still part of the new set no action will be performed.
Additionally, “Hints” can be specified which can affect how the change between different sets happens. These are primarily used to control the transition animation.
Note that the actual behavior is controlled by the application specific implementation.
Icon:
Properties:
Property Name
Description
Single Instance When selected only a single instance of this action will be queue. If the action is triggered again before the previous instance is executed it will overwrite the previous action in the queue instead. Value Check If enabled, the sent value will be compared to the previous value and processing will be skipped if it has not changed. This can improve performance if the sent value is often the same/different.
Property Name
Description
(Scenes) Entries Collection of Scenes represented by an Id. Multiple collections can be specified by adding or removing additional lines with the ‘+’ and ‘-‘ buttons. (Scenes) Entries ID The Id representing this set of Scenes. (Scenes) Entries Scenes Scenes which belong to this entry. A scene is defined by the following expression:[FOLDERNAME/…./]SCENENAME or [FOLDERNAME#….#]SCENENAME
It is also possible to only specify a folder name directly. In this case all scenes in this folder or a child folder will be controlled by this interface.
Multiple scenes can be specified by adding or removing additional lines with the ‘+’ and ‘-‘ buttons. (Scenes) Entries Activation State of the scene to be applied when scene is activated. (Scenes) Entries Deactivation State of the scene to be applied when scene is deactivated.
Property Name
Description
(Hints) Entries
Collection of Hints represented by an Id. Multiple collections can be specified by adding or removing additional lines with the ‘+’ and ‘-‘ buttons.
(Hints) Entries ID
The Id representing this Hint.
(Hints) Entries Hint
Hint which belongs to this entry.
Data-Input Interface
The Data-Input interface is used to send data values from external to the CGI Studio application. Only data-items provided by Courier Data-Binding can be set as destination. For more information about Data-Binding please refer to the Courier documentation.
Icon:
Property Name
Description
Item
Data-Item used as a destination for the data value transferred via this signal. Clicking on the ‘…’ button next to then field opens a dialog window which lists all possible data items defined for this application.
Value Check
If enabled, the sent value will be compared to the previous value and processing will be skipped if it has not changed. This can improve performance if the sent value is often the same/different.