UAnimPreviewInstance

This Instance only contains one AnimationAsset, and produce poses Used by Preview in AnimGraph, Playing single animation in Kismet2 and etc

Unreal Engine C++ API Reference > Editor > AnimGraph

Inheritance Hierarchy

References

   
Module AnimGraph
Header /Engine/Source/Editor/AnimGraph/Public/AnimPreviewInstance.h
Include #include "AnimPreviewInstance.h"

Syntax

class UAnimPreviewInstance : public [UAnimSingleNodeInstance](API\Runtime\Engine\Animation\UAnimSingleNodeInstance)  

Remarks

This Instance only contains one AnimationAsset, and produce poses Used by Preview in AnimGraph, Playing single animation in Kismet2 and etc

Variables

Type Name Description
int32 MontagePreviewStartSectionIdx  
TEnumAsByte< en... MontagePreviewType Shared parameters for previewing blendspace or animsequence

Constructors

Type Name Description
  UAnimPreviewInstance ( const FObjectInitializer& ObjectIn... )  

Functions

Type Name Description
void AddImpulseAtLocation ( FVector Impulse, FVector Location, FName BoneName ) Preview physics interaction
FDelegateHan... AddKeyCompleteDelegate ( FSimpleMulticastDelegate::FDelegate... ) Add the delegate to be called when a key is set.
void EnableControllers ( bool bEnable ) Enable Controllers This is used by when editing, when controller has to be disabled
FAnimNode_Mo... FindModifiedBone ( const FName& InBoneName, bool bCurveController ) Finds an already modified bone
UAnimSequenc... GetAnimSequence ()  
const TArray... GetBoneControllers () Returns all currently active bone controllers on this instance's proxy
USkeletalMes... GetDebugSkeletalMeshComponent () Gets the external debug skeletal mesh component we are debugging
bool GetForceRetargetBasePose ()  
bool IsPlayingMontage ()  
FAnimNode_Mo... ModifyBone ( const FName& InBoneName, bool bCurveController ) Modifies a single bone.
float MontagePreview_CalculateStepLength ()  
int32 MontagePreview_FindFirstSectionAsInMontage ( int32 AnySectionIdx )  
int32 MontagePreview_FindLastSection ( int32 StartSectionIdx )  
void MontagePreview_JumpToEnd ()  
void MontagePreview_JumpToPosition ( float NewPosition )  
void MontagePreview_JumpToPreviewStart ()  
void MontagePreview_JumpToStart () Montage preview functions
void MontagePreview_PreviewAllSections ( bool bPlay )  
void MontagePreview_PreviewNormal ( int32 FromSectionIdx, bool bPlay )  
void MontagePreview_RemoveBlendOut ()  
void MontagePreview_ResetSectionsOrder ()  
void MontagePreview_Restart ()  
void MontagePreview_SetLoopAllSections ( bool bIsLooping )  
void MontagePreview_SetLoopAllSetupSections ( bool bIsLooping )  
void MontagePreview_SetLooping ( bool bIsLooping )  
void MontagePreview_SetLoopNormal ( bool bIsLooping, int32 PreferSectionIdx )  
void MontagePreview_SetPlaying ( bool bIsPlaying )  
void MontagePreview_SetReverse ( bool bInReverse )  
void MontagePreview_StepBackward ()  
void MontagePreview_StepForward ()  
void RefreshCurveBoneControllers () Refresh Curve Bone Controllers based on TransformCurves from Animation data
void RemoveBoneModification ( const FName& InBoneName, bool bCurveController ) Removes an existing bone modification
void RemoveKeyCompleteDelegate ( FDelegateHandle InDelegateHandle ) Add the delegate to be called when a key is set.
void ResetModifiedBone ( bool bCurveController ) Reset all bone modified
void SetDebugSkeletalMeshComponent ( USkeletalMeshComponent* InSkel... ) Sets an external debug skeletal mesh component to use to debug
void SetForceRetargetBasePose ( bool ForceRetargetBasePose )  
void SetKey () Convert current modified bone transforms (BoneControllers) to transform curves (CurveControllers) it does based on CurrentTime.
void SetSkeletalControlAlpha ( float SkeletalControlAlpha ) Set SkeletalControl Alpha

Overridden from UAnimSingleNodeInstance

Type Name Description
void RestartMontage ( UAnimMontage* Montage, FName FromSection ) Custom evaluate pose
void SetAnimationAsset ( UAnimationAsset* NewAsset, bool bIsLooping, float InPlayRate ) Set New Asset - calls InitializeAnimation, for now we need MeshComponent

Overridden from UAnimInstance

Type Name Description
bool CanRunParallelWork () Can this animation instance run Update or Evaluation work in parallel.
FAnimInstanc... CreateAnimInstanceProxy () Override point for derived classes to create their own proxy objects (allows custom allocation)
void Montage_Advance ( float DeltaSeconds ) Advance montages
void NativeInitializeAnimation () The below functions are the native overrides for each phase Native initialization override point

Overridden from UObject

Type Name Description
void Serialize ( FArchive& Ar ) Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library