The information on this page might change rapidly. You can check the recent changes to see if any updates have occurred.
The Metadata window is the interface used to create and control node parameters. It can be found in the upper left corner of the Parameter pane. The screen shot below shows a data sheet for a node that contains 1 of each possible parameter. Turn to Metadata whenever in desperate need for a variable.
Contents |
Ports and parameters
First important thing to notice is that the node has two sorts of metadata types: ports and parameters. The shown example contains 1 port named 'shape', 4 general parameters and 16 parameters created for this node. The general parameters handle the description, image, handle and code of the node. These general parameters are named with an underscore. The other parameters are created by the user to work with in the source pane of the node.
Create new parameter
To create a new parameter you can press the small '+' icon in the lower left corner. It will ask to select between creating a new port or a new parameter. Select parameter and name it. A new parameter should have joined the list and can be altered by changing the widget which controls the type. Deleting a parameter can be obtained by pressing the '-' icon. The arrows up/down can be used to (re)order the parameters.
Parameter settings
Name: refers to the name given to the parameter. In the Source pane parameters can be called by it. f.i a parameter called 'xpos' can be called by using self.xpos
Label: the same name labelled for the backend to work with it
Help Text: may contain some additional information on usability, purpose etc
Type: controls the type as well as the appearance of the parameter. Type gives indication of the what the variable expects as input. According to the selected type the value input should be corresponding. f.i. FLOAT needs 10.0, COLOR needs #000000ff. It changes the appearance of the parameter in the parameter pane: COLOR will be represented by a little squared button containing the color, IMAGE will appear as a search button to locate an image file.
- ANGLE
- COLOR
- FILE
- FLOAT
- FONT
- GRADIENT
- IMAGE
- INT
- MENU
- SEED
- STRING
- TEXT
- TOGGLE
- NODEREF
- STAMP EXPRESSION
- CODE
Value: stores the initial value of the parameter.
Bounding: for numeric types bounds can be introduced (see minimum and maximum below). In order to take effect bounding should be set to soft or hard. It is also possible to introduce just one bound. f.i to allow only positive numbers. When set to 'none', minimum and maximum value will be overruled.
- none
- soft
- hard
Minimum: to introduce a minimum. toggle ON/OFF
Maximum: to introduce a maximum. toggle ON/OFF
Display Level:
- hud
- detail
- hidden
Menu Items: Interface to create menu items for the parameter when set to "menu" as type
Appearance in parameter pane
The screen shot below shows the appearance of the types as widgets in the parameter pane. Some widgets open an additional window, f.i. file will prompt a window to browse for a file, color will open a pop up controlling RGB,HSB values
