SSimpleTimeSlider

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ToolWidgets

Header

/Engine/Source/Developer/ToolWidgets/Public/SSimpleTimeSlider.h

Include

#include "SSimpleTimeSlider.h"

Syntax

class SSimpleTimeSlider : public SCompoundWidget

Variables

Name Description

Protected variable

TAttribute< boo...

 

AllowPan

Protected variable

TAttribute< boo...

 

AllowZoom

Protected variable

bool

 

bDraggingScrubber

If we are dragging the scrubber

Protected variable

bool

 

bPanning

If we are currently panning the panel

Protected variable

TAttribute< TRa...

 

ClampRange

Protected variable

TAttribute< FLi...

 

ClampRangeHighlightColor

Protected variable

TAttribute< flo...

 

ClampRangeHighlightSize

Protected variable

const FSlateBru...

 

CursorBackground

Brush for drawing cursor background to visualize cursor size

Protected variable

TAttribute< flo...

 

CursorSize

Protected variable

float

 

DistanceDragged

Total mouse delta during dragging

Protected variable

TAttribute< boo...

 

MirrorLabels

Protected variable

FOnScrubPositio...

 

OnScrubPositionChanged

Protected variable

FOnRangeChanged

 

OnViewRangeChanged

Protected variable

TSharedPtr< SSc...

 

Scrollbar

Protected variable

const FSlateBru...

 

ScrubHandleDown

Brush for drawing a downwards facing scrub handle

Protected variable

const FSlateBru...

 

ScrubHandleUp

Brush for drawing an upwards facing scrub handle

Protected variable

TAttribute< dou...

 

ScrubPosition

Protected variable

FVector2D

 

SoftwareCursorPosition

Protected variable

TAttribute< dou...

 

TimeSnapInterval

Protected variable

TAttribute< TRa...

 

ViewRange

Functions

Name Description

Protected function

void

 

CommitScrubPosition

(
    float NewValue,
    bool bIsScrubbing
)

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

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Construct the widget

Protected function Const

void

 

DrawTicks

(
    FSlateWindowElementList& OutDrawEl...,
    const FScrubRangeToScreen& RangeTo...,
    FDrawTickArgs& InArgs
)

Draws time tick marks

Protected function Const

float

 

GetTimeAtCursorPosition

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

Public function

TRange< doub...

 

GetTimeRange()

Public function

bool

 

IsPanning()

Protected function Const

int32

 

OnPaintTimeSlider

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

Public function

void

 

SetClampRange

(
    double MinValue,
    double MaxValue
)

Public function

void

 

SetTimeRange

(
    double MinValue,
    double MaxValue
)

Overridden from SWidget

Name Description

Protected function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float LayoutScaleMultiplier
)

Compute the ideal size necessary to display this widget.

Protected function Virtual

FReply

 

OnMouseButtonDown

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.

Protected function Virtual

FReply

 

OnMouseButtonUp

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

The system calls this method to notify the widget that a mouse button was release within it.

Protected function Virtual

FReply

 

OnMouseMove

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

The system calls this method to notify the widget that a mouse moved within it.

Protected function Virtual

FReply

 

OnMouseWheel

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

Called when the mouse wheel is spun. This event is bubbled.

Protected function Virtual Const

int32

 

OnPaint

(
    const FPaintArgs& Args,
    const FGeometry& AllottedGeometry,
    const FSlateRect& MyCullingRect,
    FSlateWindowElementList& OutDrawEl...,
    int32 LayerId,
    const FWidgetStyle& InWidgetStyle,
    bool bParentEnabled
)

The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.

Classes

Name

Description

Public struct

FArguments

Public struct

FDrawTickArgs

Public struct

FScrubRangeToScreen

Utility struct for converting between scrub range space and local/absolute screen space

Typedefs