FRigUnit_RigLogic_Data

The work data used by the [FRigUnit_RigLogic](API\Plugins\RigLogicModule\FRigUnit_RigLogic)

Windows
MacOS
Linux

References

Module

RigLogicModule

Header

/Engine/Plugins/Animation/RigLogic/Source/RigLogicModule/Public/RigUnit_RigLogic.h

Include

#include "RigUnit_RigLogic.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)(Meta=(DocumentationPolicy="Strict"))
struct FRigUnit_RigLogic_Data

Remarks

The work data used by the FRigUnit_RigLogic

Variables

Name Description

Public variable UProperty Transient

TArray< FRigUni...

 

BlendShapeIndices

RL mesh+blend shape array index to RL blend shape index for each LOD

Public variable UProperty Transient

uint32

 

CurrentLOD

LOD for which the model is rendered

Public variable UProperty Transient

TArray< FRigUni...

 

CurveContainerIndicesForAnimMaps

RL animated map index to ControlRig's output anim map curve index for each LOD

Public variable UProperty Transient

TArray< int32 >

 

HierarchyBoneIndices

RL joint index to ControlRig's hierarchy bone index

Public variable UProperty Transient

TArray< int32 >

 

InputCurveIndices

Mapping RL indices to UE indices

Public variable UProperty Transient

TArray< FRigUni...

 

MorphTargetCurveIndices

RL mesh blend shape index to ControlRig's output blendshape curve index for each LOD

Public variable

TUniquePtr< FRi...

 

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.

Public variable UProperty Transient

TArray< FRigUni...

 

RigLogicIndicesForAnimMaps

RL animated map index to RL anim map curve index for each LOD

Public variable

FSharedRigRunti...

 

SharedRigRuntimeContext

Public variable UProperty Transient

TWeakObjectPtr<...

 

SkelMeshComponent

Cached Skeletal Mesh Component

Constructors

Name Description

Public function

FRigUnit_RigLogic_Data()

Public function

FRigUnit_RigLogic_Data

(
    const FRigUnit_RigLogic_Data& Othe...
)

Destructors

Name Description

Public function

~FRigUnit_RigLogic_Data()

Functions

Name Description

Public function

void

 

CacheVariableJointIndices()

Cache the joint indices that change per each LOD

Public function

void

 

CalculateRigLogic

(
    const FRigCurveContainer* Curv...
)

Calculates joint positions, orientation and scale based on inputs curves of the control rig

Public function

void

 

InitializeRigLogic

(
    const FRigBoneHierarchy* BoneH...,
    const FRigCurveContainer* Curv...
)

Public function

bool

 

IsRigLogicInitialized()

Public function

void

 

MapInputCurveIndices

(
    const FRigCurveContainer* Curv...
)

Makes a map of input curve indices from DNA file to the control rig curves

Public function

void

 

MapJoints

(
    const FRigBoneHierarchy* Hiera...
)

Uses names to map joint indices from DNA file to the indices of bones in control rig hierarchy

Public function

void

 

MapMaskMultipliers

(
    const FRigCurveContainer* Curv...
)

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

Public function

void

 

MapMorphTargets

(
    const FRigCurveContainer* Curv...
)

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 __

Public function

void

 

UpdateAnimMapCurves

(
    FRigCurveContainer* CurveConta...,
    TArrayView< const float > AnimMapOu...
)

Updates anim map curve values based on values of input curves of the control rig

Public function

void

 

UpdateBlendShapeCurves

(
    FRigCurveContainer* CurveConta...,
    TArrayView< const float > BlendShap...
)

Updates morph target curve values based on values of input curves of the control rig

Public function

void

 

UpdateJoints

(
    FRigHierarchyContainer* Hierar...,
    const FRigUnit_RigLogic_JointUpdate...
)

Updates joint positions in the hierarchy based on inputs curves of the control rig

Operators

Name Description

Public function

FRigUnit_Rig...

 

operator=

(
    const FRigUnit_RigLogic_Data& Othe...
)

Constants

Name

Description

MAX_ATTRS_PER_JOINT

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss