Represents a user-editable ramp parameter.
The Ramp Parameter node represents a ramp user interface. The input specifies an index into the ramp. The value of the ramp at that position is the node’s output.
See the page on ramp parameters for more information on working with ramps.
Whether this parameter is a color ramp (vector) or spline (float).
The name of the new parameter, both in the VEX function declaration, the definition of any OP type that uses the VOPNET, and the VOP tile’s output. If a parameter by this name already exists, this operator will reference it and will disable most of of its own fields, such as the Parameter Type and Parameter Label.
The name must not be a reserved keyword.
The default method for interpolating between ramp keys, for example “Linear” or “Spline”. The user can change the basis in the ramp interface, but this sets the default.
|Use This Node to Set Parameter Attributes|
When several Parameter VOPs have the same Parameter Name, only one of the nodes is used to control the attributes of the parameter. Houdini decides which node to use for this by searching all the nodes according to the user defined order, then traversing inside subnets. If none of them have this parameter turned on, the first one found is used to set the parameter attributes. If one or more do have this option turned on, the first one with this option is used, even if another node (with this option turned off) is found first.
A human-readable label for this parameter. Appears in the parent node’s parameters and the tooltip when the user hovers over the output on the VOP tile.
HScript or Python script to run when this parameter is changed by a UI event (or when the button is clicked, if Type is Button).
If your script is written in HScript, the name of the changed parameter is
If your script is written in Python, the same variables are accessible via
a dictionary variable named
For example, this HScript callback command would open a small window showing the path to the operator and the name of the parameter plus the new value:
message `oppwf()`/$script_parm = $script_value0
Often, you will call a script stored as a section (an embedded file) in a digital asset. For an object type named asset_name, you can run the script in the section named section_name using the following command as the callback:
Help string for the parameter. This is displayed in the tool tip when the user hovers over this parameter in the parameter editor.
The index into the ramp. The Ramp Parameter node outputs the value of the ramp at this position.
The value of the ramp at the position specified by the input to this node.