Houdini Engine for Unreal
 All Files Pages
Parameters

The asset parameters that are exposed on a Houdini Asset will be displayed in Unreal in the Details Panel. These can be manipulated and modified in Unreal and will trigger a recook of the asset if the CookOnParameterChange option is activated in the Asset Details Panel.

Some dynamic parameter options such as Disable When and Hide When are supported, and if a numerical parameter's unit is set in Houdini, it will be displayed next to its value in the details panel.

Please note that parameters that are marked as invisible, or whose parent are marked as invisible in Houdini will not be displayed or accessible in Unreal.

By default, a parameter's tooltip in Unreal will be the following: "Parameter_Label (Parameter_Name)". If you want to customize that tooltip, you can simply edit the parameter's help in the type properties dialog, and that help string will be used as the parameter's tooltip in the plug-in instead of the default string.

Houdini assets support a wide range of parameter types and configurations. However, not all of these parameter types and configurations are supported by the Unreal plug-in.

Following is a list of all the supported parameter types:

Integers

Integer parameters are supported, as well as Integer tuples.

Values can be edited either by typing in the fields or by using the slider. The min and max range of the parameter can be used to constrain the values of the parameter and the slider. If not set, the default range for the slider is [0 10].

Unreal_ParametersInt.png

Special Types of Integer parameters are also supported:

  • Int Vector 2, Int Vector 3 and Int Vector 4 are displayed in the same way as their Int Tuple equivalent.
  • Logarithmic Integer parameters are treated as regular integer parameters, so their UI sliders will be linear instead of being logarithmic.
  • Min Max Integer will be displayed as an Int Tuple 2 parameter.

It is also possible to create Integer Menus.

Unreal_ParametersIntSpecial.png

Floats

Float parameters are supported, as well as Float tuples.

Float parameters with a tuple size of 3 will automatically be recognized and displayed as a XYZ Vector3 parameter. Their values will also be properly converted from Houdini to Unreal's Houdini's Coordinate Systems.

Values can be edited either by typing in the fields or by using the slider. The min and max range of the parameter can be used to constrain the values of the parameter and the slider. If not set the default range for the slider is [0 10].

Unreal_ParametersFloat.png

Special Types of Float parameters are also supported:

  • Angles will be displayed as a normal float parameter, and its unit will be displayed in Unreal if it is set to "deg" in Houdini.
  • Direction Vectors and Float Vector 3 will be displayed as a XYZ Vector, and their values properly converted to Houdini's Coordinate Systems.
  • Logarithmic Floats are treated as regular float parameters, so their UI sliders will be linear instead of being logarithmic.
  • Min Max Floats will be displayed as a Float Tuple 2 parameter.
  • Float Vector 2, Float Vector 4, UV and UVW will be displayed in the same way as their Float Tuple equivalent.
Unreal_ParametersFloatSpecial.png

Strings

String parameters are supported, as well as string tuples and string Menus.

Multiline strings** are however, not supported.

Unreal_ParametersString.png

Buttons

Button parameters are supported. Clicking on them will change their value to 1 in Houdini and trigger their Callback Script if it's been configured.

Note that a button parameter channel-linked to a node inside the asset must be made editable in that asset's Type Properties in order to work.

Unreal_ParametersButton.png

Colors

Color parameters are supported. The color can be choosen using the standard Unreal color widget that is displayed after clicking on the color parameter.

Unreal_ParametersColor.png

Files

File parameters are supported (as well as File - Geometry and File - Images parameters. The edit box will display the path to the selected file. You can select a file by clicking on the browse button.

Unreal_ParametersFile.png

Folders

Some types of Folder parameters are supported by the plug-in:

  • Tabs folder are represented as buttons displayed side by side. Clicking on a tab button will display the corresponding child parameters.
  • Simple and Collapsible folder are currently displayed by a simple button that acts as a separator for child parameters.

When parenting Folders, the parent's visiblity will modify its children's.

Unreal_ParametersFolder.png

Labels

Labels parameters are supported and can be used to display text in the detail panel of an asset. Column labels are not supported.

Unreal_ParametersLabel.png

MultiParams

Multiparm Block type folders are supported, but List, Scroll and Tabs Multiparm blocks will all be represented as an array of parameters.

The first line will allow you to define the size of the MultiParam array, and either to add or remove elements in it, or to clear it.

All the parameters will then be listed, with additional x and + buttons that will allow you to remove the current element or to insert a new one.

Multiparms nested inside other multiparms are supported since Houdini 16.0.640.

Unreal_ParametersMultiParam.png

Ramps

Both Float Ramps and Color Ramps are supported by the plug-in.

All the key points of the ramps are displayed in an array under the ramp. This array allows you to set the point values, their interpolation, and delete or add new points.

Right-clicking on a key will allow you to choose its interpolation type. You can also right click on the ramp to add a new key.

Unreal_ParametersRamp.png

Color ramps work in a similar way than Float Ramps. You can set the color of each point by clicking on its color parameter, and choosing it in the Color Picker.

Unreal_ParametersColorRamp.png

Separators

It is possible to add separator parameters to your asset. They will work as advertised in the details panel of the asset in Unreal.

Toggle

Toggle parameters are supported and will be displayed as checkboxes in the detail panels. It is possible to use them to control dynamic options such as Disable When and Hide When on other parameters.

Unreal_ParametersToggle.png

Operator Path

Operator Path parameters are supported if the Op Filter option is set to "Any Object" or "Any SOP". Geometries can be connected to these parameters if they refer to an Object Merge node.

They will have the same behaviors as Inputs, as the connected geometry will be sent through Houdini Engine, and will be available as an input node on the Houdini side. The path of the input node is then set to the parameter.

Unreal_ParametersObjectPath.png

See Object Path Inputs for more details.

Menus

Single Selection Menus can also be used with Integer and String parameters. However, Mini Menu, Field, and Multi Selection Menu are not supported. Also, Menu Scripts cannot be used to generate menu items dynamically.

Unreal_ParametersMenu.png