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

Inheritance Hierarchy

References

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

Syntax

class UAnimPreviewInstance : public 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
Public variable int32 MontagePreviewStartSectionIdx  
Public variable TEnumAsByte< enum EMontagePreviewType > MontagePreviewType Shared parameters for previewing blendspace or animsequence

Constructors

  Type Name Description
Public function  

UAnimPreviewInstance ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddImpulseAtLocation ( FVector Impulse,
FVector Location,
FName BoneName
)

 Preview physics interaction
Public function FDelegateHandle

AddKeyCompleteDelegate ( FSimpleMulticastDelegate::FDelegate InOnSetKeyCompleteDelegate
)

 Add the delegate to be called when a key is set.
Public function void

EnableControllers ( bool bEnable
)

 Enable Controllers This is used by when editing, when controller has to be disabled
Public function FAnimNode_ModifyBone *

FindModifiedBone ( const FName& InBoneName,
bool bCurveController
)

 Finds an already modified bone
Public function UAnimSequence *  
Public function const TArray< FAnimNode_ModifyBone > & Returns all currently active bone controllers on this instance's proxy
Public function Const USkeletalMeshComponent * Gets the external debug skeletal mesh component we are debugging
Public function Const bool  
Public function bool  
Public function FAnimNode_ModifyBone &

ModifyBone ( const FName& InBoneName,
bool bCurveController
)

 Modifies a single bone.
Public function float  
Public function int32  
Public function int32

MontagePreview_FindLastSection ( int32 StartSectionIdx
)

  
Public function void  
Public function void

MontagePreview_JumpToPosition ( float NewPosition
)

  
Public function void  
Public function void Montage preview functions
Public function void  
Public function void

MontagePreview_PreviewNormal ( int32 FromSectionIdx,
bool bPlay
)

  
Public function void  
Public function void  
Public function void  
Public function void

MontagePreview_SetLoopAllSections ( bool bIsLooping
)

  
Public function void  
Public function void

MontagePreview_SetLooping ( bool bIsLooping
)

  
Public function void

MontagePreview_SetLoopNormal ( bool bIsLooping,
int32 PreferSectionIdx
)

  
Public function void

MontagePreview_SetPlaying ( bool bIsPlaying
)

  
Public function void

MontagePreview_SetReverse ( bool bInReverse
)

  
Public function void  
Public function void  
Public function void Refresh Curve Bone Controllers based on TransformCurves from Animation data
Public function void

RemoveBoneModification ( const FName& InBoneName,
bool bCurveController
)

 Removes an existing bone modification
Public function void Add the delegate to be called when a key is set.
Public function void

ResetModifiedBone ( bool bCurveController
)

 Reset all bone modified
Public function void Sets an external debug skeletal mesh component to use to debug
Public function void

SetForceRetargetBasePose ( bool ForceRetargetBasePose
)

  
Public function void

SetKey ()

 Convert current modified bone transforms (BoneControllers) to transform curves (CurveControllers) it does based on CurrentTime.
Public function void

SetSkeletalControlAlpha ( float SkeletalControlAlpha
)

 Set SkeletalControl Alpha

Overridden from UAnimSingleNodeInstance

  Type Name Description
Public function Virtual void

RestartMontage ( UAnimMontage* Montage,
FName FromSection
)

 Custom evaluate pose
Public function Virtual void

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

 Set New Asset - calls InitializeAnimation, for now we need MeshComponent

Overridden from UAnimInstance

  Type Name Description
Public function Virtual Const bool Can this animation instance run Update or Evaluation work in parallel.
Public function Virtual FAnimInstanceProxy * Override point for derived classes to create their own proxy objects (allows custom allocation)
Protected function Virtual void

Montage_Advance ( float DeltaSeconds
)

 Advance montages
Public function Virtual void The below functions are the native overrides for each phase Native initialization override point

Overridden from UObject

  Type Name Description
Public function Virtual void 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

On this page