1. Epic GamesDeveloper
  3. FBaseTimingTrack

FBaseTimingTrack

API > API/Developer > API/Developer/TraceInsights

   
Name FBaseTimingTrack
Type class
Header File /Engine/Source/Developer/TraceInsights/Public/Insights/ViewModels/BaseTimingTrack.h
Include Path #include "Insights/ViewModels/BaseTimingTrack.h"

Syntax

class FBaseTimingTrack : public TSharedFromThis< FBaseTimingTrack >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  Insights/ViewModels/BaseTimingTrack.h  

FBaseTimingTrack ( const FString& InName
)

   Insights/ViewModels/BaseTimingTrack.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FBaseTimingTrack()

   Insights/ViewModels/BaseTimingTrack.h  

Constants

Name Type Remarks Include Path
IdGenerator uint64   Insights/ViewModels/BaseTimingTrack.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Flags ETimingTrackFlags   Insights/ViewModels/BaseTimingTrack.h  
Height float   Insights/ViewModels/BaseTimingTrack.h  
Id const uint64   Insights/ViewModels/BaseTimingTrack.h  
Location ETimingTrackLocation   Insights/ViewModels/BaseTimingTrack.h  
Name FString   Insights/ViewModels/BaseTimingTrack.h  
Order int32   Insights/ViewModels/BaseTimingTrack.h  
PosY float   Insights/ViewModels/BaseTimingTrack.h  
ValidLocations ETimingTrackLocation   Insights/ViewModels/BaseTimingTrack.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddChildTrack ( TSharedRef< FBaseTimingTrack > Track,
int32 Index
)

 Inserts a child track to this track at the specified index. Insights/ViewModels/BaseTimingTrack.h  
Adds a child track to this track. Insights/ViewModels/BaseTimingTrack.h  

virtual void BuildContextMenu ( FMenuBuilder& MenuBuilder
)

   Insights/ViewModels/BaseTimingTrack.h  

void ClearDirtyFlag()

   Insights/ViewModels/BaseTimingTrack.h  

virtual void Draw ( const ITimingTrackDrawContext& Context
) const

 Draw callback (called from OnPaint) to draw the track's content. Insights/ViewModels/BaseTimingTrack.h  

virtual void DrawEvent ( const ITimingTrackDrawContext& Context,
const ITimingEvent& InTimingEvent,
EDrawEventMode InDrawMode
) const

 Draw a single event (can be used to draw only the highlight for a selected and/or hovered event). Insights/ViewModels/BaseTimingTrack.h  
The reason why FindChildTrackOfType does not consider the inheritance hierarchy is because if it did, downstream inheritors of specific public track types could break plugins defining them. Insights/ViewModels/BaseTimingTrack.h  
Returns the first child track of the given type. Insights/ViewModels/BaseTimingTrack.h  

TSharedPtr< FBaseTimingTrack > GetChildTrack()

 Legacy API supporting a single track. Do not use in new code. Insights/ViewModels/BaseTimingTrack.h  
Adding children to tracks is a two-step process: Insights/ViewModels/BaseTimingTrack.h  
  Insights/ViewModels/BaseTimingTrack.h  

float GetChildTracksTopHeight ( const FTimingViewLayout& Layout
) const

   Insights/ViewModels/BaseTimingTrack.h  

virtual const TSharedPtr< const ITimingEvent > GetEvent ( float InPosX,
float InPosY,
const FTimingTrackViewport& Viewport
) const

 Gets the event at a specified position. Insights/ViewModels/BaseTimingTrack.h  

virtual TSharedPtr< ITimingEventFilter > GetFilterByEvent ( const TSharedPtr< const ITimingEvent > InTimingEvent
) const

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

float GetHeight()

   Insights/ViewModels/BaseTimingTrack.h  

uint64 GetId()

   Insights/ViewModels/BaseTimingTrack.h  

ETimingTrackLocation GetLocation()

   Insights/ViewModels/BaseTimingTrack.h  

const FString & GetName()

   Insights/ViewModels/BaseTimingTrack.h  

int32 GetOrder()

   Insights/ViewModels/BaseTimingTrack.h  

TWeakPtr< FBaseTimingTrack > GetParentTrack()

   Insights/ViewModels/BaseTimingTrack.h  

float GetPosY()

   Insights/ViewModels/BaseTimingTrack.h  

ETimingTrackLocation GetValidLocations()

   Insights/ViewModels/BaseTimingTrack.h  

void Hide()

   Insights/ViewModels/BaseTimingTrack.h  

virtual void InitTooltip ( FTooltipDrawState& InOutTooltip,
const ITimingEvent& InTooltipEvent
) const

 Called to initialize the tooltip's content with info from a timing event. Insights/ViewModels/BaseTimingTrack.h  

bool IsChildTrack()

   Insights/ViewModels/BaseTimingTrack.h  

bool IsDirty()

   Insights/ViewModels/BaseTimingTrack.h  

bool IsHeaderHovered()

   Insights/ViewModels/BaseTimingTrack.h  

bool IsHovered()

   Insights/ViewModels/BaseTimingTrack.h  

bool IsSelected()

   Insights/ViewModels/BaseTimingTrack.h  

bool IsVisible()

   Insights/ViewModels/BaseTimingTrack.h  

virtual void OnClipboardCopyEvent ( const ITimingEvent& InSelectedEvent
) const

 Called back from the timing view when an event is copied to the clipboard with Ctrl+C. Insights/ViewModels/BaseTimingTrack.h  

virtual void OnDirtyFlagChanged()

   Insights/ViewModels/BaseTimingTrack.h  

virtual void OnEventHovered ( const ITimingEvent& InHoveredEvent
) const

 Called back from the timing view when an event is hovered by mouse. Insights/ViewModels/BaseTimingTrack.h  

virtual void OnEventSelected ( const ITimingEvent& InSelectedEvent
) const

 Called back from the timing view when an event is selected. Insights/ViewModels/BaseTimingTrack.h  

virtual void OnLocationChanged()

   Insights/ViewModels/BaseTimingTrack.h  

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

   Insights/ViewModels/BaseTimingTrack.h  

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

   Insights/ViewModels/BaseTimingTrack.h  

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

   Insights/ViewModels/BaseTimingTrack.h  

virtual void OnSelectedFlagChanged()

   Insights/ViewModels/BaseTimingTrack.h  

virtual void OnVisibilityChanged()

   Insights/ViewModels/BaseTimingTrack.h  

virtual void PostDraw ( const ITimingTrackDrawContext& Context
) const

 PostDraw callback (called from OnPaint) to draw something in the foreground. Insights/ViewModels/BaseTimingTrack.h  

virtual void PostUpdate ( const ITimingTrackUpdateContext& Context
)

 PostUpdate callback called each frame, but only if the track is visible. Insights/ViewModels/BaseTimingTrack.h  

virtual void PreDraw ( const ITimingTrackDrawContext& Context
) const

 PreDraw callback (called from OnPaint) to draw something in the background. Insights/ViewModels/BaseTimingTrack.h  

virtual void PreUpdate ( const ITimingTrackUpdateContext& Context
)

 PreUpdate callback called each frame, but only if the track is visible. Insights/ViewModels/BaseTimingTrack.h  
Removes the provided track from this track's child tracks. Insights/ViewModels/BaseTimingTrack.h  

virtual void Reset()

   Insights/ViewModels/BaseTimingTrack.h  

virtual const TSharedPtr< const ITimingEvent > SearchEvent ( const FTimingEventSearchParameters& InSearchParameters
) const

 Search for an event using custom parameters. Insights/ViewModels/BaseTimingTrack.h  

void Select()

   Insights/ViewModels/BaseTimingTrack.h  

void SetChildTrack ( TSharedPtr< FBaseTimingTrack > InTrack
)

   Insights/ViewModels/BaseTimingTrack.h  

void SetDirtyFlag()

   Insights/ViewModels/BaseTimingTrack.h  

virtual void SetFilterConfigurator ( TSharedPtr< UE::Insights::FFilterConfigurator > InFilterConfigurator
)

   Insights/ViewModels/BaseTimingTrack.h  

void SetHeaderHoveredState ( bool bIsHeaderHovered
)

   Insights/ViewModels/BaseTimingTrack.h  

virtual void SetHeight ( float InHeight
)

   Insights/ViewModels/BaseTimingTrack.h  

void SetHoveredState ( bool bIsHovered
)

   Insights/ViewModels/BaseTimingTrack.h  

void SetLocation ( ETimingTrackLocation InLocation
)

   Insights/ViewModels/BaseTimingTrack.h  

void SetName ( const FString& InName
)

   Insights/ViewModels/BaseTimingTrack.h  

void SetOrder ( int32 InOrder
)

   Insights/ViewModels/BaseTimingTrack.h  

void SetParentTrack ( TWeakPtr< FBaseTimingTrack > InTrack
)

   Insights/ViewModels/BaseTimingTrack.h  

virtual void SetPosY ( float InPosY
)

   Insights/ViewModels/BaseTimingTrack.h  

void SetSelectedFlag ( bool bIsSelected
)

   Insights/ViewModels/BaseTimingTrack.h  

void SetVisibilityFlag ( bool bIsVisible
)

   Insights/ViewModels/BaseTimingTrack.h  

void Show()

   Insights/ViewModels/BaseTimingTrack.h  

void ToggleSelectedFlag()

   Insights/ViewModels/BaseTimingTrack.h  

void ToggleVisibility()

   Insights/ViewModels/BaseTimingTrack.h  

void Unselect()

   Insights/ViewModels/BaseTimingTrack.h  

virtual void Update ( const ITimingTrackUpdateContext& Context
)

 Update callback called each frame, but only if the track is visible. Insights/ViewModels/BaseTimingTrack.h  

void UpdateChildTracksPosY ( const FTimingViewLayout& Layout
)

   Insights/ViewModels/BaseTimingTrack.h  

virtual void UpdateEventStats ( ITimingEvent& InOutEvent
) const

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

Protected

Name Remarks Include Path Unreal Specifiers

void SetValidLocations ( ETimingTrackLocation InValidLocations
)

 Returns number of text lines needed to display the debug string. Insights/ViewModels/BaseTimingTrack.h  

Static

Name Remarks Include Path Unreal Specifiers

static uint64 GenerateId()

   Insights/ViewModels/BaseTimingTrack.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page