FTimelineModel

Extremely basic data-model for the timeline widget.

API > API/Plugins > API/Plugins/AnimDatabaseEditor

Extremely basic data-model for the timeline widget. Stores information about various ranges, as well as playback state etc. Contains mainly just some basic getters and setters, as well as some functions that can be used within callbacks.

For the UAnimDatabaseDatabase we usually want to work in frames (given we have a fixed-framerate for all animations) so this model stores everything in terms of frames where possible (rather than in terms of time).

   
Name FTimelineModel
Type struct
Header File /Engine/Plugins/Experimental/Animation/AnimDatabase/Source/AnimDatabaseEditor/Public/AnimDatabaseEditorTimeline.h
Include Path #include "AnimDatabaseEditorTimeline.h"

Syntax

struct FTimelineModel

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bLooping bool If looping is enabled AnimDatabaseEditorTimeline.h  
bSnapOnFrames bool If to snap the scrubbing to discrete frames AnimDatabaseEditorTimeline.h  
bUseCustomPlaybackRate bool If to use CustomPlaybackRate or the standard PlaybackRate AnimDatabaseEditorTimeline.h  
CustomPlaybackRate float Custom Playback Rate when used AnimDatabaseEditorTimeline.h  
FrameRate FFrameRate Current FrameRate - should match that of the database AnimDatabaseEditorTimeline.h  
FrameTime FFrameTime Current FrameTime for the scrubber AnimDatabaseEditorTimeline.h  
PlaybackMode EPlaybackMode::Type Playback State AnimDatabaseEditorTimeline.h  
PlaybackRange TRange< FFrameNumber > Current Active Playback Range AnimDatabaseEditorTimeline.h  
PlaybackRate float Playback Rate AnimDatabaseEditorTimeline.h  
ViewRange TRange< FFrameNumber > Current Active View Range AnimDatabaseEditorTimeline.h  
WorkingRange TRange< FFrameNumber > Current Active Working Range AnimDatabaseEditorTimeline.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetLooping()

   AnimDatabaseEditorTimeline.h  

float GetTimelineCustomPlaybackRate()

   AnimDatabaseEditorTimeline.h  

FFrameRate GetTimelineFrameRate()

   AnimDatabaseEditorTimeline.h  

FFrameTime GetTimelineFrameTime()

   AnimDatabaseEditorTimeline.h  

TRange< FFrameNumber > GetTimelinePlaybackRangeFrames()

   AnimDatabaseEditorTimeline.h  

float GetTimelinePlaybackRate()

   AnimDatabaseEditorTimeline.h  

bool GetTimelineSnapOnFrames()

   AnimDatabaseEditorTimeline.h  

bool GetTimelineUseCustomPlaybackRate()

   AnimDatabaseEditorTimeline.h  

TRange< FFrameNumber > GetTimelineViewRange()

   AnimDatabaseEditorTimeline.h  

FAnimatedRange GetTimelineViewRangeTimes()

   AnimDatabaseEditorTimeline.h  

TRange< FFrameNumber > GetTimelineWorkingRange()

   AnimDatabaseEditorTimeline.h  

FAnimatedRange GetTimelineWorkingRangeTimes()

   AnimDatabaseEditorTimeline.h  

EPlaybackMode::Type GetTransportPlaybackMode()

   AnimDatabaseEditorTimeline.h  

void OnTransportPlayPressed()

   AnimDatabaseEditorTimeline.h  

void OnTransportStepBackward()

   AnimDatabaseEditorTimeline.h  

void OnTransportStepForward()

   AnimDatabaseEditorTimeline.h  

void OnTransportToEndFrame()

   AnimDatabaseEditorTimeline.h  

void OnTransportToStartFrame()

   AnimDatabaseEditorTimeline.h  

void SetLooping ( const bool bLooping
)

   AnimDatabaseEditorTimeline.h  

void SetTimelineCustomPlaybackRate ( const float InCustomPlaybackRate
)

   AnimDatabaseEditorTimeline.h  

void SetTimelineFrameRate ( const FFrameRate InFrameRate
)

   AnimDatabaseEditorTimeline.h  

void SetTimelineFrameTime ( const FFrameTime InFrameTime
)

   AnimDatabaseEditorTimeline.h  

void SetTimelinePlaybackRange ( const TRange< FFrameNumber > InPlaybackRange
)

   AnimDatabaseEditorTimeline.h  

void SetTimelinePlaybackRate ( const float InPlaybackRate
)

   AnimDatabaseEditorTimeline.h  

void SetTimelineSnapOnFrames ( const bool bInSnapOnFrames
)

   AnimDatabaseEditorTimeline.h  

void SetTimelineUseCustomPlaybackRate ( const bool bInUseCustomPlaybackRate
)

   AnimDatabaseEditorTimeline.h  

void SetTimelineViewRange ( const TRange< FFrameNumber > InViewRange
)

   AnimDatabaseEditorTimeline.h  

void SetTimelineViewRangeTimes ( const FAnimatedRange InViewRange
)

   AnimDatabaseEditorTimeline.h  

void SetTimelineWorkingRange ( const TRange< FFrameNumber > InWorkingRange
)

   AnimDatabaseEditorTimeline.h  

void SetTimelineWorkingRangeTimes ( const FAnimatedRange InWorkingRange
)

   AnimDatabaseEditorTimeline.h  

void SetTransportPlaybackMode ( const EPlaybackMode::Type InPlaybackMode
)

   AnimDatabaseEditorTimeline.h  

void UpdateTimelineFrameTime ( const float DeltaTime
)

   AnimDatabaseEditorTimeline.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page