FBaseTimingTrack

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

TraceInsights

Header

/Engine/Source/Developer/TraceInsights/Public/Insights/ViewModels/BaseTimingTrack.h

Include

#include "Insights/ViewModels/BaseTimingTrack.h"

Syntax

class FBaseTimingTrack : public TSharedFromThis< FBaseTimingTrack >

Constructors

Name Description

Protected function

FBaseTimingTrack

(
    const FString& InName
)

Destructors

Name Description

Protected function Virtual

~FBaseTimingTrack()

Functions

Name Description

Public function Const

const Type &

 

As()

Public function

Type &

 

As()

Public function Virtual

void

 

BuildContextMenu

(
    FMenuBuilder& MenuBuilder
)

Public function

void

 

ClearDirtyFlag()

Public function Virtual Const

void

 

Draw

(
    const ITimingTrackDrawContext& Con...
)

Draw callback (called from OnPaint) to draw the track's content.

Public function Virtual Const

void

 

DrawEvent

(
    const ITimingTrackDrawContext& Con...,
    const ITimingEvent& InTimingEvent,
    EDrawEventMode InDrawMode
)

Draw a single event (can be used to draw only the highlight for a selected and/or hovered event).

Protected function Static

uint64

 

GenerateId()

Returns number of text lines needed to display the debug string.

Public function Virtual Const

const TShare...

 

GetEvent

(
    float InPosX,
    float InPosY,
    const FTimingTrackViewport& Viewpo...
)

Gets the event at a specified position.

Public function Virtual Const

TSharedPtr< ...

 

GetFilterByEvent

(
    const TSharedPtr< const ITimingEven...
)

Get the filter object for filtering all events similar with a specified event. Used when double clicked on an event.

Public function Const

float

 

GetHeight()

Public function Const

uint64

 

GetId()

Public function Const

const FStrin...

 

GetName()

Public function Const

int32

 

GetOrder()

Public function Const

float

 

GetPosY()

Public function Static

const FName ...

 

GetStaticTypeName()

Public function Virtual Const

const FName ...

 

GetTypeName()

Public function

void

 

Hide()

Public function Virtual Const

void

 

InitTooltip

(
    FTooltipDrawState& InOutTooltip,
    const ITimingEvent& InTooltipEvent
)

Called to initialize the tooltip's content with info from a timing event.

Public function Const

bool

 

Is()

Public function Const

bool

 

IsDirty()

Public function Const

bool

 

IsHeaderHovered()

Public function Const

bool

 

IsHovered()

Public function Virtual Const

bool

 

IsKindOf

(
    const FName& InTypeName
)

Public function Const

bool

 

IsSelected()

Public function Const

bool

 

IsVisible()

Public function Virtual Const

void

 

OnClipboardCopyEvent

(
    const ITimingEvent& InSelectedEven...
)

Called back from the timing view when an event is copied to the clipboard with Ctrl+C.

Public function Virtual

void

 

OnDirtyFlagChanged()

Public function Virtual Const

void

 

OnEventHovered

(
    const ITimingEvent& InHoveredEvent
)

Called back from the timing view when an event is hovered by mouse.

Public function Virtual Const

void

 

OnEventSelected

(
    const ITimingEvent& InSelectedEven...
)

Called back from the timing view when an event is selected.

Public function Virtual

FReply

 

OnMouseButtonDoubleClick

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

Public function Virtual

FReply

 

OnMouseButtonDown

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

Public function Virtual

FReply

 

OnMouseButtonUp

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

Public function Virtual

void

 

OnSelectedFlagChanged()

Public function Virtual

void

 

OnVisibilityChanged()

Public function Virtual Const

void

 

PostDraw

(
    const ITimingTrackDrawContext& Con...
)

PostDraw callback (called from OnPaint) to draw something in the foreground.

Public function Virtual

void

 

PostUpdate

(
    const ITimingTrackUpdateContext& C...
)

PostUpdate callback called each frame, but only if the track is visible.

Public function Virtual Const

void

 

PreDraw

(
    const ITimingTrackDrawContext& Con...
)

PreDraw callback (called from OnPaint) to draw something in the background.

Public function Virtual

void

 

PreUpdate

(
    const ITimingTrackUpdateContext& C...
)

PreUpdate callback called each frame, but only if the track is visible.

Public function Virtual

void

 

Reset()

Public function Virtual Const

const TShare...

 

SearchEvent

(
    const FTimingEventSearchParameters ...
)

Search for an event using custom parameters.

Public function

void

 

Select()

Public function

void

 

SetDirtyFlag()

Public function

void

 

SetHeaderHoveredState

(
    bool bIsHeaderHovered
)

Public function Virtual

void

 

SetHeight

(
    float InHeight
)

Public function

void

 

SetHoveredState

(
    bool bIsHovered
)

Public function

void

 

SetName

(
    const FString& InName
)

Public function

void

 

SetOrder

(
    int32 InOrder
)

Public function Virtual

void

 

SetPosY

(
    float InPosY
)

Public function

void

 

SetSelectedFlag

(
    bool bIsSelected
)

Public function

void

 

SetVisibilityFlag

(
    bool bIsVisible
)

Public function

void

 

Show()

Public function

void

 

ToggleSelectedFlag()

Public function

void

 

ToggleVisibility()

Public function

void

 

Unselect()

Public function Virtual

void

 

Update

(
    const ITimingTrackUpdateContext& C...
)

Update callback called each frame, but only if the track is visible.

Public function Virtual Const

void

 

UpdateEventStats

(
    ITimingEvent& InOutEvent
)

Allows tracks to update event stats that are slower to compute (called at a lower frequency than GetEventAtPosition or Search or SearchTimingEvent).

Constants

Name

Description

IdGenerator

TypeName

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss