Navigation
API > API/Plugins > API/Plugins/RigMapper
| Name | FAnimNode_RigMapper |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Animation/RigMapper/Source/RigMapper/Public/AnimNode_RigMapper.h |
| Include Path | #include "AnimNode_RigMapper.h" |
Syntax
USTRUCT (BlueprintInternalUseOnly)
struct FAnimNode_RigMapper : public FAnimNode_Base
Inheritance Hierarchy
- FAnimNode_Base → FAnimNode_RigMapper
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAnimNode_RigMapper() |
AnimNode_RigMapper.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAnimNode_RigMapper() |
AnimNode_RigMapper.h |
Structs
| Name | Remarks |
|---|---|
| FRigMapperCurveMapping | Base curve mapping for bulk get/set of the linked pose curves. |
| FRigMapperOutputCurveMapping | Curve mapping for bulk set of the linked pose curves with a mapping to the matching input to allow lerping with the current curve value. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FInputCurveMappings | UE::Anim::TNamedValueArray< FDefaultAllocator, FRigMapperCurveMapping > | Input curve mapping for bulk get of the linked pose curve values. | AnimNode_RigMapper.h |
| FOutputCurveMappings | UE::Anim::TNamedValueArray< FDefaultAllocator, FRigMapperOutputCurveMapping > | Output curve mapping for the bulk get of the linked pose curve values. | AnimNode_RigMapper.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Alpha | float | AnimNode_RigMapper.h |
|
|
| Definitions | TArray< TObjectPtr< URigMapperDefinition > > | AnimNode_RigMapper.h |
|
|
| LODThreshold | int32 | Max LOD that this node is allowed to run For example if you have LODThreshold to be 2, it will run until LOD 2 (based on 0 index) when the component LOD becomes 3, it will stop update/evaluate currently transition would be issue and that has to be re-visited | AnimNode_RigMapper.h |
|
| SourcePose | FPoseLink | AnimNode_RigMapper.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedInputValues | FRigMapperProcessor::FPoseValues | The cached input values passed to the rig mapper processor to avoid reallocations. | AnimNode_RigMapper.h | |
| CachedOutputValues | FRigMapperProcessor::FPoseValues | The cached output values passed to the rig mapper processor to avoid reallocations. | AnimNode_RigMapper.h | |
| InputCurveMappings | FInputCurveMappings | AnimNode_RigMapper.h | ||
| LoadedDefinitions | TArray< TObjectPtr< URigMapperDefinition > > | The definitions that we have loaded. Cached to check against changes and reinit if need be. | AnimNode_RigMapper.h | |
| LoadedUserData | TObjectPtr< URigMapperDefinitionUserData > | The asset user data currently used to override definitions, if any was set on the skeletal mesh. | AnimNode_RigMapper.h | |
| OutputCurveMappings | FOutputCurveMappings | AnimNode_RigMapper.h | ||
| RigMapperProcessor | FRigMapperProcessor | The processor to evaluate the rig mapping. | AnimNode_RigMapper.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EvaluateRigMapping
(
FPoseContext& Output |
Evaluate the new curve values using the initialized rig mappers and sets the new output pose. | AnimNode_RigMapper.h | |
bool InitializeRigMapping
(
USkeletalMesh* TargetMesh |
Initialize the rig mapper(s) from the current definitions or SKM asset user data and cache the curve indices & index mappings needed for evaluation. | AnimNode_RigMapper.h |
Overridden from FAnimNode_Base
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CacheBones_AnyThread
(
const FAnimationCacheBonesContext& Context |
AnimNode_RigMapper.h | ||
virtual void Evaluate_AnyThread
(
FPoseContext& Output |
AnimNode_RigMapper.h | ||
virtual void GatherDebugData
(
FNodeDebugData& DebugData |
AnimNode_RigMapper.h | ||
virtual int32 GetLODThreshold() |
AnimNode_RigMapper.h | ||
virtual bool HasPreUpdate() |
AnimNode_RigMapper.h | ||
virtual void Initialize_AnyThread
(
const FAnimationInitializeContext& Context |
AnimNode_RigMapper.h | ||
virtual void OnInitializeAnimInstance
(
const FAnimInstanceProxy* InProxy, |
AnimNode_RigMapper.h | ||
virtual void PreUpdate
(
const UAnimInstance* InAnimInstance |
AnimNode_RigMapper.h | ||
virtual void Update_AnyThread
(
const FAnimationUpdateContext& Context |
AnimNode_RigMapper.h |