1. Epic GamesDeveloper
  3. FVisualLogEntry

FVisualLogEntry

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/VisualLogger

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/VisualLogger/VisualLoggerTypes.h
Include #include "VisualLogger/VisualLoggerTypes.h"

Syntax

struct FVisualLogEntry

Variables

  Type Name Description
Public variable uint8: 1 bIsAllowedToLog  
Public variable uint8: 1 bIsInitialized  
Public variable uint8: 1 bIsLocationValid  
Public variable uint8: 1 bPassedClassAllowList  
Public variable uint8: 1 bPassedObjectAllowList  
Public variable TArray< FVisualLogDataBlock > DataBlocks  
Public variable TArray< FVisualLogShapeElement > ElementsToDraw  
Public variable TArray< FVisualLogEvent > Events  
Public variable TArray< FVisualLogHistogramSample > HistogramSamples  
Public variable FVector Location  
Public variable TArray< FVisualLogLine > LogLines  
Public variable TArray< FVisualLogStatusCategory > Status  
Public variable double TimeStamp  

Constructors

  Type Name Description
Public function    
Public function  

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

  
Public function  

FVisualLogEntry ( double InTimeStamp,
FVector InLocation,
const UObject* Object,
TArray< TWeakObjectPtr< UObject > >* Children
)

  

Functions

  Type 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

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

 Circle
Public function void

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

 2d convex
Public function FVisualLogDataBlock &

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

 Custom data block.
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& Element
)

 Custom element
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 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 TArray< FVector >& ConvexPoints,
FVector::FReal MinZ,
FVector::FReal MaxZ,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FColor& Color,
const FString& Description
)

 NavAreaMesh.
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 >& 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& 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& Point,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FColor& Color,
const FString& Description,
uint16 Thickness
)

 Location
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 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

InitializeEntry ( const double InTimeStamp
)

  
Public function void

MoveTo ( FVisualLogEntry& Other
)

 Moves all content to provided entry and reseting our content.
Public function void

Reset ()

  
Public function void

SetPassedObjectAllowList ( const bool bPassed
)

  
Public function Const bool

ShouldFlush ( double InTimeStamp
)

  
Public function Const bool

ShouldLog ( const ECreateIfNeeded ShouldCreate
)

  
Public function void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page