The scripting module provides an efficient way to program effect modules, renderer modules or other post processing modules that are not present in the current version of Harmony.
This module provides access to an unlimited range of dynamically defined input and output ports. The user can also specify its own attributes for the module and access extern modules attributes. Using the scripting interface included in the module, the user can customize the behaviour of the soft render and call extern applications to easily interact with the current rendering context.
To create a scripting module, just drag and drop one from the I/O tab in the modules window. Initially, a scripting module is created with one input image port, one output image port and with no attributes.
Access the 'Specifications' menu to change the number of input/output ports, the attributes, as well as the script module menu widget itself. By modifying the xml description of the module, one can dynamically change the module parameters.
To add a port, add the following line to the port section:
Valid port types are:
Once allocated into the module, input and output ports can be accessed through the scripting environment.
To add an attribute, add the following line to the attributes section:
Valid attributes types are:
Once registered into the module, attributes can be fetched in the scripting environment. The script also has access to attributes from extern modules in the rendering context.
To specify a different interface to the current scripting module, add the following line to the specifications:
The keyword '$PROJECT' is replaced with current project directory.
Finally, to change the default type of the current scripting module, add the following line to the specifications:
The type name of a module can be used in extern modules query to search for modules of the same properties.