CGI Studio Connector
Overview
The CGI Studio Connector is an additional tool for CGI Studio which makes it easy to connect a CG...
Connector
This is the central tool which allows the user to define the interfaces to interact with the othe...
Welcome Screen
The welcome screen allows the user to create a new (Ctrl + N) or open an existing (Ctrl + O) CGI ...
New Project
A new project can be created from the Welcome Screen or via the menu bar (File > New Project) or ...
Modules
Modules are used to group a set of interfaces which usually belong logically together. It is po...
Interfaces
Interfaces define the inputs and outputs of the CGI Application. Depending on the module type eit...
Edit Menu
It is possible to quickly edit external resources with via the edit menu or the toolbar. ...
Build Menu
The build menu allows to quickly trigger a build from the specified Build-Projects. It lists all ...
Project Settings
Several project related configurations can be performed in the project settings window which is a...
Builds
When a build is started the Build-Window will be shown and the build will be automatically starte...
Complex Types
Besides integral types, such as various integer and floating-point types, also complex types are ...
XML Definition
Complex Types are defined in an XML Schema file which is located at “cgi_studio_connector/schema/...
Converter
For conversion between the basic type and actual complex type, conversion functions needs to be a...
Editor
An editor for the Native-Function definition can be found here:“cgi_studio_connector/bin/ComplexT...
Native Functions
Native Functions allow to execute custom code directly from the interface or receive customizable...
XML Definition
Native Functions are defined in an XML Schema file which is located at “cgi_studio_connector/sche...
Implementation
The actual native functions must be implemented as part of the Action-Context class which will th...
Editor
An editor for the Native-Function definition can be found here:“cgi_studio_connector/bin/NativeFu...
Build Projects
Build-Projects contain so called builds which help to automate the process of generating code and...
XML Definition
Builds are defined in an XML Schema file which is located at “cgi_studio_connector/schema/BuildPr...
Sample
Below a sample XML file can be seen <?xml version="1.0"?> <BuildProject xsi:noNamesp...
Editor
An editor for the Build-Projects definition can be found here:“cgi_studio_connector/bin/BuildProj...
Default variables
Besides user configured variables the following default environment variables will be set. ...
Command Line Interface
It is possible to start a build from the Command Line via the Build-CLI tool. For more informatio...
Interface
The main purpose of the CGI Studio Connector is to create an interface that allows to easily conn...
Interface-Buffer
The main class of the generated interface is called “Interface-Buffer”. This class is responsible...
Action-Context
The action context is used whenever any actions (except scene related actions) are executed. Besi...
Scene-Context
The Scene-Context is used whenever scene related actions are executed. Here the user can provide ...
Data-Model
The basic Data-Model used by the Interface-Buffer is completely generated. However, the user can ...
Tools
There are multiple tools include in the CGI Connector which also can be used directly without int...
Interface-Code Generator
This tool is located at “cgi_studio_connector/bin/InterfaceCodeGenerator.exe” and is the main too...
Model-Code Generator
This tool is located at “cgi_studio_connector/bin/ModelCodeGenerator.exe” and generates a basic D...
Build Command Line Interface
This tool is located at “cgi_studio_connector/bin/BuildCLI.exe” and allows the user to execute a ...
Tool Support
Overview
The CGI Connector offers support for multiple ‘tools’ for which it can generate specific code to ...
Generic
The ‘Generic’ tool provides a plain C/C++ based interface which can be used to integrate the CGI ...
MATLAB
The ‘MATLAB’ tool offers special features to make integration into MathWorks MATLAB easier. Requ...