1. Epic GamesDeveloper
  3. FVisualLogEntry

FVisualLogEntry

API > API/Runtime > API/Runtime/Engine

   
Name FVisualLogEntry
Type struct
Header File /Engine/Source/Runtime/Engine/Public/VisualLogger/VisualLoggerTypes.h
Include Path #include "VisualLogger/VisualLoggerTypes.h"

Syntax

struct FVisualLogEntry

Constructors

Name Remarks Include Path Unreal Specifiers

FVisualLogEntry()

   VisualLogger/VisualLoggerTypes.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsAllowedToLog uint8   VisualLogger/VisualLoggerTypes.h  
bIsInitialized uint8   VisualLogger/VisualLoggerTypes.h  
bIsLocationValid uint8   VisualLogger/VisualLoggerTypes.h  
bPassedClassAllowList uint8   VisualLogger/VisualLoggerTypes.h  
bPassedObjectAllowList uint8   VisualLogger/VisualLoggerTypes.h  
DataBlocks TArray< FVisualLogDataBlock >   VisualLogger/VisualLoggerTypes.h  
ElementsToDraw TArray< FVisualLogShapeElement >   VisualLogger/VisualLoggerTypes.h  
Events TArray< FVisualLogEvent >   VisualLogger/VisualLoggerTypes.h  
HistogramSamples TArray< FVisualLogHistogramSample >   VisualLogger/VisualLoggerTypes.h  
Location FVector   VisualLogger/VisualLoggerTypes.h  
LogLines TArray< FVisualLogLine >   VisualLogger/VisualLoggerTypes.h  
Status TArray< FVisualLogStatusCategory >   VisualLogger/VisualLoggerTypes.h  
TimeStamp double For absolute position of events along a timeline (can involve multiple worlds/game instances such as clients and server) VisualLogger/VisualLoggerTypes.h  
WorldTimeStamp double The time of the event according to its UWorld (can vary widely between game instances such as clients and server) VisualLogger/VisualLoggerTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Arrow VisualLogger/VisualLoggerTypes.h  

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

 Box VisualLogger/VisualLoggerTypes.h  

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

 Boxes VisualLogger/VisualLoggerTypes.h  

void AddCapsule ( const FVector& Base,
float HalfHeight,
float Radius,
const FQuat& Rotation,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FColor& Color,
const FString& Description,
bool bInUseWires
)

 Capsule VisualLogger/VisualLoggerTypes.h  

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,
bool bInUseWires
)

 Circle VisualLogger/VisualLoggerTypes.h  

void AddCone ( const FVector& Origin,
const FVector& Direction,
float Length,
float AngleWidth,
float AngleHeight,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FColor& Color,
const FString& Description,
uint16 Thickness,
bool bInUseWires
)

 Cone VisualLogger/VisualLoggerTypes.h  

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

 2d convex VisualLogger/VisualLoggerTypes.h  

void AddCoordinateSystem ( const FVector& AxisLoc,
const FRotator& AxisRot,
const float Scale,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FColor& Color,
const FString& Description,
uint16 Thickness
)

 Coordinate system VisualLogger/VisualLoggerTypes.h  

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

 Cylinder VisualLogger/VisualLoggerTypes.h  

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

 Custom data block. VisualLogger/VisualLoggerTypes.h  

void AddElement ( const FVisualLogShapeElement& Element
)

 Custom element VisualLogger/VisualLoggerTypes.h  

int32 AddEvent ( const FVisualLogEventBase& Event
)

 Event. VisualLogger/VisualLoggerTypes.h  

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

 Histogram sample VisualLogger/VisualLoggerTypes.h  

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

 Location VisualLogger/VisualLoggerTypes.h  

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

 3d Mesh VisualLogger/VisualLoggerTypes.h  

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

 Path VisualLogger/VisualLoggerTypes.h  

void AddPulledConvex ( const TArray< FVector >& ConvexPoints,
FVector::FReal MinZ,
FVector::FReal MaxZ,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FColor& Color,
const FString& Description
)

 NavArea or vertically pulled convex shape. VisualLogger/VisualLoggerTypes.h  

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

 Segment VisualLogger/VisualLoggerTypes.h  

void AddSphere ( const FVector& Center,
float Radius,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FColor& Color,
const FString& Description,
bool bInUseWires
)

 Sphere VisualLogger/VisualLoggerTypes.h  

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

   VisualLogger/VisualLoggerTypes.h  

int32 FindStatusIndex ( const FString& CategoryName
)

 Find index of status category VisualLogger/VisualLoggerTypes.h  

void InitializeEntry ( const double InTimeStamp
)

   VisualLogger/VisualLoggerTypes.h  

void MoveTo ( FVisualLogEntry& Other
)

 Moves all content to provided entry and reseting our content. VisualLogger/VisualLoggerTypes.h  

void Reset()

   VisualLogger/VisualLoggerTypes.h  

void SetPassedObjectAllowList ( const bool bPassed
)

   VisualLogger/VisualLoggerTypes.h  

bool ShouldFlush ( double InTimeStamp
) const

   VisualLogger/VisualLoggerTypes.h  

bool ShouldLog ( const ECreateIfNeeded ShouldCreate
) const

   VisualLogger/VisualLoggerTypes.h  

void UpdateAllowedToLog()

   VisualLogger/VisualLoggerTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page