1. Epic GamesDeveloper
  3. ITimingViewSession

ITimingViewSession

Hosts a number of timing view visualizers, represents a session of the timing view.

API > API/Developer > API/Developer/TraceInsights

Hosts a number of timing view visualizers, represents a session of the timing view.

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

Syntax

class ITimingViewSession

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ITimingViewSession()

   Insights/ITimingViewSession.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBottomDockedTrack ( TSharedPtr< FBaseTimingTrack > Track
)

 Adds a new bottom docked track. Insights/ITimingViewSession.h  

void AddForegroundTrack ( TSharedPtr< FBaseTimingTrack > Track
)

 Adds a new foreground track. Insights/ITimingViewSession.h  

void AddOverlayWidget ( const TSharedRef< SWidget >& InWidget
)

 Adds a slot to the overlay. Insights/ITimingViewSession.h  

void AddScrollableTrack ( TSharedPtr< FBaseTimingTrack > Track
)

 Adds a new scrollable track. Insights/ITimingViewSession.h  

void AddTopDockedTrack ( TSharedPtr< FBaseTimingTrack > Track
)

 Adds a new top docked track. Insights/ITimingViewSession.h  

void AddTrack ( TSharedPtr< FBaseTimingTrack > Track,
ETimingTrackLocation Location
)

 Adds a new track, specifying the location. Insights/ITimingViewSession.h  

void EnumerateTracks ( TFunctionRef< void(TSharedPtr< FBaseTimingTrack > Track)> Callback
)

 Enumerate all available tracks (for all locations). Insights/ITimingViewSession.h  

TSharedPtr< FBaseTimingTrack > FindTrack ( uint64 InTrackId
)

 Finds a track has been added via Add*Track(). Insights/ITimingViewSession.h  

const FName & GetName()

 Gets the name of the view. Insights/ITimingViewSession.h  

double GetTimeMarker()

 Gets the current marker time. Insights/ITimingViewSession.h  

void InvalidateScrollableTracksOrder()

 Marks the scrollable tracks as not being in the correct order, so they will be re-sorted. Insights/ITimingViewSession.h  

FCustomTimeMarkerChangedDelegate & OnCustomTimeMarkerChanged()

 Gets the delegate to be invoked when a custom time marker has changed. Insights/ITimingViewSession.h  

FHoveredEventChangedDelegate & OnHoveredEventChanged()

 Gets the delegate to be invoked when the timing event being hovered by the mouse has changed. Insights/ITimingViewSession.h  

FHoveredTrackChangedDelegate & OnHoveredTrackChanged()

 Gets the delegate to be invoked when the timing track being hovered by the mouse has changed. Insights/ITimingViewSession.h  

FSelectedEventChangedDelegate & OnSelectedEventChanged()

 Gets the delegate to be invoked when the selected timing event has changed. Insights/ITimingViewSession.h  

FSelectedTrackChangedDelegate & OnSelectedTrackChanged()

 Gets the delegate to be invoked when the selected timing track has changed. Insights/ITimingViewSession.h  

FSelectionChangedDelegate & OnSelectionChanged()

 Gets the delegate to be invoked when the selection have been changed. Insights/ITimingViewSession.h  

FTimeMarkerChangedDelegate & OnTimeMarkerChanged()

 Gets the delegate to be invoked when the time marker has changed. Insights/ITimingViewSession.h  

FTrackAddedDelegate & OnTrackAdded()

 Gets the delegate to be invoked when a new track is added. Insights/ITimingViewSession.h  

FTrackRemovedDelegate & OnTrackRemoved()

 Gets the delegate to be invoked when a track is removed. Insights/ITimingViewSession.h  

FTrackVisibilityChangedDelegate & OnTrackVisibilityChanged()

 Gets the delegate to be invoked when the track visibility has changed. Insights/ITimingViewSession.h  

void PreventThrottling()

 Prevents mouse movements from throttling application updates. Insights/ITimingViewSession.h  

bool RemoveBottomDockedTrack ( TSharedPtr< FBaseTimingTrack > Track
)

 Removes a bottom docked track. Returns whether the track was removed or not. Insights/ITimingViewSession.h  

bool RemoveForegroundTrack ( TSharedPtr< FBaseTimingTrack > Track
)

 Removes a foreground track. Returns whether the track was removed or not. Insights/ITimingViewSession.h  

bool RemoveScrollableTrack ( TSharedPtr< FBaseTimingTrack > Track
)

 Removes a scrollable track. Returns whether the track was removed or not. Insights/ITimingViewSession.h  

bool RemoveTopDockedTrack ( TSharedPtr< FBaseTimingTrack > Track
)

 Removes a top docked track. Returns whether the track was removed or not. Insights/ITimingViewSession.h  

bool RemoveTrack ( TSharedPtr< FBaseTimingTrack > Track
)

 Removes a track. Returns whether the track was removed or not. Insights/ITimingViewSession.h  

void ResetEventFilter()

 Resets the event filter back to empty. Insights/ITimingViewSession.h  

void ResetSelectedEvent()

 Resets the selected event back to empty. Insights/ITimingViewSession.h  

void SetAndCenterOnTimeMarker ( double InTimeMarker
)

 Sets the current marker time and center the view on it. Insights/ITimingViewSession.h  

void SetTimeMarker ( double InTimeMarker
)

 Sets the current marker time. Insights/ITimingViewSession.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page