FVisualLogEntry

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/VisualLogger/VisualLoggerTypes.h

Include

#include "VisualLogger/VisualLoggerTypes.h"

Syntax

struct FVisualLogEntry

Variables

Name Description

Public variable

uint8: 1

 

bIsAllowedToLog

Public variable

uint8: 1

 

bIsClassWhitelisted

Public variable

uint8: 1

 

bIsObjectWhitelisted

Public variable

TArray< FVisual...

 

DataBlocks

Public variable

TArray< FVisual...

 

ElementsToDraw

Public variable

TArray< FVisual...

 

Events

Public variable

TArray< FVisual...

 

HistogramSamples

Public variable

FVector

 

Location

Public variable

TArray< FVisual...

 

LogLines

Public variable

TArray< FVisual...

 

Status

Public variable

float

 

TimeStamp

Constructors

Name Description

Public function

FVisualLogEntry()

Public function

FVisualLogEntry

(
    const FVisualLogEntry& Entry
)

Public function

FVisualLogEntry

(
    const AActor* InActor,
    TArray< TWeakObjectPtr< UObject > >...
)

Public function

FVisualLogEntry

(
    float InTimeStamp,
    FVector InLocation,
    const UObject* Object,
    TArray< TWeakObjectPtr< UObject > >...
)

Functions

Name Description

Public function

void

 

AddArrow

(
    const FVector& Start,
    const FVector& End,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description
)

Arrow

Public function

void

 

AddBoxes

(
    const TArray< FBox >& Boxes,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color
)

Boxes

Public function

void

 

AddConvexElement

(
    const TArray< FVector >& Points,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description
)

2d convex

Public function

FVisualLogDa...

 

AddDataBlock

(
    const FString& TagName,
    const TArray< uint8 >& BlobDataArr...,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity
)

Custom data block.

Public function

void

 

AddElement

(
    const FVector& Orgin,
    const FVector& Direction,
    float Length,
    float AngleWidth,
    float AngleHeight,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description,
    uint16 Thickness
)

Cone.

Public function

void

 

AddElement

(
    const FVector& Center,
    float HalfHeight,
    float Radius,
    const FQuat& Rotation,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description
)

Capsule

Public function

void

 

AddElement

(
    const FVector& Start,
    const FVector& End,
    float Radius,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description,
    uint16 Thickness
)

Cylinder.

Public function

void

 

AddElement

(
    const TArray< FVector >& ConvexPoi...,
    float MinZ,
    float MaxZ,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description
)

NavAreaMesh.

Public function

void

 

AddElement

(
    const FBox& Box,
    const FMatrix& Matrix,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description,
    uint16 Thickness
)

Box

Public function

void

 

AddElement

(
    const FVector& Start,
    const FVector& End,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description,
    uint16 Thickness
)

Segment

Public function

void

 

AddElement

(
    const TArray< FVector >& Vertices,
    const TArray< int32 >& Indices,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description
)

3d Mesh

Public function

void

 

AddElement

(
    const FVector& Point,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description,
    uint16 Thickness
)

Location

Public function

void

 

AddElement

(
    const TArray< FVector >& Points,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FColor& Color,
    const FString& Description,
    uint16 Thickness
)

Path

Public function

void

 

AddElement

(
    const FVisualLogShapeElement& Elem...
)

Custom element

Public function

int32

 

AddEvent

(
    const FVisualLogEventBase& Event
)

Event.

Public function

void

 

AddHistogramData

(
    const FVector2D& DataSample,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity,
    const FName& GraphName,
    const FName& DataName
)

Histogram sample

Public function

void

 

AddText

(
    const FString& TextLine,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity
)

Public function

int32

 

FindStatusIndex

(
    const FString& CategoryName
)

Find index of status category

Public function

void

 

Reset()

Public function

void

 

UpdateAllowedToLog()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback