Navigation
API > API/Developer > API/Developer/TraceInsights > API/Developer/TraceInsights/Insights > API/Developer/TraceInsights/Insights/ViewModels
Inheritance Hierarchy
- FSharedFromThisBase
- TSharedFromThis
- FBaseTimingTrack
- FGraphTrack
- FRandomGraphTrack
- FTimingEventsTrack
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 >
Variables
| Type | Name | Description | |
|---|---|---|---|
| TSharedPtr< FBaseTimingTrack > | ChildTrack | ||
| TWeakPtr< FBaseTimingTrack > | ParentTrack |
Destructors
No destructors are accessible with public or protected access.
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | BuildContextMenu
(
FMenuBuilder& MenuBuilder |
||
| void | |||
| void | Draw
(
const ITimingTrackDrawContext& Context |
Draw callback (called from OnPaint) to draw the track's content. | |
| void | DrawEvent
(
const ITimingTrackDrawContext& Context, |
Draw a single event (can be used to draw only the highlight for a selected and/or hovered event). | |
| uint64 | GenerateId () |
||
| TSharedPtr< FBaseTimingTrack > | |||
| const TSharedPtr< const ITimingEvent > | GetEvent
(
float InPosX, |
Gets the event at a specified position. | |
| TSharedPtr< ITimingEventFilter > | GetFilterByEvent
(
const TSharedPtr< const ITimingEvent > InTimingEvent |
Get the filter object for filtering all events similar with a specified event. Used when double clicked on an event. | |
| float | GetHeight () |
||
| uint64 | GetId () |
||
| ETimingTrackLocation | GetLocation () |
||
| const FString & | GetName () |
||
| int32 | GetOrder () |
||
| TWeakPtr< FBaseTimingTrack > | |||
| float | GetPosY () |
||
| ETimingTrackLocation | |||
| void | Hide () |
||
| void | InitTooltip
(
FTooltipDrawState& InOutTooltip, |
Called to initialize the tooltip's content with info from a timing event. | |
| bool | IsChildTrack () |
||
| bool | IsDirty () |
||
| bool | |||
| bool | IsHovered () |
||
| bool | IsSelected () |
||
| bool | IsVisible () |
||
| void | OnClipboardCopyEvent
(
const ITimingEvent& InSelectedEvent |
Called back from the timing view when an event is copied to the clipboard with Ctrl+C. | |
| void | |||
| void | OnEventHovered
(
const ITimingEvent& InHoveredEvent |
Called back from the timing view when an event is hovered by mouse. | |
| void | OnEventSelected
(
const ITimingEvent& InSelectedEvent |
Called back from the timing view when an event is selected. | |
| void | |||
| FReply | OnMouseButtonDoubleClick
(
const FGeometry& MyGeometry, |
||
| FReply | OnMouseButtonDown
(
const FGeometry& MyGeometry, |
||
| FReply | OnMouseButtonUp
(
const FGeometry& MyGeometry, |
||
| void | |||
| void | |||
| void | PostDraw
(
const ITimingTrackDrawContext& Context |
PostDraw callback (called from OnPaint) to draw something in the foreground. | |
| void | PostUpdate
(
const ITimingTrackUpdateContext& Context |
PostUpdate callback called each frame, but only if the track is visible. | |
| void | PreDraw
(
const ITimingTrackDrawContext& Context |
PreDraw callback (called from OnPaint) to draw something in the background. | |
| void | PreUpdate
(
const ITimingTrackUpdateContext& Context |
PreUpdate callback called each frame, but only if the track is visible. | |
| void | Reset () |
||
| const TSharedPtr< const ITimingEvent > | SearchEvent
(
const FTimingEventSearchParameters& InSearchParameters |
Search for an event using custom parameters. | |
| void | Select () |
||
| void | SetChildTrack
(
TSharedPtr< FBaseTimingTrack > InTrack |
||
| void | SetDirtyFlag () |
||
| void | SetFilterConfigurator
(
TSharedPtr< UE::Insights::FFilterConfigurator > InFilterConfigurator |
||
| void | SetHeaderHoveredState
(
bool bIsHeaderHovered |
||
| void | SetHeight
(
float InHeight |
||
| void | SetHoveredState
(
bool bIsHovered |
||
| void | SetLocation
(
ETimingTrackLocation InLocation |
||
| void | |||
| void | |||
| void | SetParentTrack
(
TWeakPtr< FBaseTimingTrack > InTrack |
||
| void | SetPosY
(
float InPosY |
||
| void | SetSelectedFlag
(
bool bIsSelected |
||
| void | SetValidLocations
(
ETimingTrackLocation InValidLocations |
Returns number of text lines needed to display the debug string. | |
| void | SetVisibilityFlag
(
bool bIsVisible |
||
| void | Show () |
||
| void | |||
| void | |||
| void | Unselect () |
||
| void | Update
(
const ITimingTrackUpdateContext& Context |
Update callback called each frame, but only if the track is visible. | |
| 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 |