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
| Returns | Name | Description |
|---|---|---|
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::string | AddNode | |
void | RemoveNode | |
bool | Connect | |
void | Disconnect | |
std::string | BeginNodeId | |
std::string | BeginNodeId | |
std::string | ResultNodeId | |
std::string | EnsureBeginResult | |
int32_t | FindControl | |
FControlRigControl* | AddControl | |
void | RemoveControl | |
std::vector<FControlRigPin> | NodePins | |
std::string | SerializeToString | |
bool | LoadFromString | |
bool | SaveToFile | |
bool | LoadFromFile | |
void | Evaluate | Evaluate the rig. |
bool | RunConstruction | 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. |
const char* | NodeTypeName | |
EControlRigNodeType | NodeTypeFromName | |
const char* | NodeTypeDisplay | |
const char* | ValueTypeName | |
EControlRigValueType | ValueTypeFromName | |
const char* | MathOpName | |
EControlRigMathOp | MathOpFromName | |
const char* | SpaceName | |
EControlRigSpace | SpaceFromName | |
const char* | EventName | |
EControlRigEventType | EventFromName |
Function details
Nodes
std::vector<FControlRigNode>& Nodes()Nodes
const std::vector<FControlRigNode>& Nodes() constConnections
std::vector<FControlRigConnection>& Connections()Connections
const std::vector<FControlRigConnection>& Connections() constControls
std::vector<FControlRigControl>& Controls()Controls
const std::vector<FControlRigControl>& Controls() constFindNode
FControlRigNode* FindNode(const std::string& id)FindNode
const FControlRigNode* FindNode(const std::string& id) constAddNode
std::string AddNode(EControlRigNodeType type, float x, float y)RemoveNode
void RemoveNode(const std::string& id)Connect
bool Connect(const std::string& fromNode, const std::string& fromPin, const std::string& toNode, const std::string& toPin)Disconnect
void Disconnect(const std::string& toNode, const std::string& toPin)BeginNodeId
std::string BeginNodeId() constBeginNodeId
std::string BeginNodeId(EControlRigEventType event) constResultNodeId
std::string ResultNodeId() constEnsureBeginResult
std::string EnsureBeginResult()FindControl
int32_t FindControl(const std::string& name) constAddControl
FControlRigControl* AddControl(const std::string& name, EControlRigValueType type)RemoveControl
void RemoveControl(const std::string& name)NodePins
std::vector<FControlRigPin> NodePins(const FControlRigNode& node) constSerializeToString
std::string SerializeToString() constLoadFromString
bool LoadFromString(const std::string& text)SaveToFile
bool SaveToFile(const std::string& path) constLoadFromFile
static bool LoadFromFile(FControlRig& out, const std::string& path)Evaluate
void Evaluate(const Skeleton& skeleton, const std::vector<Mat4>& inputLocalPose, const std::unordered_map<std::string, FControlRigValue>& controlValues, std::vector<Mat4>& outLocalPose) constEvaluate 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
bool RunConstruction(const Skeleton& skeleton, const std::vector<Mat4>& bindLocalPose, std::unordered_map<std::string, FControlRigValue>& controlValues) constRun 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
static const char* NodeTypeName(EControlRigNodeType type)NodeTypeFromName
static EControlRigNodeType NodeTypeFromName(const std::string& name)NodeTypeDisplay
static const char* NodeTypeDisplay(EControlRigNodeType type)ValueTypeName
static const char* ValueTypeName(EControlRigValueType type)ValueTypeFromName
static EControlRigValueType ValueTypeFromName(const std::string& name)MathOpName
static const char* MathOpName(EControlRigMathOp op)MathOpFromName
static EControlRigMathOp MathOpFromName(const std::string& name)SpaceName
static const char* SpaceName(EControlRigSpace space)SpaceFromName
static EControlRigSpace SpaceFromName(const std::string& name)EventName
static const char* EventName(EControlRigEventType event)EventFromName
static EControlRigEventType EventFromName(const std::string& name)