Houdini 21.0 Nodes APEX nodes

component::AddConfigControl 1.0

Adds an abstract configuration control to a control group.

On this page
Since 21.0

Creates a configuration sub control (such as sliders, toggles, menus, or color pickers) that can be vertically or horizontally stacked relative to a parent control within a control group. These sub controls provide UI widgets for adjusting rig parameters in the viewport, when the current control group is the primary selected control. They are also accessible with the Channel widget.

Inputs

graph: ApexGraphHandle

The APEX graph handle containing the control group.

controlgroup: ApexNodeID

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

parent: ApexNodeID

The parent transform control that this config 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 config control. Used as the base for parameter naming and node identification.

defaultvaluedict: Dict

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

controltype: String

The type of control widget to create. Valid values are:

  • slider: Float slider with visual feedback (default)

  • toggle: Boolean toggle switch

  • spaceswitch: IK/FK style toggle control - the actual blending of the ik/fk switch 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 widget

  • shp: Shape picker widget

  • name: String name input (hidden control - channelwidget only)

  • btn: Button control - the widget itself can be used to trigger a callback on selection

  • channel: Generic channel control for various value types - this means the value is only accessible in the Channel widget and has no UI widget representation

value_type: String

The data type for the config control. Valid values are: 'Float', 'Int', 'Bool', 'String', 'Vector3'. Defaults to 'Float'.

size: Float

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

place_left: Bool

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

instance: Int

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

horizontal_instance: Int

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

animatable: Bool

If True, the control accepts keyframe animation. Defaults to True. Attention: Controls using a string value can never be animatable.

arrange_vertical: Bool

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

slider_min: Float

Minimum value for slider controls. Defaults to 0.0.

slider_max: Float

Maximum value for slider controls. Defaults to 1.0.

parm_name: String

Override for the control group parameter name. If empty, derived automatically from the control type.

color: Vector3

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

Outputs

graph: ApexGraphHandle

The modified APEX graph handle.

control: ApexNodeID

The created AbstractControl node.

parmport: ApexPortID

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

See also

APEX nodes