Navigation
API > API/Plugins > API/Plugins/RigLogicModule
References
| Module | RigLogicModule |
| Header | /Engine/Plugins/Animation/RigLogic/Source/RigLogicModule/Public/RigUnit_RigLogic.h |
| Include | #include "RigUnit_RigLogic.h" |
Syntax
USTRUCT&40;Meta&61;&40;DocumentationPolicy&61;"Strict"&41;&41;
struct FRigUnit_RigLogic_Data
Remarks
The work data used by the FRigUnit_RigLogic
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FRigUnit_RigLogic_IntArray > | BlendShapeIndices | RL mesh+blend shape array index to RL blend shape index for each LOD | |
| uint32 | CurrentLOD | LOD for which the model is rendered | |
| TArray< FRigUnit_RigLogic_IntArray > | CurveElementIndicesForAnimMaps | RL animated map index to ControlRig's output anim map curve index for each LOD | |
| TArray< int32 > | HierarchyBoneIndices | RL joint index to ControlRig's hierarchy bone index | |
| TArray< int32 > | InputCurveIndices | Mapping RL indices to UE indices Note: we use int32 instead of uint32 to allow storing INDEX_NONE for missing elements if value is valid, it is cast to appropriate uint typeRL input index to ControlRig's input curve index | |
| TSharedPtr< FSharedRigRuntimeContext > | LocalRigRuntimeContext | ||
| TArray< FRigUnit_RigLogic_IntArray > | MorphTargetCurveIndices | RL mesh blend shape index to ControlRig's output blendshape curve index for each LOD | |
| TArray< int32 > | NeuralNetMaskCurveIndices | RL neural network mask index to ControlRig's input curve index | |
| TUniquePtr< FRigInstance > | RigInstance | RigInstance is a thin class, containing only character instance specific data i.e. the output buffers where RigLogic writes the results of computations, specific to each instance of a rig. | |
| TArray< FRigUnit_RigLogic_IntArray > | RigLogicIndicesForAnimMaps | RL animated map index to RL anim map curve index for each LOD | |
| TWeakObjectPtr< USkeletalMeshComponent > | SkelMeshComponent | Cached Skeletal Mesh Component |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FRigUnit_RigLogic_Data
(
const FRigUnit_RigLogic_Data& Other |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | CalculateRigLogic
(
const URigHierarchy* InHierarchy |
Calculates joint positions, orientation and scale based on inputs curves of the control rig | |
| void | InitializeRigLogic
(
const URigHierarchy* InHierarchy, |
||
| bool | |||
| void | MapInputCurveIndices
(
const URigHierarchy* InHierarchy |
Makes a map of input curve indices from DNA file to the control rig curves | |
| void | MapJoints
(
const URigHierarchy* Hierarchy |
Uses names to map joint indices from DNA file to the indices of bones in control rig hierarchy | |
| void | MapMaskMultipliers
(
const URigHierarchy* InHierarchy |
Uses names to map mask multiplier indices from DNA file, for all LODs, to the indices of curves in the control rig's curve container | |
| void | MapMorphTargets
(
const URigHierarchy* InHierarchy |
Uses names of blend shapes and meshes in DNA file, for all LODs, to map their indices to the indices of morph target curves in the curve container; curve name format is |
|
| void | MapNeuralNetMaskCurveIndices
(
const URigHierarchy* InHierarchy |
Makes a map of neural net mask indices from DNA file to the control rig curves | |
| void | UpdateAnimMapCurves
(
URigHierarchy* InHierarchy, |
Updates anim map curve values based on values of input curves of the control rig | |
| void | UpdateBlendShapeCurves
(
URigHierarchy* InHierarchy, |
Updates morph target curve values based on values of input curves of the control rig | |
| void | UpdateJoints
(
URigHierarchy* Hierarchy, |
Updates joint positions in the hierarchy based on inputs curves of the control rig |
Operators
| Type | Name | Description | |
|---|---|---|---|
| FRigUnit_RigLogic_Data & | operator=
(
const FRigUnit_RigLogic_Data& Other |
Constants
| Name | Description |
|---|---|
| MAX_ATTRS_PER_JOINT |