1. Epic GamesDeveloper
  3. FAnimationRecorder

FAnimationRecorder

Records the mesh pose to animation input

API > API/Editor > API/Editor/SequenceRecorder

Records the mesh pose to animation input

   
Name FAnimationRecorder
Type struct
Header File /Engine/Source/Editor/SequenceRecorder/Public/AnimationRecorder.h
Include Path #include "AnimationRecorder.h"

Syntax

struct FAnimationRecorder : public FGCObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FAnimationRecorder()

   AnimationRecorder.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FAnimationRecorder()

   AnimationRecorder.h  

Structs

Name Remarks
FRecordedAnimNotify  

Constants

Name Type Remarks Include Path
DefaultSampleRate float   AnimationRecorder.h
UnBoundedFrameCount const int32 Frame count used to signal an unbounded animation AnimationRecorder.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimationSerializer FAnimationSerializer * Serializer, if set we also store data out incrementally while running AnimationRecorder.h  
bAutoSaveAsset uint8 If true, asset will be saved to disk after recording. AnimationRecorder.h  
bCheckDeltaTimeAtBeginning uint8 If true we check delta time at beginning of recording AnimationRecorder.h  
bRecordAttributeCurves uint8 Whether or not to record attribute curves AnimationRecorder.h  
bRecordLocalToWorld uint8 If true, it will record root to include LocalToWorld AnimationRecorder.h  
bRecordMaterialCurves uint8 Whether or not to record material curves AnimationRecorder.h  
bRecordMorphTargets uint8 Whether or not to record morph targets AnimationRecorder.h  
bRecordTransforms uint8 Whether or not to record transforms AnimationRecorder.h  
bRemoveRootTransform uint8 If true, the root bone transform will be removed from all bone transforms AnimationRecorder.h  
bTransactRecording bool Whether or not to transact any IAnimationDataController changes AnimationRecorder.h  
ExcludeAnimationNames TArray< FString > Exclude list AnimationRecorder.h  
IncludeAnimationNames TArray< FString > Include list AnimationRecorder.h  
InterpMode ERichCurveInterpMode The interpolation mode for the recorded keys AnimationRecorder.h  
Interpolation EAnimInterpolationType Interpolation type for the recorded sequence AnimationRecorder.h  
TangentMode ERichCurveTangentMode The tangent mode for the recorded keys AnimationRecorder.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AnimationObject TObjectPtr< UAnimSequence >   AnimationRecorder.h  
GetCurrentFrameTimeFunction TFunction< TOptional< FQualifiedFrameTime >()> This function returns the current timecode that the recorder should use to label the current frame AnimationRecorder.h  
InitialRootTransform FTransform   AnimationRecorder.h  
InvInitialRootTransform FTransform   AnimationRecorder.h  
LastFrame FFrameNumber   AnimationRecorder.h  
MaxFrame FFrameNumber   AnimationRecorder.h  
PreviousAnimCurves FBlendedHeapCurve   AnimationRecorder.h  
PreviousComponentToWorld FTransform   AnimationRecorder.h  
PreviousSpacesBases TArray< FTransform >   AnimationRecorder.h  
RawTracks TArray< FRawAnimSequenceTrack >   AnimationRecorder.h  
RecordedAnimNotifies TArray< FRecordedAnimNotify > Notify events recorded at any point, processed and inserted into animation when recording has finished AnimationRecorder.h  
RecordedCurves TArray< FBlendedHeapCurve >   AnimationRecorder.h  
RecordedTimes TArray< FQualifiedFrameTime > Array of times recorded AnimationRecorder.h  
RecordingAnimNotifies TArray< FRecordedAnimNotify > Currently recording notify events that have duration AnimationRecorder.h  
RecordingRate FFrameRate   AnimationRecorder.h  
SkeletonRootIndex int32   AnimationRecorder.h  
TimePassed double   AnimationRecorder.h  
UniqueNotifies TMap< UAnimNotify *, UAnimNotify * > Unique notifies added to this sequence during recording AnimationRecorder.h  
UniqueNotifyStates TMap< UAnimNotifyState *, UAnimNotifyState * > Unique notify states added to this sequence during recording AnimationRecorder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UAnimSequence * GetAnimationObject()

   AnimationRecorder.h  

const FTransform & GetInitialRootTransform()

   AnimationRecorder.h  

double GetTimeRecorded()

   AnimationRecorder.h  

bool InRecording()

   AnimationRecorder.h  

void ProcessRecordedTimes ( UAnimSequence* AnimSequence,
USkeletalMeshComponent* SkeletalMeshComponent,
const FString& HoursName,
const FString& MinutesName,
const FString& SecondsName,
const FString& FramesName,
const FString& SubFramesName,
const FString& SlateName,
const FString& Slate,
const FTimecodeBoneMethod& TimecodeBoneMethod
)

   AnimationRecorder.h  

void ProcessRecordedTimes ( UAnimSequence* AnimSequence,
USkeletalMeshComponent* SkeletalMeshComponent,
const FTimecodeBoneMethod& TimecodeBoneMethod,
const FProcessRecordedTimeParams& TimecodeInfo
)

 Process any time data captured and apply it to the bones on the given SkeletalMeshComponent. AnimationRecorder.h  

bool SetAnimCompressionScheme ( UAnimBoneCompressionSettings* Settings
)

   AnimationRecorder.h  

void SetCurrentFrameTimeGetter ( TFunction< TOptional< FQualifiedFrameTime >()> InGetCurrentTimeFunction
)

 Sets the function that should be used to get the current timecode for the current frame. AnimationRecorder.h  

void SetSampleRateAndLength ( FFrameRate SampleFrameRate,
float LengthInSeconds
)

 Sets a new sample rate & max length for this recorder. Don't call while recording. AnimationRecorder.h  

void StartRecord ( USkeletalMeshComponent* Component,
UAnimSequence* InAnimationObject
)

   AnimationRecorder.h  

UAnimSequence * StopRecord ( bool bShowMessage
)

   AnimationRecorder.h  
Starts recording an animation. Prompts for asset path and name via dialog if none provided AnimationRecorder.h  

bool TriggerRecordAnimation ( USkeletalMeshComponent* Component,
const FString& AssetPath,
const FString& AssetName
)

   AnimationRecorder.h  

void UpdateRecord ( USkeletalMeshComponent* Component,
float DeltaTime
)

   AnimationRecorder.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

 FGCObject interface start. AnimationRecorder.h  

virtual FString GetReferencerName()

   AnimationRecorder.h  

Static

Name Remarks Include Path Unreal Specifiers

static void GetBoneTransforms ( USkeletalMeshComponent* Component,
TArray< FTransform >& BoneTransforms
)

 Helper function to get space bases depending on leader pose component AnimationRecorder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page