class

FControlRig

A procedural rigging node graph (.controlrig, MDF). It reads an input bone pose plus a set of named control inputs and writes an output pose, mutating bones through IK / aim / offset nodes wired off an execution chain (Begin -> ... -> Result) with data nodes (control, math, get-bone) pulled on demand. The runtime evaluates it as a post-process over the AnimGraph pose; the editor reads and writes it directly.

Module
Animation
Header
#include "Animation/ControlRig.h"
Namespace
Mowo

Public functions

ReturnsNameDescription
std::vector<FControlRigNode>&Nodes
const std::vector<FControlRigNode>&Nodes
std::vector<FControlRigConnection>&Connections
const std::vector<FControlRigConnection>&Connections
std::vector<FControlRigControl>&Controls
const std::vector<FControlRigControl>&Controls
FControlRigNode*FindNode
const FControlRigNode*FindNode
std::stringAddNode
voidRemoveNode
boolConnect
voidDisconnect
std::stringBeginNodeId
std::stringBeginNodeId
std::stringResultNodeId
std::stringEnsureBeginResult
int32_tFindControl
FControlRigControl*AddControl
voidRemoveControl
std::vector<FControlRigPin>NodePins
std::stringSerializeToString
boolLoadFromString
boolSaveToFile
boolLoadFromFile
voidEvaluateEvaluate the rig.
boolRunConstructionRun the Construction chain against bindLocalPose (the pose the rig is being bound over — normally the skeleton's bind pose) and write whatever its SetControl nodes produce into controlValues.
const char*NodeTypeName
EControlRigNodeTypeNodeTypeFromName
const char*NodeTypeDisplay
const char*ValueTypeName
EControlRigValueTypeValueTypeFromName
const char*MathOpName
EControlRigMathOpMathOpFromName
const char*SpaceName
EControlRigSpaceSpaceFromName
const char*EventName
EControlRigEventTypeEventFromName

Function details

Nodes

C++
std::vector<FControlRigNode>& Nodes()

Nodes

C++
const std::vector<FControlRigNode>& Nodes() const

Connections

C++
std::vector<FControlRigConnection>& Connections()

Connections

C++
const std::vector<FControlRigConnection>& Connections() const

Controls

C++
std::vector<FControlRigControl>& Controls()

Controls

C++
const std::vector<FControlRigControl>& Controls() const

FindNode

C++
FControlRigNode* FindNode(const std::string& id)

FindNode

C++
const FControlRigNode* FindNode(const std::string& id) const

AddNode

C++
std::string AddNode(EControlRigNodeType type, float x, float y)

RemoveNode

C++
void RemoveNode(const std::string& id)

Connect

C++
bool Connect(const std::string& fromNode, const std::string& fromPin, const std::string& toNode, const std::string& toPin)

Disconnect

C++
void Disconnect(const std::string& toNode, const std::string& toPin)

BeginNodeId

C++
std::string BeginNodeId() const

BeginNodeId

C++
std::string BeginNodeId(EControlRigEventType event) const

ResultNodeId

C++
std::string ResultNodeId() const

EnsureBeginResult

C++
std::string EnsureBeginResult()

FindControl

C++
int32_t FindControl(const std::string& name) const

AddControl

C++
FControlRigControl* AddControl(const std::string& name, EControlRigValueType type)

RemoveControl

C++
void RemoveControl(const std::string& name)

NodePins

C++
std::vector<FControlRigPin> NodePins(const FControlRigNode& node) const

SerializeToString

C++
std::string SerializeToString() const

LoadFromString

C++
bool LoadFromString(const std::string& text)

SaveToFile

C++
bool SaveToFile(const std::string& path) const

LoadFromFile

C++
static bool LoadFromFile(FControlRig& out, const std::string& path)

Evaluate

C++
void Evaluate(const Skeleton& skeleton, const std::vector<Mat4>& inputLocalPose, const std::unordered_map<std::string, FControlRigValue>& controlValues, std::vector<Mat4>& outLocalPose) const

Evaluate the rig. inputLocalPose is the incoming local bone pose (one Mat4 per skeleton bone); controlValues overrides authored control defaults by name. outLocalPose receives the mutated local pose and is guaranteed finite (any non-finite bone falls back to its input value).

RunConstruction

C++
bool RunConstruction(const Skeleton& skeleton, const std::vector<Mat4>& bindLocalPose, std::unordered_map<std::string, FControlRigValue>& controlValues) const

Run the Construction chain against bindLocalPose (the pose the rig is being bound over — normally the skeleton's bind pose) and write whatever its SetControl nodes produce into controlValues. Runs once per bind, never per frame: it exists so control DEFAULTS can be derived from the skeleton instead of hand-typed against one particular rig. A rig with no Construction Begin node is a no-op and returns false.

NodeTypeName

C++
static const char* NodeTypeName(EControlRigNodeType type)

NodeTypeFromName

C++
static EControlRigNodeType NodeTypeFromName(const std::string& name)

NodeTypeDisplay

C++
static const char* NodeTypeDisplay(EControlRigNodeType type)

ValueTypeName

C++
static const char* ValueTypeName(EControlRigValueType type)

ValueTypeFromName

C++
static EControlRigValueType ValueTypeFromName(const std::string& name)

MathOpName

C++
static const char* MathOpName(EControlRigMathOp op)

MathOpFromName

C++
static EControlRigMathOp MathOpFromName(const std::string& name)

SpaceName

C++
static const char* SpaceName(EControlRigSpace space)

SpaceFromName

C++
static EControlRigSpace SpaceFromName(const std::string& name)

EventName

C++
static const char* EventName(EControlRigEventType event)

EventFromName

C++
static EControlRigEventType EventFromName(const std::string& name)
Generated from Animation/ControlRig.h via animation.json · Oct 26, 2026Version 1.0.0