315 lines
12 KiB
C
315 lines
12 KiB
C
|
// Copyright Epic Games, Inc. All Rights Reserved.
|
||
|
|
|
||
|
|
#pragma once
|
||
|
|
|
||
|
|
#include "CoreMinimal.h"
|
||
|
|
#include "Input/Events.h"
|
||
|
|
#include "Input/Reply.h"
|
||
|
|
#include "Misc/EnumClassFlags.h"
|
||
|
|
|
||
|
|
#include "Insights/Common/SimpleRtti.h"
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
class FMenuBuilder;
|
||
|
|
namespace Trace
|
||
|
|
{
|
||
|
|
class IAnalysisSession;
|
||
|
|
};
|
||
|
|
|
||
|
|
class FTimingEventSearchParameters;
|
||
|
|
class FTimingTrackViewport;
|
||
|
|
class ITimingViewDrawHelper;
|
||
|
|
class FTooltipDrawState;
|
||
|
|
class ITimingEvent;
|
||
|
|
class ITimingEventFilter;
|
||
|
|
|
||
|
|
struct FDrawContext;
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
enum class TRACEINSIGHTS_API ETimingTrackLocation : uint32
|
||
|
|
{
|
||
|
|
None = 0,
|
||
|
|
Scrollable = (1 << 0),
|
||
|
|
TopDocked = (1 << 1),
|
||
|
|
BottomDocked = (1 << 2),
|
||
|
|
Foreground = (1 << 3),
|
||
|
|
All = Scrollable | TopDocked | BottomDocked | Foreground
|
||
|
|
};
|
||
|
|
ENUM_CLASS_FLAGS(ETimingTrackLocation);
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
struct TRACEINSIGHTS_API FTimingTrackOrder
|
||
|
|
{
|
||
|
|
static constexpr int32 GroupRange = 100000;
|
||
|
|
static constexpr int32 TimeRuler = -2 * GroupRange;
|
||
|
|
static constexpr int32 Markers = -1 * GroupRange;
|
||
|
|
static constexpr int32 First = 0;
|
||
|
|
static constexpr int32 Memory = 1 * GroupRange;
|
||
|
|
static constexpr int32 Gpu = 2 * GroupRange;
|
||
|
|
static constexpr int32 Cpu = 3 * GroupRange;
|
||
|
|
static constexpr int32 Last = 4 * GroupRange;
|
||
|
|
};
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
enum class TRACEINSIGHTS_API ETimingTrackFlags : uint32
|
||
|
|
{
|
||
|
|
None = 0,
|
||
|
|
IsVisible = (1 << 0),
|
||
|
|
IsDirty = (1 << 1),
|
||
|
|
IsSelected = (1 << 2),
|
||
|
|
IsHovered = (1 << 3),
|
||
|
|
IsHeaderHovered = (1 << 4),
|
||
|
|
};
|
||
|
|
ENUM_CLASS_FLAGS(ETimingTrackFlags);
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
enum class TRACEINSIGHTS_API EDrawEventMode : uint32
|
||
|
|
{
|
||
|
|
None = 0,
|
||
|
|
|
||
|
|
/** Draw the content of the event. This flag can be omitted in order to draw only the hovered/selected highlights. */
|
||
|
|
Content = (1 << 0),
|
||
|
|
|
||
|
|
/** Draw the highlights for a hovered event. */
|
||
|
|
Hovered = (1 << 1),
|
||
|
|
|
||
|
|
/** Draw the highlights for a selected event. */
|
||
|
|
Selected = (1 << 2),
|
||
|
|
|
||
|
|
/** Draw the highlights for an event that is both selected and hovered. */
|
||
|
|
SelectedAndHovered = Hovered | Selected,
|
||
|
|
};
|
||
|
|
ENUM_CLASS_FLAGS(EDrawEventMode);
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
class TRACEINSIGHTS_API ITimingTrackUpdateContext
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
virtual const FTimingTrackViewport& GetViewport() const = 0;
|
||
|
|
virtual const FVector2D& GetMousePosition() const = 0;
|
||
|
|
virtual const TSharedPtr<const ITimingEvent> GetHoveredEvent() const = 0;
|
||
|
|
virtual const TSharedPtr<const ITimingEvent> GetSelectedEvent() const = 0;
|
||
|
|
virtual const TSharedPtr<ITimingEventFilter> GetEventFilter() const = 0;
|
||
|
|
virtual double GetCurrentTime() const = 0;
|
||
|
|
virtual float GetDeltaTime() const = 0;
|
||
|
|
};
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
class TRACEINSIGHTS_API ITimingTrackDrawContext
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
virtual const FTimingTrackViewport& GetViewport() const = 0;
|
||
|
|
virtual const FVector2D& GetMousePosition() const = 0;
|
||
|
|
virtual const TSharedPtr<const ITimingEvent> GetHoveredEvent() const = 0;
|
||
|
|
virtual const TSharedPtr<const ITimingEvent> GetSelectedEvent() const = 0;
|
||
|
|
virtual const TSharedPtr<ITimingEventFilter> GetEventFilter() const = 0;
|
||
|
|
virtual FDrawContext& GetDrawContext() const = 0;
|
||
|
|
virtual const ITimingViewDrawHelper& GetHelper() const = 0;
|
||
|
|
};
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
class TRACEINSIGHTS_API FBaseTimingTrack: public TSharedFromThis<FBaseTimingTrack>
|
||
|
|
{
|
||
|
|
friend class FTimingViewDrawHelper;
|
||
|
|
|
||
|
|
INSIGHTS_DECLARE_RTTI_BASE(FBaseTimingTrack)
|
||
|
|
|
||
|
|
protected:
|
||
|
|
explicit FBaseTimingTrack(const FString& InName = FString())
|
||
|
|
: Id(GenerateId()), Name(InName), ValidLocations(ETimingTrackLocation::Scrollable), Location(ETimingTrackLocation::None), Order(0), PosY(0.0f), Height(0.0f), Flags(ETimingTrackFlags::IsVisible | ETimingTrackFlags::IsDirty)
|
||
|
|
{}
|
||
|
|
|
||
|
|
virtual ~FBaseTimingTrack()
|
||
|
|
{}
|
||
|
|
|
||
|
|
public:
|
||
|
|
virtual void Reset()
|
||
|
|
{
|
||
|
|
PosY = 0.0f;
|
||
|
|
Height = 0.0f;
|
||
|
|
Flags = ETimingTrackFlags::IsVisible | ETimingTrackFlags::IsDirty;
|
||
|
|
}
|
||
|
|
|
||
|
|
uint64 GetId() const { return Id; }
|
||
|
|
|
||
|
|
const FString& GetName() const { return Name; }
|
||
|
|
void SetName(const FString& InName) { Name = InName; }
|
||
|
|
|
||
|
|
ETimingTrackLocation GetValidLocations() const { return ValidLocations; }
|
||
|
|
ETimingTrackLocation GetLocation() const { return Location; }
|
||
|
|
void SetLocation(ETimingTrackLocation InLocation)
|
||
|
|
{
|
||
|
|
Location = InLocation;
|
||
|
|
OnLocationChanged();
|
||
|
|
}
|
||
|
|
virtual void OnLocationChanged() { SetDirtyFlag(); }
|
||
|
|
|
||
|
|
int32 GetOrder() const { return Order; }
|
||
|
|
void SetOrder(int32 InOrder) { Order = InOrder; }
|
||
|
|
|
||
|
|
float GetPosY() const { return PosY; }
|
||
|
|
virtual void SetPosY(float InPosY) { PosY = InPosY; }
|
||
|
|
|
||
|
|
float GetHeight() const { return Height; }
|
||
|
|
virtual void SetHeight(float InHeight) { Height = InHeight; }
|
||
|
|
|
||
|
|
bool IsVisible() const { return EnumHasAnyFlags(Flags, ETimingTrackFlags::IsVisible); }
|
||
|
|
void Show()
|
||
|
|
{
|
||
|
|
Flags |= ETimingTrackFlags::IsVisible;
|
||
|
|
OnVisibilityChanged();
|
||
|
|
}
|
||
|
|
void Hide()
|
||
|
|
{
|
||
|
|
Flags &= ~ETimingTrackFlags::IsVisible;
|
||
|
|
OnVisibilityChanged();
|
||
|
|
}
|
||
|
|
void ToggleVisibility()
|
||
|
|
{
|
||
|
|
Flags ^= ETimingTrackFlags::IsVisible;
|
||
|
|
OnVisibilityChanged();
|
||
|
|
}
|
||
|
|
void SetVisibilityFlag(bool bIsVisible) { bIsVisible ? Show() : Hide(); }
|
||
|
|
virtual void OnVisibilityChanged()
|
||
|
|
{
|
||
|
|
if (IsVisible())
|
||
|
|
SetDirtyFlag();
|
||
|
|
}
|
||
|
|
|
||
|
|
bool IsDirty() const { return EnumHasAnyFlags(Flags, ETimingTrackFlags::IsDirty); }
|
||
|
|
void SetDirtyFlag()
|
||
|
|
{
|
||
|
|
Flags |= ETimingTrackFlags::IsDirty;
|
||
|
|
OnDirtyFlagChanged();
|
||
|
|
}
|
||
|
|
void ClearDirtyFlag()
|
||
|
|
{
|
||
|
|
Flags &= ~ETimingTrackFlags::IsDirty;
|
||
|
|
OnDirtyFlagChanged();
|
||
|
|
}
|
||
|
|
virtual void OnDirtyFlagChanged() {}
|
||
|
|
|
||
|
|
bool IsSelected() const { return EnumHasAnyFlags(Flags, ETimingTrackFlags::IsSelected); }
|
||
|
|
void Select()
|
||
|
|
{
|
||
|
|
Flags |= ETimingTrackFlags::IsSelected;
|
||
|
|
OnSelectedFlagChanged();
|
||
|
|
}
|
||
|
|
void Unselect()
|
||
|
|
{
|
||
|
|
Flags &= ~ETimingTrackFlags::IsSelected;
|
||
|
|
OnSelectedFlagChanged();
|
||
|
|
}
|
||
|
|
void ToggleSelectedFlag()
|
||
|
|
{
|
||
|
|
Flags ^= ETimingTrackFlags::IsSelected;
|
||
|
|
OnSelectedFlagChanged();
|
||
|
|
}
|
||
|
|
void SetSelectedFlag(bool bIsSelected) { bIsSelected ? Select() : Unselect(); }
|
||
|
|
virtual void OnSelectedFlagChanged() {}
|
||
|
|
|
||
|
|
bool IsHovered() const { return EnumHasAnyFlags(Flags, ETimingTrackFlags::IsHovered); }
|
||
|
|
void SetHoveredState(bool bIsHovered) { bIsHovered ? Flags |= ETimingTrackFlags::IsHovered : Flags &= ~ETimingTrackFlags::IsHovered; }
|
||
|
|
bool IsHeaderHovered() const { return EnumHasAllFlags(Flags, ETimingTrackFlags::IsHovered | ETimingTrackFlags::IsHeaderHovered); }
|
||
|
|
void SetHeaderHoveredState(bool bIsHeaderHovered) { bIsHeaderHovered ? Flags |= ETimingTrackFlags::IsHeaderHovered : Flags &= ~ETimingTrackFlags::IsHeaderHovered; }
|
||
|
|
|
||
|
|
//////////////////////////////////////////////////
|
||
|
|
|
||
|
|
// PreUpdate callback called each frame, but only if the track is visible.
|
||
|
|
// In this update, neither the postion nor the size of the track is yet computed.
|
||
|
|
// Track should update here its height.
|
||
|
|
virtual void PreUpdate(const ITimingTrackUpdateContext& Context) {}
|
||
|
|
|
||
|
|
// Update callback called each frame, but only if the track is visible.
|
||
|
|
// In this update, it is assumed the track position and the track size are valid.
|
||
|
|
virtual void Update(const ITimingTrackUpdateContext& Context) {}
|
||
|
|
|
||
|
|
// PostUpdate callback called each frame, but only if the track is visible.
|
||
|
|
// Track should update here its "hovered" state.
|
||
|
|
virtual void PostUpdate(const ITimingTrackUpdateContext& Context) {}
|
||
|
|
|
||
|
|
//////////////////////////////////////////////////
|
||
|
|
|
||
|
|
// PreDraw callback (called from OnPaint) to draw something in the background.
|
||
|
|
virtual void PreDraw(const ITimingTrackDrawContext& Context) const {}
|
||
|
|
|
||
|
|
// Draw callback (called from OnPaint) to draw the track's content.
|
||
|
|
virtual void Draw(const ITimingTrackDrawContext& Context) const {}
|
||
|
|
|
||
|
|
// Draw a single event (can be used to draw only the highlight for a selected and/or hovered event).
|
||
|
|
virtual void DrawEvent(const ITimingTrackDrawContext& Context, const ITimingEvent& InTimingEvent, EDrawEventMode InDrawMode) const {}
|
||
|
|
|
||
|
|
// PostDraw callback (called from OnPaint) to draw something in the foreground.
|
||
|
|
virtual void PostDraw(const ITimingTrackDrawContext& Context) const {}
|
||
|
|
|
||
|
|
//////////////////////////////////////////////////
|
||
|
|
|
||
|
|
virtual FReply OnMouseButtonDown(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent) { return FReply::Unhandled(); }
|
||
|
|
virtual FReply OnMouseButtonUp(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent) { return FReply::Unhandled(); }
|
||
|
|
virtual FReply OnMouseButtonDoubleClick(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent) { return FReply::Unhandled(); }
|
||
|
|
|
||
|
|
virtual void BuildContextMenu(FMenuBuilder& MenuBuilder);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the event at a specified position. Leaves the InOutEvent unchanged if no event is found at specified position.
|
||
|
|
* @param X The horizontal coordinate of the point tested; in Slate pixels (viewport coordinates).
|
||
|
|
* @param Y The vertical coordinate of the point tested; in Slate pixels (viewport coordinates).
|
||
|
|
* @param Viewport The timing viewport used to transform time in viewport coordinates.
|
||
|
|
* @return The event located at (PosX, PosY) coordinates, if any; nullptr ottherwise.
|
||
|
|
*/
|
||
|
|
virtual const TSharedPtr<const ITimingEvent> GetEvent(float InPosX, float InPosY, const FTimingTrackViewport& Viewport) const { return nullptr; }
|
||
|
|
|
||
|
|
// Search for an event using custom parameters.
|
||
|
|
virtual const TSharedPtr<const ITimingEvent> SearchEvent(const FTimingEventSearchParameters& InSearchParameters) const { return nullptr; }
|
||
|
|
|
||
|
|
// Get the filter object for filtering all events similar with a specified event. Used when double clicked on an event.
|
||
|
|
virtual TSharedPtr<ITimingEventFilter> GetFilterByEvent(const TSharedPtr<const ITimingEvent> InTimingEvent) const { return nullptr; }
|
||
|
|
|
||
|
|
// Allows tracks to update event stats that are slower to compute (called at a lower frequency than GetEventAtPosition or Search or SearchTimingEvent).
|
||
|
|
virtual void UpdateEventStats(ITimingEvent& InOutEvent) const {}
|
||
|
|
|
||
|
|
// Called back from the timing view when an event is hovered by mouse.
|
||
|
|
virtual void OnEventHovered(const ITimingEvent& InHoveredEvent) const {}
|
||
|
|
|
||
|
|
// Called back from the timing view when an event is selected.
|
||
|
|
virtual void OnEventSelected(const ITimingEvent& InSelectedEvent) const {}
|
||
|
|
|
||
|
|
// Called to initialize the tooltip's content with info from a timing event.
|
||
|
|
virtual void InitTooltip(FTooltipDrawState& InOutTooltip, const ITimingEvent& InTooltipEvent) const {}
|
||
|
|
|
||
|
|
// Called back from the timing view when an event is copied to the clipboard with Ctrl+C.
|
||
|
|
virtual void OnClipboardCopyEvent(const ITimingEvent& InSelectedEvent) const {}
|
||
|
|
|
||
|
|
// Returns number of text lines needed to display the debug string.
|
||
|
|
// TODO: virtual int GetDebugStringLineCount() const { return 0; }
|
||
|
|
|
||
|
|
// Builds a string with debug text information.
|
||
|
|
// TODO: virtual void BuildDebugString(FString& OutStr) const {}
|
||
|
|
|
||
|
|
protected:
|
||
|
|
void SetValidLocations(ETimingTrackLocation InValidLocations) { ValidLocations = InValidLocations; }
|
||
|
|
static uint64 GenerateId() { return IdGenerator++; }
|
||
|
|
|
||
|
|
private:
|
||
|
|
const uint64 Id;
|
||
|
|
FString Name;
|
||
|
|
ETimingTrackLocation ValidLocations;
|
||
|
|
ETimingTrackLocation Location;
|
||
|
|
int32 Order;
|
||
|
|
float PosY; // y position, in Slate units
|
||
|
|
float Height; // height, in Slate units
|
||
|
|
ETimingTrackFlags Flags;
|
||
|
|
|
||
|
|
static uint64 IdGenerator;
|
||
|
|
};
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|