Navigation
API > API/Plugins > API/Plugins/RigLogicModule
The work data used by the FRigUnit_RigLogic
| Name | FRigUnit_RigLogic_Data |
| Type | struct |
| Header File | /Engine/Plugins/Animation/RigLogic/Source/RigLogicModule/Public/RigUnit_RigLogic.h |
| Include Path | #include "RigUnit_RigLogic.h" |
Syntax
USTRUCT (Meta=(DocumentationPolicy="Strict"))
struct FRigUnit_RigLogic_Data
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| RigUnit_RigLogic.h | |||
FRigUnit_RigLogic_Data
(
const FRigUnit_RigLogic_Data& Other |
RigUnit_RigLogic.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FRigUnit_RigLogic_Data() |
RigUnit_RigLogic.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MAX_ATTRS_PER_JOINT | const uint8 | RigUnit_RigLogic.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BlendShapeIndices | TArray< FRigUnit_RigLogic_IntArray > | RL mesh+blend shape array index to RL blend shape index for each LOD | RigUnit_RigLogic.h |
|
| CurrentLOD | uint32 | LOD for which the model is rendered | RigUnit_RigLogic.h |
|
| CurveElementIndicesForAnimMaps | TArray< FRigUnit_RigLogic_IntArray > | RL animated map index to ControlRig's output anim map curve index for each LOD | RigUnit_RigLogic.h |
|
| DriverJointsToControlAttributesMap | TArray< FBoneIndexControlAttributeMapping > | RL driver joint index to ControlRig's hierarchy bone index and RigLogic control attribute mapping | RigUnit_RigLogic.h |
|
| HierarchyBoneIndices | TArray< int32 > | RL joint index to ControlRig's hierarchy bone index | RigUnit_RigLogic.h |
|
| InputCurveIndices | TArray< int32 > | 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 type RL input index to ControlRig's input curve index | RigUnit_RigLogic.h |
|
| LocalRigRuntimeContext | TSharedPtr< FSharedRigRuntimeContext > | RigUnit_RigLogic.h | ||
| MorphTargetCurveIndices | TArray< FRigUnit_RigLogic_IntArray > | RL mesh blend shape index to ControlRig's output blendshape curve index for each LOD | RigUnit_RigLogic.h |
|
| NeuralNetMaskCurveIndices | TArray< int32 > | RL neural network mask index to ControlRig's input curve index | RigUnit_RigLogic.h |
|
| RigInstance | TUniquePtr< FRigInstance > | 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. | RigUnit_RigLogic.h | |
| RigLogicIndicesForAnimMaps | TArray< FRigUnit_RigLogic_IntArray > | RL animated map index to RL anim map curve index for each LOD | RigUnit_RigLogic.h |
|
| SkelMeshComponent | TWeakObjectPtr< USkeletalMeshComponent > | Cached Skeletal Mesh Component | RigUnit_RigLogic.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CalculateRigLogic
(
const URigHierarchy* InHierarchy, |
Calculates joint positions, orientation and scale based on inputs curves of the control rig | RigUnit_RigLogic.h | |
void InitializeRigLogic
(
const URigHierarchy* InHierarchy, |
RigUnit_RigLogic.h | ||
bool IsRigLogicInitialized() |
RigUnit_RigLogic.h | ||
void MapDriverJoints
(
const URigHierarchy* Hierarchy |
RigUnit_RigLogic.h | ||
void MapInputCurveIndices
(
const URigHierarchy* InHierarchy |
Makes a map of input curve indices from DNA file to the control rig curves | RigUnit_RigLogic.h | |
void MapJoints
(
const URigHierarchy* Hierarchy |
Uses names to map joint indices from DNA file to the indices of bones in control rig hierarchy | RigUnit_RigLogic.h | |
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 | RigUnit_RigLogic.h | |
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 |
RigUnit_RigLogic.h | |
void MapNeuralNetMaskCurveIndices
(
const URigHierarchy* InHierarchy |
Makes a map of neural net mask indices from DNA file to the control rig curves | RigUnit_RigLogic.h | |
void UpdateAnimMapCurves
(
URigHierarchy* InHierarchy, |
Updates anim map curve values based on values of input curves of the control rig | RigUnit_RigLogic.h | |
void UpdateBlendShapeCurves
(
URigHierarchy* InHierarchy, |
Updates morph target curve values based on values of input curves of the control rig | RigUnit_RigLogic.h | |
void UpdateJoints
(
URigHierarchy* Hierarchy, |
Updates joint positions in the hierarchy based on inputs curves of the control rig | RigUnit_RigLogic.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_RigLogic_Data & operator=
(
const FRigUnit_RigLogic_Data& Other |
RigUnit_RigLogic.h |