1. Epic GamesDeveloper
  3. FSequencerTimeSliderController

FSequencerTimeSliderController

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

Unreal Engine C++ API Reference > Editor > Sequencer

Inheritance Hierarchy

References

   
Module Sequencer
Header /Engine/Source/Editor/Sequencer/Public/SequencerTimeSliderController.h
Include #include "SequencerTimeSliderController.h"

Syntax

class FSequencerTimeSliderController :  
    public ITimeSliderController,  
    public TSharedFromThis< FSequencerTimeSliderController >

Remarks

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

Constructors

  Type Name Description
Public function  

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

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual void

ClampViewRange ( double& NewRangeMin,
double& NewRangeMax
)

 Clamp the given range to the clamp range
Public function Const float

DetermineOptimalSpacing ( float InPixelsPerInput,
uint32 MinTick,
float MinTickSpacing
)

 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
Public function void

PanByDelta ( float InDelta
)

 Pan the range by a given delta
Public function void Set that's evaluating
Public function bool

ZoomByDelta ( float InDelta,
float ZoomBias
)

 Zoom the range by a given delta.

Overridden from ITimeSliderController

  Type Name Description
Public function Virtual Const FAnimatedRange Get the current clamp range for this controller in seconds.
Public function Virtual Const FFrameRate End ITimeSliderController Interface Get the current play rate for this controller
Public function Virtual Const ETimeSliderPlaybackStatus Get the playback status for the controller, by default it is ETimeSliderPlaybackStatus::Stopped
Public function Virtual Const TRange< FFrameNumber > Get the current play range for this controller
Public function Virtual Const FFrameTime Get the current time for the Scrub handle which indicates what range is being evaluated.
Public function Virtual Const TRange< FFrameNumber > Get the selection range
Public function Virtual Const FFrameRate Get the current tick resolution for this controller
Public function Virtual Const FAnimatedRange Get the current view range for this controller
Public function Virtual Const FCursorReply

OnCursorQuery ( TSharedRef< const SWidget > WidgetOwner,
const FGeometry& MyGeometry,
const FPointerEvent& CursorEvent
)

  
Public function Virtual FReply

OnMouseButtonDoubleClick ( TSharedRef< const SWidget > WidgetOwner,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual Const int32

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

 ITimeSliderController Interface
Public function Virtual Const int32

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

 Draws major tick lines in the section view
Public function Virtual FReply

OnTimeSliderMouseMove ( SWidget& OwnerWidget,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual void

SetClampRange ( double NewRangeMin,
double NewRangeMax
)

 Set a new clamp range based on a min, max
Public function Virtual void

SetPlaybackStatus ( ETimeSliderPlaybackStatus InStatus
)

 Set the playback status for the controller
Public function Virtual void

SetPlayRange ( FFrameNumber RangeStart,
int32 RangeDuration
)

 Set a new playback range based on a min, max
Public function Virtual void

SetScrubPosition ( FFrameTime InTime,
bool bEvaluate
)

 Get the current time for the Scrub handle which indicates what range is being evaluated.
Public function Virtual void

SetSelectionRange ( const TRange< FFrameNumber >& NewRange
)

 Set a new selection range
Public function Virtual void

SetViewRange ( double NewRangeMin,
double NewRangeMax,
EViewRangeInterpolation Interpolation
)

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

Overridden from ISequencerInputHandler

  Type Name Description
Public function Virtual FReply

OnMouseButtonDown ( SWidget& WidgetOwner,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual FReply

OnMouseButtonUp ( SWidget& WidgetOwner,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual FReply

OnMouseMove ( SWidget& WidgetOwner,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual FReply

OnMouseWheel ( SWidget& WidgetOwner,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

  

Classes

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

Enums

  Type Name Description
Private enum DragType If we are dragging a scrubber or dragging to set the time range  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page