Control Rig can be called in Blueprints using the Control Rig Component. Using this component, you can drive Control Rigs with gameplay logic in Blueprints, reinitialize Control Rigs to fit differently proportioned characters, and attach non-skeletal mesh objects to the Control Rig hierarchy.
This document provides an overview of the Control Rig Component, how to add it to your Blueprint, and the features it enables.
Prerequisites
You have created a Control Rig asset for a character and know how to create controls. See the Control Rig Quick Start page for information on how to do this.
You have created an Actor Blueprint that contains a skeletal mesh component, and have an understanding of Blueprints Visual Scripting.
Component Setup
The Control Rig Component is created by clicking the Add (+) button in the Blueprint Components panel and selecting Control Rig in the Animation category.
Next, select the Control Rig Component and assign your default Control Rig Class in the Details panel. Click the dropdown menu next to Control Rig Class and assign your class.
After assigning the Control Rig Class, bones from the Control Rig will be visible in the viewport. You can hide these by disabling Draw Bones in the Control Rig Component Details panel.
Mapping Setup
Lastly, you will need to map the Control Rig to the Skeletal Mesh, which must be done on the Pre Initialize Event from the Control Rig Component. This is done to form the connection between the Skeletal Mesh Component and the Control Rig Component.
With the Control Rig Component selected, click the Add (+) button next to On Pre Initialize in the Details panel. This will create the corresponding event in the Event Graph.
Next, drag from the Component pin and select Add Mapped Skeletal Mesh from the context menu. Add a reference to your Skeletal Mesh Component, and connect it to the Skeletal Mesh Component pin.
Overview
Once you have completed the Component Setup, you can start using the Control Rig Component in your blueprints. With it, you can use basic functions, such as getting or setting Rig Elements, editing details, and creating new mapping connections.
Details
The following is the list of relevant details of the Control Rig Component:
|
Name |
Description |
|---|---|
|
Control Rig Class |
The Control Rig Class to instantiate. A Control Rig asset must be specified here. |
|
Mapped Elements |
This array is used to manually define default mappings for the Control Rig |
|
Reset Transform Before Tick |
Enabling this will cause Control Rig transforms to update before each tick. |
|
Reset Initials Before Setup |
Enabling this will cause the initial transforms on Bones, Nulls, and Controls to reset prior to the Setup Event. |
|
Update Rig on Tick |
Enabling this ensures the rig will update when the component ticks. |
|
Update in Editor |
Allows for Control Rig behavior to be visible in the viewport without needing to play or simulate. |
|
Enable Lazy Evaluation |
Enabling this will make the Control Rig only evaluate if any of the mapped inputs have changed. |
|
Position Threshold |
The position or translation threshold to use when Lazy Evaluation is enabled. |
|
Rotation Threshold |
The rotation threshold in degrees to use when Lazy Evaluation is enabled. |
|
Scale Threshold |
The scale threshold to use when Lazy Evaluation is enabled. |
|
Draw Bones |
Enables drawing bones imported from the Control Rig Class.
|
Events
Control Rig can call the following events from the Control Rig Component. These events can be added to the Event Graph by either selecting the Control Rig Component and navigating to the Events category in the Details panel, or by right-clicking in the Event Graph and selecting Add Event for Control Rig > Control Rig.
|
Name |
Image |
Description |
|---|---|---|
|
On Pre Initialize |
|
This event gets called before the Component's Control Rig is initialized. It can be used for setting transforms or additional variables in Control Rig before the Control Rig Component is initialized. In typical Control Rig setups, this event fires once, similar to Event Begin Play. |
|
On Post Initialize |
|
This event gets called after the Component's Control Rig is initialized. It can be used to set transforms or additional variables in Control Rig after the Control Rig Component is initialized. In typical Control Rig setups, this event fires once, similar to Event Begin Play. |
|
On Pre Setup |
|
This event gets called before the Setup Event of the Component's Control Rig. It can be used for setting transforms or additional variables in Control Rig before Control Rig's Setup Event. In typical Control Rig setups, this event fires once, similar to Event Begin Play. |
|
On Post Setup |
|
This event gets called after the Setup Event of the Component's Control Rig. It can be used for setting transforms or additional variables in Control Rig after Control Rig Setup Event. In typical Control Rig setups, this event fires once, similar to Event Begin Play. |
|
On Pre Forwards Solve |
|
This event gets called before the Forward Solve of the Component's Control Rig. It can be used for setting transforms or additional variables in Control Rig before its Forwards Solve. In typical Control Rig setups, this event continuously fires, similar to Event Tick. |
|
On Post Forwards Solve |
|
This event gets called after the Forward Solve of the Component's Control Rig. It can be used for setting transforms or additional variables in Control Rig after its Forwards Solve. In typical Control Rig setups, this event continuously fires, similar to Event Tick. |
Mapping
During the Setup phase, you are required to map the entire Skeletal Mesh Component to the Control Rig Component. However, you can also map specific elements within your Control Rig to other Components. Mapping is bi-directional, meaning that Control Rig elements can either affect Components, or be affected by them. In this way, mapping is somewhat similar to attaching.
By default, mapping is generally achieved by matching the bone names from the Control Rig Class to the Skeletal Mesh Component. In this way, you can imagine that when both components are in use, that there are two different skeletons operating within your Blueprint. Mapping allows for both of these skeletons — and other components — to affect one another.
Mapping elements can be done in the following ways:
Manual Details Mapping
In the Details panel, under the Animation section, the Control Rig Component has a Mapped Elements array. By clicking the Add (+) button, you can manually add information to map and connect elements to the Control Rig.
For example, if you want to map a Camera Component in your blueprint so that a Control affects its position, then input the following properties:
Set Component Name to Camera, so it matches the Camera Component.
Set Element Type to Control, as that is the Control Rig element you are mapping to.
Set Element Name to Camera_ctrl, which is the name of the Control Rig Element you are mapping to.
Set Direction to Output, in order to define the direction of the mapping. In this case, Output is causing the Control element to dictate the transform of the Camera. If Input was specified, then the Camera Component would dictate the Control element instead.
The following properties can be used to create your mapping settings.
|
Name |
Description |
|---|---|
|
Component Reference |
The Blueprint Component to define by name. If the Control Rig Component is in an Actor-based Blueprint, it defaults to Self as the Referenced Actor if no name is specified. |
|
Transform Index |
An optional index value for Components with multiple transforms. |
|
Transform Name |
An optional name value for Components with multiple individualized transform names, such as sockets in skeletal meshes. |
|
Element Type |
The Rig Element type in Control Rig that the Component is an input or output of. You can choose from Bones, Controls, Nulls, Curves, Rigid Bodies, and References. |
|
Element Name |
The Rig Element name in Control Rig that the Component is an input or output of. |
|
Direction |
Determines the direction of control between the mapped Blueprint Component and Control Rig Element.
|
|
Offset |
A transform offset to apply to the mapping. |
|
Weight |
The factor of the mapping. |
|
Space |
The transform space that the mapping should be defined on. |
Dynamic Graph Mapping
You can also dynamically add, or change mappings in the Event Graph. This is done using several different Functions and Structs, which achieve different levels of mapping.
Add Mapped Skeletal Mesh
This node takes a Skeletal Mesh Component and maps the bones of the Skeletal Mesh to the Preview Mesh in the Control Rig used in the Control Rig Component. This is a Control Rig to Skeletal Mesh mapping link. Typically this node is used when performing initialization of the Control Rig in Blueprints.
Add Mapped Skeletal Mesh Bone Array
This node maps either an array of Bones or Curves between a Skeletal Mesh Component and Control Rig Component. Additionally, you can specify Source and Target names if the Control Rig Skeleton and Skeletal Mesh Skeleton contain different bone or curve names from one another. This provides a similar workflow to "Find and Replace" names, however it operates only for individual bones or curves.
Only the bones or curves from either array will be mapped. If you want to map the entire skeleton as well, then you can follow this node with Add Mapped Skeletal Mesh.
Add Mapped Elements
This node maps an array of Blueprint Components to the Control Rig Component. These components are defined by the Make ComponentReference and Make ControlRigComponentMappedElement structs. The properties and format of these structs are the same as when mapping from the Details panel.
Add Mapped Components
This node maps an array of Blueprint Components to the Control Rig Component. These components are defined by directly referencing the component and the Make ControlRigComponentMappedComponent struct. The properties of this struct is a streamlined variant of the Make ControlRigComponentMappedElement, providing only the most common mapping properties.
