Houdini 21.0 Nodes APEX nodes

component::AddConfigControl

Adds an abstract configuration control to a control group.

On this page
Since 21.0

Creates a configuration subcontrol (such as a slider, toggle, menu, or color picker) that can be vertically or horizontally stacked relative to a parent control within a control group. These subcontrols provide UI interactions for adjusting rig parameters in the viewport when the current control group is the primary selected control. They are also accessible through the parameters HUD in the animate state. See the APEX Autorig Component SOP for the available types of configuration controls.

The graph ports of this node are in-place ports, which means the graph is updated without creating a copy.

Inputs

*graph: ApexGraphHandle Required

The APEX graph that contains the control group.

controlgroup: ApexNodeID

The control group subnet to add the configuration control to. If invalid, the control is added at the root level of the graph.

parent: ApexNodeID

The parent transform control that this configuration control is positioned relative to.

parentxform: Matrix4

The parent’s world transform matrix, used for computing world-oriented shape offsets when not inside a control group.

name: String

The name for the configuration control. Used as the base for parameter naming and node identification.

defaultvaluedict: Dict

A dictionary that contains default values for the control. Must include a 'value' key with the appropriate type for the control.

controltype: String

The type of interaction control to create. See the APEX Autorig Component SOP for the available types of configuration controls. The valid values are:

Control Type

Description

__slider__

Float slider with visual feedback (default).

__toggle__

Boolean toggle switch.

__spaceswitch__

IK/FK-style toggle control. The actual blending between IK and FK is often controlled with a separate slider control.

__menu__

Integer menu with custom icons.

__numbermenu__

Integer menu with numeric labels (0-12).

__intlistmenu__

Integer menu with custom entry values.

__color__

Color picker menu.

__shp__

Shape picker menu.

__name__

String name input. This is a hidden control and only appears in the parameters HUD.

__btn__

Button control, which can be used to trigger a callback on selection.

__channel__

Generic channel control for various value types. This value is only accessible in the parameters HUD and has no UI interaction in the viewport.
value_type: String

The data type for the configuration control. The valid values are Bool, Float, Int, String, and Vector3. Defaults to Float.

size: Float

The reference height (in meters) used to scale control shape offsets. Defaults to 1.8.

place_left: Bool

If set to True, positions the control to the left of the parent. If set to False, positions to the right. Defaults to True.

instance: Int

The vertical stacking index. Higher values position the control lower relative to the parent. Defaults to 0.

horizontal_instance: Int

The horizontal stacking index. Higher values position the control further from the parent. Defaults to 0.

animatable: Bool

If set to True, the control accepts keyframe animation. Defaults to True.

Note

Controls that use a string value are not animatable.

arrange_vertical: Bool

If set to True, applies vertical arrangement shape offsets. Defaults to True.

slider_min: Float

The minimum value for slider controls. Defaults to 0.0.

slider_max: Float

The maximum value for slider controls. Defaults to 1.0.

parm_name: String

An override for the control group parameter name. If empty, it is derived automatically from the control type.

color: Vector3

The display color for the control shape. Defaults to white (1, 1, 1).

Outputs

*graph: ApexGraphHandle

The modified APEX graph.

control: ApexNodeID

The created AbstractControl node.

parmport: ApexPortID

The output port for connecting to the control’s parameter value.

See also

APEX nodes