UReporterGraph

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Debug/ReporterGraph.h

Include

#include "Debug/ReporterGraph.h"

Syntax

class UReporterGraph : public UReporterBase

Variables

Name Description

Public variable

FLinearColor

 

AxesColor

The color of the axes.

Public variable

EGraphAxisStyle...

 

AxisStyle

The axis style.

Public variable

FColor

 

BackgroundColor

Background color to draw under graph.

Public variable

int32: 1

 

bDrawCursorOnGraph

If set, enables cursor for line graphs.

Public variable

int32: 1

 

bDrawExtremes

If set, draws extremes on vertical axes.

Public variable

int32: 1

 

bOffsetDataSets

If set, enables small offset for graphs to better visualize overlapping data sets.

Public variable

int32: 1

 

bUseTinyFont

If set, forces tiny font for texts.

Public variable

TArray< FGraphL...

 

CurrentData

The data displayed on the graph.

Public variable

float

 

CursorLocation

Current location for cursor on line graphs.

Public variable

EGraphDataStyle...

 

DataStyle

The data style.

Public variable

FRect

 

GraphMinMaxData

The minimum and maximum for the graph data.

Public variable

FRect

 

GraphScreenSize

The screen size of the graph.

Public variable

ELegendPosition...

 

LegendPosition

Current legend position.

Public variable

float

 

LegendWidth

The maximum length of the legend names.

Public variable

int

 

NumXNotches

The number of notches on the X axis.

Public variable

int

 

NumYNotches

The number of notches on the Y axis.

Public variable

TArray< FGraphT...

 

Thresholds

Constructors

Name Description

Public function

UReporterGraph

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

FVector2D

 

DataToNormalized

(
    const FVector2D& InVector
)

Helper to convert data from raw data into screen space.

Public function

void

 

DrawAxes

(
    UCanvas* Canvas
)

Draw the Axes.

Public function

void

 

DrawAxis

(
    UCanvas* Canvas,
    FVector2D Start,
    FVector2D End,
    float NumNotches,
    bool bIsVerticalAxis
)

Draw an individual axis.

Public function

void

 

DrawBackground

(
    UCanvas* Canvas
)

Draw background under graph.

Public function

void

 

DrawCursorOnGraph

(
    bool InDrawCursorOnGraph
)

Setter to enable or disable cursor for line graphs.

Public function

void

 

DrawData

(
    UCanvas* Canvas
)

Draw the data.

Public function

void

 

DrawExtremesOnGraph

(
    bool InDrawExtremes
)

Public function

void

 

DrawLegend

(
    UCanvas* Canvas
)

Draw the Legend.

Public function

void

 

DrawThresholds

(
    UCanvas* Canvas
)

Draw the thresholds.

Public function

UFont *

 

GetDefaultFont()

Returns default font used to print texts.

Public function

FGraphLine &...

 

GetGraphLine

(
    int32 LineIndex
)

Get a pointer to a graph line.

Public function

FGraphThresh...

 

GetThreshold

(
    int32 ThresholdIndex
)

Get a pointer to a threshold.

Public function

bool

 

IsOffsetForDataSetsEnabled()

Checks if we have enabled offset for data sets on graph.

Public function

void

 

OffsetDataSets

(
    bool Enable
)

Enables small offset for data sets to make it easier to read.

Public function

void

 

SetAxesColor

(
    FLinearColor NewAxesColor
)

Set the color of the axes.

Public function

void

 

SetAxesMinMax

(
    const FVector2D& Min,
    const FVector2D& Max
)

Set the axis min and max data for both axes.

Public function

void

 

SetAxesMinMax

(
    float MinX,
    float MaxX,
    float MinY,
    float MaxY
)

Set the axis min and max data for both axes.

Public function

void

 

SetBackgroundColor

(
    FColor Color
)

Sets background color.

Public function

void

 

SetCursorLocation

(
    float InValue
)

Sets cursor location on line graph to show value at specific place.

Public function

void

 

SetGraphScreenSize

(
    const FVector2D& Min,
    const FVector2D& Max
)

Set The size of the graph.

Public function

void

 

SetGraphScreenSize

(
    float MinX,
    float MaxX,
    float MinY,
    float MaxY
)

Set The size of the graph.

Public function

void

 

SetLegendPosition

(
    ELegendPosition::Type Position
)

Sets position where to draw legend.

Public function

void

 

SetNotchesPerAxis

(
    int NewNumXNotches,
    int NewNumYNotches
)

Set notches per axis.

Public function

void

 

SetNumGraphLines

(
    int32 NumDataLines
)

Set the number of graph lines.

Public function

void

 

SetNumThresholds

(
    int32 NumThresholds
)

Set the number of Thresholds to display on this graph.

Public function

void

 

SetStyles

(
    EGraphAxisStyle::Type NewAxisStyle,
    EGraphDataStyle::Type NewDataStyle
)

Set the styles of the axes.

Public function

void

 

UseTinyFont

(
    bool InUseTinyFont
)

Setter to force tiny font instead of small font.

Overridden from UReporterBase

Name Description

Public function Virtual

void

 

Draw

(
    UCanvas* Canvas
)

Main draw call for the Graph.

Public function Virtual

FVector2D

 

ToScreenSpace

(
    const FVector2D& InVector,
    UCanvas* Canvas
)

Helper to convert vectors from normalized into screen space.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss