A click on this button reveals a small submenu with four entries. Despite the fact that you can add graphs or scripts from different sources, you will always see the same input mask (except for a very few differences).
When you choose “Add new graph from file” or “Add new Python script from file” a file browser appears where you can load a RFG/XML (graphs) or a RFS/PY (script) file. Then, the “Add” dialogue is displayed.
| Info |
|---|
| The first look shows that the window is subdivided into several areas. While the meaning of most fields are pretty straight-forward and almost self-explanatory, there are few functions which require a deeper discussion – they are located under “Input parameters” and explained separately here. |
Source
This area provides access to the graph's or script's source.
...
With “Add new graph” or “Add new Python script” you will see a non-editable “embedded” entry. If you have chosen “...from file” the field contains the path to the script you have been loading before.
…
A click on this button opens a file browser where you can change or update the path to the command's graph/script file. With embedded commands the button is inactive.
...
Use this button to choose or update the icon file.
Description
The empty field is reserved for a detailed description of the command.
Input parameters
In many cases, scripts or graphs require start values to work. These defaults are then modified by the user to get different results. The input is done via a customizable user interface – something that has only been possible with scripts so far. In RealFlow 2014 you will now find appropriate nodes to allow user interfaces with graphs as well. These interface nodes have a direct connection to the “Add” window's “Input parameters” section. This means that you can edit the graph's default values here without opening and editing the graph itself.
| Info |
|---|
| Please bear in mind that currently only graphs are connected to “Edit” buttons of this section and Python user interfaces are not yet supported. |
Edit input parameters (n)
If your graph contains interface nodes you will be able to list, display, and edit them with a click on this button. The number in brackets shows the total number of input parameters.
| Info |
|---|
| Please take a look at this [ chapter ] for an example how to work with this feature. |
Edit default values
This dialogue is closely related to “Edit input parameters (n)”. There you can edit the interface nodes, but here is a place to define their initial values when the graph is executed and the UI is displayed.
| Info |
|---|
| Please take a look at this [ chapter ] for an example how to work with this feature. |
Edit next execution values
This is a very nice feature, because RealFlow can remember the user's input values and write them to the UI when the command is executed again. In other words: the working settings are kept and you do not have to repeat the entire input procedure when you are using the command the next time. Please bear in mind that this feature also works for C++ plugins.
Prompt user
When a command provides a user interface you can choose here when it should be displayed:
“Never”. The UI will not be shown and the default values are used for the command's execution
“On first execution”. With this option, the UI will be shown only once during a session.
“Always”. In this case, the UI will be shown when the command is executed.
Cancel/Add
...
Icon Editor
This is the “Icon Editor's” layout:
Under “From Gallery” it is possible to choose a symbol from RealFlow's icon repository. Simply click on “Browse icon gallery...” to get there. In the “Preview” area you will see the selected icon. Adjust its size with the “Resolution” slider. Most icons are stored in SVG format and can be magnified without any loss of quality.
“From File” let's you choose a PNG, JPG, BMP or SVG file from your hard disk with the “...” button. The chosen image will be shown in the “File location” field. If you want to keep the icon as an external reference, check the appropriate storage method. If you want to embed the image into RealFlow, choose this option.
The “Preview” function works as described above. Please bear in mind that upscaled pixel-based image formats will look jaggy.
Description
The empty field is reserved for a detailed description of the command.