1. Epic GamesDeveloper
  3. FSequencerTimeSliderController

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

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsEvaluating bool If evaluating, if not we draw the time box to be yellow not default SequencerTimeSliderController.h  
bMouseDownInRegion bool If mouse down was in time scrubbing region, only allow setting time when mouse is pressed down in the region SequencerTimeSliderController.h  
bPanning bool If we are currently panning the panel SequencerTimeSliderController.h  
ContextMenuSuppression int32 When > 0, we should not show context menus SequencerTimeSliderController.h  
DistanceDragged float Total mouse delta during dragging SequencerTimeSliderController.h  
DragMarkMap TMap< int32, FFrameNumber > Map of the indices of the marks being edited and their initial frame numbers when pressed SequencerTimeSliderController.h  
FContextMenuSuppressor friend   SequencerTimeSliderController.h  
FontMeasureService TSharedPtr< FSlateFontMeasure > Font measure service SequencerTimeSliderController.h  
FrameBlockScrubHandleDownBrush const FSlateBrush * Brush for drawing a downwards facing scrub handle SequencerTimeSliderController.h  
HoverMarkIndex int32 Index of mark being hovered SequencerTimeSliderController.h  
MouseDownGeometry FGeometry Geometry on mouse down SequencerTimeSliderController.h  
MouseDownPlaybackRange TRange< FFrameNumber > Playback range when the mouse is first pressed down SequencerTimeSliderController.h  
MouseDownPosition TOptional< FVector2D > Mouse down position range SequencerTimeSliderController.h  
MouseDownSelectionRange TRange< FFrameNumber > Selection range when the mouse is first pressed down SequencerTimeSliderController.h  
MouseDragType DragType   SequencerTimeSliderController.h  
ScrubFillBrush const FSlateBrush * Brush for drawingthe fill area on the scrubber SequencerTimeSliderController.h  
SmallBoldLayoutFont FSlateFontInfo   SequencerTimeSliderController.h  
SmallLayoutFont FSlateFontInfo Font info for the marked frames labels SequencerTimeSliderController.h  
TimeSliderArgs FTimeSliderArgs   SequencerTimeSliderController.h  
VanillaScrubHandleDownBrush const FSlateBrush *   SequencerTimeSliderController.h  
ViewRangeStack TArray< TRange< double > > Range stack SequencerTimeSliderController.h  
WeakSequencer TWeakPtr< FSequencer > Pointer back to the sequencer object SequencerTimeSliderController.h  

Functions

Public

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  

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  

virtual FAnimatedRange GetClampRange()

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

virtual FFrameRate GetDisplayRate()

 End ITimeSliderController Interface 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 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 FAnimatedRange GetViewRange()

 Get the current view range for this controller SequencerTimeSliderController.h  

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

   SequencerTimeSliderController.h  

virtual FReply OnMouseButtonDoubleClick ( SWidget& WidgetOwner,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   SequencerTimeSliderController.h  

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

   SequencerTimeSliderController.h  

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

   SequencerTimeSliderController.h  

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

   SequencerTimeSliderController.h  

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

   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& MyGeometry,
const FPointerEvent& MouseEvent
)

   SequencerTimeSliderController.h  

void PanByDelta ( float InDelta
)

 Pan the range by a given delta SequencerTimeSliderController.h  

virtual void SetClampRange ( double NewRangeMin,
double NewRangeMax
)

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

void SetIsEvaluating()

 Set that's evaluating 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  

bool ZoomByDelta ( float InDelta,
float ZoomBias
)

 Zoom the range by a given delta. SequencerTimeSliderController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page