FSequencerTimeSliderController

A time slider controller for sequencer Draws and manages time data for a Sequencer

API > API/Editor > API/Editor/Sequencer

A time slider controller for sequencer Draws and manages time data for a Sequencer

   
Name FSequencerTimeSliderController
Type class
Header File /Engine/Source/Editor/Sequencer/Public/SequencerTimeSliderController.h
Include Path #include "SequencerTimeSliderController.h"

Syntax

class FSequencerTimeSliderController :  
    public ITimeSliderController,  
    public TSharedFromThis< FSequencerTimeSliderController >

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FSequencerTimeSliderController ( const FTimeSliderArgs& InArgs,
TWeakPtr< FSequencer > InWeakSequencer
)

   SequencerTimeSliderController.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSequencerTimeSliderController()

   SequencerTimeSliderController.h  

Structs

Name Remarks
FDrawTickArgs  
FScrubberMetrics  
FScrubRangeToScreen Utility struct for converting between scrub range space and local/absolute screen space

Enums

Protected

Name Remarks
EDragType Drag operations for this time controller

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMarkAtFrame ( const FFrameNumber InFrameNumber
)

   SequencerTimeSliderController.h  

void ClearMarkSelection()

   SequencerTimeSliderController.h  

void CommitScrubPosition ( FFrameTime NewValue,
bool bIsScrubbing,
bool bEvaluate
)

 Call this method when the user's interaction has changed the scrub position SequencerTimeSliderController.h  

FFrameTime ComputeFrameTimeFromMouse ( const FGeometry& Geometry,
FVector2D ScreenSpacePosition,
FScrubRangeToScreen RangeToScreen,
bool CheckSnapping
) const

   SequencerTimeSliderController.h  

FFrameTime ComputeScrubTimeFromMouse ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent,
FScrubRangeToScreen RangeToScreen
) const

   SequencerTimeSliderController.h  

void DeleteAllMarks()

   SequencerTimeSliderController.h  

void DeleteSelectedMarks()

   SequencerTimeSliderController.h  

float DetermineOptimalSpacing ( float InPixelsPerInput,
uint32 MinTick,
float MinTickSpacing
) const

 Determines the optimal spacing between tick marks in the slider for a given pixel density Increments until a minimum amount of slate units specified by MinTick is reached SequencerTimeSliderController.h  

TOptional< FFrameNumber > GetMarkFrameNumber ( const int32 InMarkIndex
) const

   SequencerTimeSliderController.h  

TSharedPtr< ISequencer > GetSequencer()

 End ITimeSliderController Interface Get the owning sequencer instance SequencerTimeSliderController.h  

bool HitTestMark ( const FGeometry& AllottedGeometry,
const FScrubRangeToScreen& RangeToScreen,
float HitPixel,
bool bTestLabelBox,
int32* OutMarkIndex,
FFrameNumber* OutMarkFrameNumber
) const

 Hit test marks SequencerTimeSliderController.h  

bool IsEvaluating()

   SequencerTimeSliderController.h  

void PanByDelta ( float InDelta
)

 Pan the range by a given delta SequencerTimeSliderController.h  

void SetIsEvaluating()

 Set that's evaluating SequencerTimeSliderController.h  

void SetMarkAtFrame ( const int32 InMarkIndex,
const FFrameNumber InFrameNumber
)

   SequencerTimeSliderController.h  

void SetPlaybackRangeEnd ( FFrameNumber NewEnd
)

   SequencerTimeSliderController.h  

void SetPlaybackRangeStart ( FFrameNumber NewStart
)

   SequencerTimeSliderController.h  

void SetSelectionRangeEnd ( FFrameNumber NewEnd
)

   SequencerTimeSliderController.h  

void SetSelectionRangeStart ( FFrameNumber NewStart
)

   SequencerTimeSliderController.h  

bool ZoomByDelta ( float InDelta,
float ZoomBias
)

 Zoom the range by a given delta. SequencerTimeSliderController.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void ClampViewRange ( double& NewRangeMin,
double& NewRangeMax
)

 Clamp the given range to the clamp range SequencerTimeSliderController.h  

virtual double ComputeHeight()

   SequencerTimeSliderController.h  

virtual FAnimatedRange GetClampRange()

 Get the current clamp range for this controller in seconds. SequencerTimeSliderController.h  

virtual FFrameRate GetDisplayRate()

 Get the current play rate for this controller SequencerTimeSliderController.h  

virtual ETimeSliderPlaybackStatus GetPlaybackStatus()

 Get the playback status for the controller, by default it is ETimeSliderPlaybackStatus::Stopped SequencerTimeSliderController.h  

virtual TRange< FFrameNumber > GetPlayRange()

 Get the current play range for this controller SequencerTimeSliderController.h  

virtual FScrubberMetrics GetScrubPixelMetrics ( const FQualifiedFrameTime& ScrubTime,
const FScrubRangeToScreen& RangeToScreen,
float DilationPixels
) const

 Get the pixel matrics of the Scrubber SequencerTimeSliderController.h  

virtual FFrameTime GetScrubPosition()

 Get the current time for the Scrub handle which indicates what range is being evaluated. SequencerTimeSliderController.h  

virtual TRange< FFrameNumber > GetSelectionRange()

 Get the selection range SequencerTimeSliderController.h  

virtual FFrameRate GetTickResolution()

 Get the current tick resolution for this controller SequencerTimeSliderController.h  

virtual TRange< FFrameNumber > GetTimeBounds()

 Get the time bounds for this controller. The time bounds should be a subset of the playback range. SequencerTimeSliderController.h  

virtual const FTimeSliderArgs & GetTimeSliderArgs()

   SequencerTimeSliderController.h  

virtual FAnimatedRange GetViewRange()

 Get the current view range for this controller SequencerTimeSliderController.h  

virtual FCursorReply OnCursorQuery ( const SWidget& OwnerWidget,
const FGeometry& MyGeometry,
const FPointerEvent& CursorEvent
) const

   SequencerTimeSliderController.h  

virtual FReply OnMouseButtonDoubleClick ( SWidget& OwnerWidget,
const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent
)

   SequencerTimeSliderController.h  

virtual FReply OnMouseButtonDown ( SWidget& OwnerWidget,
const FGeometry& InGeometry,
const FPointerEvent& InPointEvent
)

   SequencerTimeSliderController.h  

virtual FReply OnMouseButtonUp ( SWidget& OwnerWidget,
const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent
)

   SequencerTimeSliderController.h  

virtual FReply OnMouseMove ( SWidget& OwnerWidget,
const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent
)

   SequencerTimeSliderController.h  

virtual FReply OnMouseWheel ( SWidget& OwnerWidget,
const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent
)

   SequencerTimeSliderController.h  

virtual int32 OnPaintTimeSlider ( bool bMirrorLabels,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
) const

 ITimeSliderController Interface SequencerTimeSliderController.h  

virtual int32 OnPaintViewArea ( const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
bool bEnabled,
const FPaintViewAreaArgs& Args
) const

 Draws major tick lines in the section view SequencerTimeSliderController.h  

virtual FReply OnTimeSliderMouseMove ( SWidget& OwnerWidget,
const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent
)

   SequencerTimeSliderController.h  

virtual void SetClampRange ( double NewRangeMin,
double NewRangeMax
)

 Set a new clamp range based on a min, max SequencerTimeSliderController.h  

virtual void SetPlaybackStatus ( ETimeSliderPlaybackStatus InStatus
)

 Set the playback status for the controller SequencerTimeSliderController.h  

virtual void SetPlayRange ( FFrameNumber RangeStart,
int32 RangeDuration
)

 Set a new playback range based on a min, max SequencerTimeSliderController.h  

virtual void SetScrubPosition ( FFrameTime InTime,
bool bEvaluate
)

 Get the current time for the Scrub handle which indicates what range is being evaluated. SequencerTimeSliderController.h  

virtual void SetSelectionRange ( const TRange< FFrameNumber >& NewRange
)

 Set a new selection range SequencerTimeSliderController.h  

virtual void SetStoppedPosition ( FFrameTime InTime
)

 Set the current time for the handle when playback is stopped SequencerTimeSliderController.h  

virtual void SetViewRange ( double NewRangeMin,
double NewRangeMax,
EViewRangeInterpolation Interpolation
)

 Set a new range based on a min, max and an interpolation mode SequencerTimeSliderController.h  

Protected

Name Remarks Include Path Unreal Specifiers

void DrawHorizontalTrackSeparatorLines ( FSlateWindowElementList& OutDrawElements,
FDrawTickArgs& InArgs
) const

 Draw horizontal separator lines between tracks SequencerTimeSliderController.h  

void DrawLinearTicks ( FSlateWindowElementList& OutDrawElements,
const TRange< double >& ViewRange,
const FScrubRangeToScreen& RangeToScreen,
FDrawTickArgs& InArgs
) const

 Draw time tick marks SequencerTimeSliderController.h  

int32 DrawMarkedFrames ( const FGeometry& InGeometry,
const FScrubRangeToScreen& InRangeToScreen,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const ESlateDrawEffect& InDrawEffects,
bool bInDrawLabels
) const

 Draw the marked frames. SequencerTimeSliderController.h  

int32 DrawPlaybackRange ( const FGeometry& InGeometry,
const FSlateRect& InCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FScrubRangeToScreen& InRangeToScreen,
const FPaintPlaybackRangeArgs& InRangeArgs
) const

 Draw the playback range. SequencerTimeSliderController.h  

int32 DrawPlaybackRangeExcludedRegions ( const FGeometry& InGeometry,
const FSlateRect& InCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FScrubRangeToScreen& InRangeToScreen,
const FPaintPlaybackRangeArgs& InRangeArgs
) const

 Draw dimmed regions outside the playback range only. SequencerTimeSliderController.h  

int32 DrawPlaybackRangeMarkers ( const FGeometry& InGeometry,
const FSlateRect& InCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FScrubRangeToScreen& InRangeToScreen,
const FPaintPlaybackRangeArgs& InRangeArgs
) const

 Draw playback range start/end markers only. SequencerTimeSliderController.h  

int32 DrawScalingAnchors ( const FGeometry& AllottedGeometry,
const FScrubRangeToScreen& RangeToScreen,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const ESlateDrawEffect& DrawEffects
) const

 Draw any scaling anchors. SequencerTimeSliderController.h  

int32 DrawSelectionRange ( const FGeometry& InGeometry,
const FSlateRect& InCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FScrubRangeToScreen& InRangeToScreen,
const FPaintPlaybackRangeArgs& InRangeArgs
) const

 Draw the selection range. SequencerTimeSliderController.h  

int32 DrawSubSequenceRange ( const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FScrubRangeToScreen& RangeToScreen,
const FPaintPlaybackRangeArgs& Args
) const

 Draw the playback range. SequencerTimeSliderController.h  

int32 DrawSubSequenceRangeExcludedRegions ( const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FScrubRangeToScreen& RangeToScreen,
const FPaintPlaybackRangeArgs& Args
) const

 Draw dimmed regions outside the subsequence range only. SequencerTimeSliderController.h  

int32 DrawSubSequenceRangeHashMarks ( const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FScrubRangeToScreen& RangeToScreen,
const FPaintPlaybackRangeArgs& Args
) const

 Draw subsequence boundary hash marks only. SequencerTimeSliderController.h  

int32 DrawSubSequenceRangeMarkers ( const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FScrubRangeToScreen& RangeToScreen,
const FPaintPlaybackRangeArgs& Args
) const

 Draw subsequence range start/end markers only. SequencerTimeSliderController.h  

void DrawTicks ( FSlateWindowElementList& OutDrawElements,
const TRange< double >& ViewRange,
const FScrubRangeToScreen& RangeToScreen,
FDrawTickArgs& InArgs
) const

 Draw time tick marks SequencerTimeSliderController.h  

int32 DrawVerticalFrames ( const FGeometry& AllottedGeometry,
const FScrubRangeToScreen& RangeToScreen,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const ESlateDrawEffect& DrawEffects
) const

 Draw the vertical frames. SequencerTimeSliderController.h  

void EndAnyInProgressTransactionalDrag()

 Fire the End delegate for any transactional drag currently in progress and clear MouseDragType. SequencerTimeSliderController.h  

FScrubberMetrics GetHitTestScrubPixelMetrics ( const FScrubRangeToScreen& RangeToScreen
) const

   SequencerTimeSliderController.h  

void GetMarkLabelGeometry ( const FGeometry& AllottedGeometry,
const FScrubRangeToScreen& RangeToScreen,
const FMovieSceneMarkedFrame& MarkedFrame,
FVector2D& OutPosition,
FVector2D& OutSize,
bool& bIsDrawLeft
) const

 Get marked frame label box size SequencerTimeSliderController.h  

bool HitTestRangeEnd ( const FScrubRangeToScreen& RangeToScreen,
const TRange< double >& Range,
float HitPixel
) const

 Hit test the upper bound of a range SequencerTimeSliderController.h  

bool HitTestRangeStart ( const FScrubRangeToScreen& RangeToScreen,
const TRange< double >& Range,
float HitPixel
) const

 Hit test the lower bound of a range SequencerTimeSliderController.h  

void ResetMouseDown ( const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent
)

   SequencerTimeSliderController.h  

void ResetMouseInput()

   SequencerTimeSliderController.h  

FFrameTime SnapSequencerTime ( FFrameTime InTime
) const

   SequencerTimeSliderController.h  

FFrameTime SnapTimeToNearestKey ( const FPointerEvent& MouseEvent,
const FScrubRangeToScreen& RangeToScreen,
float CursorPos,
FFrameTime InTime
) const

   SequencerTimeSliderController.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual void HandleDragMark ( const FFrameNumber& InLastDiffFrame
)

   SequencerTimeSliderController.h  

virtual void HandleDragMark_NoDragType ( const int32 InMarkIndex
)

   SequencerTimeSliderController.h  

virtual FReply OnMouseButtonUp_ContextMenu ( SWidget& WidgetOwner,
const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent
)

   SequencerTimeSliderController.h  

virtual FReply OnMouseButtonUp_MouseDragType ( SWidget& WidgetOwner,
const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent,
const FScrubRangeToScreen& InRangeToScreen,
const FFrameTime& InMouseTime
)

   SequencerTimeSliderController.h  

virtual FReply OnMouseMove_LeftAndMiddleMouseDown ( const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent,
const bool bInFromTimeSlider,
const FScrubRangeToScreen& InRangeToScreen,
const USequencerSettings& InSequencerSettings
)

   SequencerTimeSliderController.h  

virtual FReply OnMouseMove_RightMouseDown ( const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent,
const USequencerSettings& InSequencerSettings
)

   SequencerTimeSliderController.h  

virtual FReply OnMouseMoveImpl ( SWidget& WidgetOwner,
const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent,
const bool bInFromTimeSlider
)

   SequencerTimeSliderController.h  

virtual TSharedPtr< SWidget > OpenContextMenu ( const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent
)

   SequencerTimeSliderController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page