1. Epic GamesDeveloper
  3. UAnimPreviewInstance

UAnimPreviewInstance

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

API > API/Editor > API/Editor/AnimGraph

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

   
Name UAnimPreviewInstance
Type class
Header File /Engine/Source/Editor/AnimGraph/Public/AnimPreviewInstance.h
Include Path #include "AnimPreviewInstance.h"

Syntax

UCLASS (MinimalAPI, Transient, NotBlueprintable, NotEditInlineNew)  
class UAnimPreviewInstance : public UAnimSingleNodeInstance

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimPreviewInstance ( const FObjectInitializer& ObjectInitializer
)

   AnimPreviewInstance.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
MontagePreviewStartSectionIdx int32   AnimPreviewInstance.h
  • Transient
MontagePreviewType TEnumAsByte< enum EMontagePreviewType > Shared parameters for previewing blendspace or animsequence AnimPreviewInstance.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddImpulseAtLocation ( FVector Impulse,
FVector Location,
FName BoneName
)

 Preview physics interaction AnimPreviewInstance.h  

FDelegateHandle AddKeyCompleteDelegate ( FSimpleMulticastDelegate::FDelegate InOnSetKeyCompleteDelegate
)

 Add the delegate to be called when a key is set. AnimPreviewInstance.h  

void EnableControllers ( bool bEnable
)

 Enable Controllers This is used by when editing, when controller has to be disabled AnimPreviewInstance.h  

FAnimNode_ModifyBone * FindModifiedBone ( const FName& InBoneName,
bool bCurveController
)

 Finds an already modified bone AnimPreviewInstance.h  

UAnimSequence * GetAnimSequence()

   AnimPreviewInstance.h  

const TArray< FAnimNode_ModifyBone > & GetBoneControllers()

 Returns all currently active bone controllers on this instance's proxy AnimPreviewInstance.h  

USkeletalMeshComponent * GetDebugSkeletalMeshComponent()

 Gets the external debug skeletal mesh component we are debugging AnimPreviewInstance.h  

bool IsPlayingMontage()

   AnimPreviewInstance.h  

FAnimNode_ModifyBone & ModifyBone ( const FName& InBoneName,
bool bCurveController
)

 Modifies a single bone. AnimPreviewInstance.h  

float MontagePreview_CalculateStepLength()

   AnimPreviewInstance.h  

int32 MontagePreview_FindFirstSectionAsInMontage ( int32 AnySectionIdx
)

   AnimPreviewInstance.h  

int32 MontagePreview_FindLastSection ( int32 StartSectionIdx
)

   AnimPreviewInstance.h  

void MontagePreview_JumpToEnd()

   AnimPreviewInstance.h  

void MontagePreview_JumpToPosition ( float NewPosition
)

   AnimPreviewInstance.h  

void MontagePreview_JumpToPreviewStart()

   AnimPreviewInstance.h  

void MontagePreview_JumpToStart()

 Montage preview functions AnimPreviewInstance.h  

void MontagePreview_PreviewAllSections ( bool bPlay
)

   AnimPreviewInstance.h  

void MontagePreview_PreviewNormal ( int32 FromSectionIdx,
bool bPlay
)

   AnimPreviewInstance.h  

void MontagePreview_RemoveBlendOut()

   AnimPreviewInstance.h  

void MontagePreview_ResetSectionsOrder()

   AnimPreviewInstance.h  

void MontagePreview_Restart()

   AnimPreviewInstance.h  

void MontagePreview_SetLoopAllSections ( bool bIsLooping
)

   AnimPreviewInstance.h  

void MontagePreview_SetLoopAllSetupSections ( bool bIsLooping
)

   AnimPreviewInstance.h  

void MontagePreview_SetLooping ( bool bIsLooping
)

   AnimPreviewInstance.h  

void MontagePreview_SetLoopNormal ( bool bIsLooping,
int32 PreferSectionIdx
)

   AnimPreviewInstance.h  

void MontagePreview_SetPlaying ( bool bIsPlaying
)

   AnimPreviewInstance.h  

void MontagePreview_SetReverse ( bool bInReverse
)

   AnimPreviewInstance.h  

void MontagePreview_StepBackward()

   AnimPreviewInstance.h  

void MontagePreview_StepForward()

   AnimPreviewInstance.h  

void RefreshCurveBoneControllers()

 Refresh Curve Bone Controllers based on TransformCurves from Animation data AnimPreviewInstance.h  

void RemoveBoneModification ( const FName& InBoneName,
bool bCurveController
)

 Removes an existing bone modification AnimPreviewInstance.h  

void RemoveKeyCompleteDelegate ( FDelegateHandle InDelegateHandle
)

 Add the delegate to be called when a key is set. AnimPreviewInstance.h  

void ResetModifiedBone ( bool bCurveController
)

 Reset all bone modified AnimPreviewInstance.h  

void SetDebugSkeletalMeshComponent ( USkeletalMeshComponent* InSkeletalMeshComponent
)

 Sets an external debug skeletal mesh component to use to debug AnimPreviewInstance.h  

void SetKey ()

 Convert current modified bone transforms (BoneControllers) to transform curves (CurveControllers) it does based on CurrentTime. AnimPreviewInstance.h  

void SetSkeletalControlAlpha ( float SkeletalControlAlpha
)

 Set SkeletalControl Alpha AnimPreviewInstance.h  

Overridden from UAnimSingleNodeInstance

Name Remarks Include Path Unreal Specifiers

virtual void RestartMontage ( UAnimMontage* Montage,
FName FromSection
)

   AnimPreviewInstance.h  

virtual void SetAnimationAsset ( UAnimationAsset* NewAsset,
bool bIsLooping,
float InPlayRate
)

   AnimPreviewInstance.h  

Overridden from UAnimInstance

Name Remarks Include Path Unreal Specifiers

virtual bool CanRunParallelWork()

   AnimPreviewInstance.h  

virtual FAnimInstanceProxy * CreateAnimInstanceProxy()

   AnimPreviewInstance.h  

virtual void NativeInitializeAnimation()

   AnimPreviewInstance.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

   AnimPreviewInstance.h  

Protected

Overridden from UAnimInstance

Name Remarks Include Path Unreal Specifiers

virtual void Montage_Advance ( float DeltaTime
)

   AnimPreviewInstance.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page