component::AddControlGroup 1.0

Adds a control group subnet to bundle multiple controls into a single uber control.

On this page	Inputs Outputs
Since	21.0

Creates a control group subnet that bundles multiple controls into a unified control structure. This allows combining abstract controls and transform controls into more complex control setups where all animation parameters of contained controls are treated as a single unit. A control group acts as a container that can hold multiple child controls, making it easier to organize and manage complex rig hierarchies. Optionally, a primary control can be added to serve as the main interaction point for the group. Any other control is being treated as a sub control. Subcontrols are only visible if the given control group is the primary selected control. The parameters are however only accessible via the channel widget. That can be opened with the Hotkey G . This reduces the visualy clutter.

Inputs ¶


                graph:
                    ApexGraphHandle

The APEX graph handle to add the control group to.


                guides:
                    Geometry

The guide geometry containing joint information used for positioning the control group and its primary control.


                name:
                    String

The name for the control group. This name is used as the base for naming the primary control (e.g., if name is “arm”, the primary control will be named “arm_main”).


                tags:
                    StringArray

An array of tags to assign to the control group node for identification and filtering purposes.


                addprimary:
                    Bool

If True, creates a primary control within the control group. The primary control serves as the main transform control for the group and is automatically named “{name}_main”.


                parent:
                    ApexNodeID

The parent node ID that the control group’s primary control should be parented to. Used to establish the transform hierarchy.


                parentxform:
                    Matrix4

The parent transform matrix. If provided as an identity matrix and a matching joint exists in the guides geometry, the transform will be computed from the guide joint data.


                color:
                    Vector3

The display color for the primary control. Defaults to green (0, 1, 0).


                shape:
                    String

The shape to use for the primary control’s viewport representation. Defaults to “cogwheel”.


                size:
                    Float

The display size multiplier for the primary control. Defaults to 1.8.

Outputs ¶


                graph:
                    ApexGraphHandle

The modified APEX graph handle containing the new control group.


                controlgroup:
                    ApexNodeID

The node ID of the newly created control group subnet. This node has the following properties set. The 2 properties also qualify a subnet as a control group:

control.primary: The name of the primary control (“{name}_main”).
control.controlgroup: Set to 1 to identify this as a control group.


                primary:
                    ApexNodeID

The node ID of the primary control if addprimary was True, otherwise an empty ApexNodeID. The primary control is created using addControlGroupPrimary.

Inputs ¶

Outputs ¶

APEX nodes