EM_Task/TraceInsights/Private/Insights/ViewModels/FrameTimingTrack.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "CoreMinimal.h"
#include "Fonts/SlateFontInfo.h"
#include "TraceServices/Model/Frames.h"

// Insights
#include "Insights/ITimingViewExtender.h"
#include "Insights/ViewModels/TimingEventSearch.h"  // for TTimingEventSearchCache
#include "Insights/ViewModels/TimingEventsTrack.h"
#include "Insights/ViewModels/TrackHeader.h"

class FTimingEvent;
class FTimingEventSearchParameters;
class FFrameTimingTrack;
class STimingView;
struct FSlateBrush;

////////////////////////////////////////////////////////////////////////////////////////////////////

class FFrameSharedState: public Insights::ITimingViewExtender
    , public TSharedFromThis<FFrameSharedState>
{
public:
    explicit FFrameSharedState(STimingView* InTimingView): TimingView(InTimingView) {}
    virtual ~FFrameSharedState() = default;

    TSharedPtr<FFrameTimingTrack> GetFrameTrack(uint32 InFrameType);

    bool IsFrameTrackVisible(uint32 InFrameType) const;

    //////////////////////////////////////////////////
    // ITimingViewExtender interface

    virtual void OnBeginSession(Insights::ITimingViewSession& InSession) override;
    virtual void OnEndSession(Insights::ITimingViewSession& InSession) override;
    virtual void Tick(Insights::ITimingViewSession& InSession, const Trace::IAnalysisSession& InAnalysisSession) override;
    virtual void ExtendFilterMenu(Insights::ITimingViewSession& InSession, FMenuBuilder& InMenuBuilder) override;

    //////////////////////////////////////////////////

    bool IsAllFrameTracksToggleOn() const { return bShowHideAllFrameTracks; }
    void SetAllFrameTracksToggle(bool bOnOff);
    void ShowAllFrameTracks() { SetAllFrameTracksToggle(true); }
    void HideAllFrameTracks() { SetAllFrameTracksToggle(false); }
    void ShowHideAllFrameTracks() { SetAllFrameTracksToggle(!IsAllFrameTracksToggleOn()); }

private:
    STimingView* TimingView;

    bool bShowHideAllFrameTracks;

    /** Maps frame type to track pointer. */
    TMap<uint32, TSharedPtr<FFrameTimingTrack>> FrameTracks;
};

////////////////////////////////////////////////////////////////////////////////////////////////////

class FFrameTimingTrack: public FTimingEventsTrack
{
    INSIGHTS_DECLARE_RTTI(FFrameTimingTrack, FTimingEventsTrack)

public:
    explicit FFrameTimingTrack(FFrameSharedState& InSharedState, const FString& InName, uint32 InFrameType)
        : FTimingEventsTrack(InName), SharedState(InSharedState), FrameType(InFrameType), Header(*this)
    {
        Reset();
    }

    virtual ~FFrameTimingTrack() {}

    //////////////////////////////////////////////////

    uint32 GetFrameType() const { return FrameType; }
    // void SetFrameType(uint32 InFrameType) { FrameType = InFrameType; }

    bool IsCollapsed() const { return Header.IsCollapsed(); }
    void Expand() { Header.SetIsCollapsed(false); }
    void Collapse() { Header.SetIsCollapsed(true); }
    void ToggleCollapsed() { Header.ToggleCollapsed(); }

    const FString GetShortFrameName(const uint64 FrameIndex) const;
    const FString GetFrameName(const uint64 FrameIndex) const;
    const FString GetCompleteFrameName(const uint64 FrameIndex, const double FrameDuration) const;

    //////////////////////////////////////////////////
    // FBaseTimingTrack/FTimingEventsTrack overrides

    virtual void Reset() override;

    virtual void BuildDrawState(ITimingEventsTrackDrawStateBuilder& Builder, const ITimingTrackUpdateContext& Context) override;
    virtual void BuildFilteredDrawState(ITimingEventsTrackDrawStateBuilder& Builder, const ITimingTrackUpdateContext& Context) override;

    virtual void Update(const ITimingTrackUpdateContext& Context) override;
    virtual void PostUpdate(const ITimingTrackUpdateContext& Context) override;

    virtual void Draw(const ITimingTrackDrawContext& Context) const override;
    virtual void PostDraw(const ITimingTrackDrawContext& Context) const override;

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

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

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

    virtual void OnEventSelected(const ITimingEvent& InSelectedEvent) const override;
    virtual void OnClipboardCopyEvent(const ITimingEvent& InSelectedEvent) const override;
    virtual void BuildContextMenu(FMenuBuilder& MenuBuilder) override;

    //////////////////////////////////////////////////

private:
    void DrawSelectedEventInfo(const FTimingEvent& SelectedEvent, const FTimingTrackViewport& Viewport, const FDrawContext& DrawContext, const FSlateBrush* WhiteBrush, const FSlateFontInfo& Font) const;

    bool FindFrame(const FTimingEvent& InTimingEvent, TFunctionRef<void(double, double, uint32, const Trace::FFrame&)> InFoundPredicate) const;
    bool FindFrame(const FTimingEventSearchParameters& InParameters, TFunctionRef<void(double, double, uint32, const Trace::FFrame&)> InFoundPredicate) const;

private:
    FFrameSharedState& SharedState;

    uint32 FrameType;  // ETraceFrameType

    FTrackHeader Header;

    // Search cache
    mutable TTimingEventSearchCache<Trace::FFrame> SearchCache;
};

////////////////////////////////////////////////////////////////////////////////////////////////////