ReporterGraph.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Debug/ReporterBase.h"
#include "ReporterGraph.generated.h"
 
class UCanvas;
class UFont;
 
UENUM()
namespace EGraphAxisStyle
{
    enum Type : int
    {
        Lines,
        Notches,
        Grid,
    };
}
 
UENUM()
namespace EGraphDataStyle
{
    enum Type : int
    {
        Lines,
        Filled,
    };
}
 
UENUM()
namespace ELegendPosition
{
    enum Type : int
    {
        Outside,
        Inside
    };
}
 
struct FRect
{
    FVector2D Min;
    FVector2D Max;
};
 
struct FGraphThreshold
{
    float Threshold;
 
    FLinearColor Color;
 
    FString ThresholdName;
 
    FGraphThreshold()
        : Threshold(0.0f),
        Color(FLinearColor::White),
        ThresholdName("UNDEFINED")
    {
 
    }
 
    FGraphThreshold(float InThreshold, const FLinearColor& InColor, FString InName)
        : Threshold(InThreshold),
        Color(InColor),
        ThresholdName(InName)
    {
 
    }
};
 
struct FGraphLine
{
    TArray<FVector2D> Data;
 
    FLinearColor Color;
 
    FVector2D LeftExtreme;
 
    FVector2D RightExtreme;
 
    FString LineName;
};
 
UCLASS(MinimalAPI)
class UReporterGraph : public UReporterBase
{
    GENERATED_UCLASS_BODY()
 
public:
 
    inline void SetStyles(EGraphAxisStyle::Type NewAxisStyle, EGraphDataStyle::Type NewDataStyle) { AxisStyle = NewAxisStyle; DataStyle = NewDataStyle; }
 
    inline void SetAxesColor(FLinearColor NewAxesColor) { AxesColor = NewAxesColor; }
 
    ENGINE_API void SetGraphScreenSize(float MinX, float MaxX, float MinY, float MaxY);
    
    ENGINE_API void SetGraphScreenSize(const FVector2D& Min, const FVector2D& Max);
 
    ENGINE_API virtual void Draw(UCanvas* Canvas) override;
 
    ENGINE_API void SetAxesMinMax(float MinX, float MaxX, float MinY, float MaxY);
 
    ENGINE_API void SetAxesMinMax(const FVector2D& Min, const FVector2D& Max);
 
    inline void SetNotchesPerAxis(int NewNumXNotches, int NewNumYNotches) { NumXNotches = NewNumXNotches; NumYNotches = NewNumYNotches; }
 
    ENGINE_API void SetNumGraphLines(int32 NumDataLines);
 
    ENGINE_API FGraphLine* GetGraphLine(int32 LineIndex);
 
    ENGINE_API void SetNumThresholds(int32 NumThresholds);
 
    ENGINE_API FGraphThreshold* GetThreshold(int32 ThresholdIndex);
 
    ENGINE_API void SetBackgroundColor(FColor Color);
 
    ENGINE_API void SetLegendPosition(ELegendPosition::Type Position);
 
    void OffsetDataSets(bool Enable) { bOffsetDataSets = Enable; }
 
    bool IsOffsetForDataSetsEnabled() { return !!bOffsetDataSets; }
 
    void SetCursorLocation(float InValue) { CursorLocation = InValue; }
 
    void UseTinyFont(bool InUseTinyFont) { bUseTinyFont = InUseTinyFont;  }
 
    void DrawCursorOnGraph(bool InDrawCursorOnGraph) { bDrawCursorOnGraph = InDrawCursorOnGraph;  }
 
    void DrawExtremesOnGraph(bool InDrawExtremes) { bDrawExtremes = InDrawExtremes; }
 
    ENGINE_API void DrawBackground(UCanvas* Canvas);
 
    ENGINE_API void DrawLegend(UCanvas* Canvas);
 
    ENGINE_API void DrawAxes(UCanvas* Canvas);
 
    ENGINE_API void DrawAxis(UCanvas* Canvas, FVector2D Start, FVector2D End, float NumNotches, bool bIsVerticalAxis);
 
    ENGINE_API void DrawThresholds(UCanvas* Canvas);
 
    ENGINE_API void DrawData(UCanvas* Canvas);
 
    ENGINE_API virtual FVector2D ToScreenSpace(const FVector2D& InVector, UCanvas* Canvas) override;
 
    ENGINE_API FVector2D DataToNormalized(const FVector2D& InVector);
 
    ENGINE_API UFont* GetDefaultFont();
 
    FRect GraphScreenSize;
 
    FRect GraphMinMaxData;
 
    TArray<FGraphThreshold> Thresholds;
 
    TArray<FGraphLine> CurrentData;
 
    FLinearColor AxesColor;
 
    int NumXNotches;
        
    int NumYNotches;
 
    EGraphAxisStyle::Type AxisStyle;
 
    EGraphDataStyle::Type DataStyle;
 
    ELegendPosition::Type LegendPosition;
 
    float LegendWidth;
 
    FColor BackgroundColor;
 
    float CursorLocation;
 
    int32 bOffsetDataSets : 1;
 
    int32 bUseTinyFont : 1;
 
    int32 bDrawCursorOnGraph : 1;
 
    int32 bDrawExtremes : 1;
};