GenerativeComponents Help

Functions dialog

Used to manually create written functions with the correct syntax. The Functions dialog provides a list of functions arranged in alphabetical order in a column view or in a list view. Clicking a function displays its details in the lower panel. The functions can be filtered to view Library or Script or both types of functions. A selected function can be applied to a function call in current model being designed.

Opens when (Show Functions ) is selected.

SettingDescription
Taskbar controls Tools to create and manage functions are provided in the taskbar.
  • New Script Function — opens script editor where you can author a script that defines new function.
  • Edit Selected Script Function — enabled for script functions; selected function script is opened in the script editor for editing.
  • Delete Selected Script Function — enabled for script functions; removes selected script function from the dialog list.
  • Line Item View — Toggles the function list view mode from column view to line view. In line view, the functions are listed in two columns, one for function name and second column for its purpose. The tool icon remains depressed until it is toggled back to view functions in column view.
  • Filter — Allows including or excluding the category of functions in the function list.
    • Include Library Functions — when checked, the standard library functions are seen in the functions list.
    • Include Script Functions — when checked, the user scripted functions are seen in the functions list.
  • Apply to .. — allows applying the selected function to a new function call node; when done a new function call node appears in the graph view.
Function window Lists the available functions. These functions are arranged in the alphanumeric order. The list view is set using the Line Item View tool in th taskbar. A mouse hover on a function in line mode displays the syntax of that function. Whereas, in column list mode, the tool tip displays the name of the function, its return value and the syntax.
The lower portion of the functions window displays the following details of the selected function, in each field:
  • Function name
  • Type
  • Full Name
  • Purpose
  • Signature
  • The Script - this field appears (as coded) only for Scripted functions that are included in Functions.