1. Epic GamesDeveloper
  3. FVisualLogger

FVisualLogger

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

Inheritance Hierarchy

References

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

Syntax

class FVisualLogger : public FOutputDevice

Variables

  Type Name Description
Protected variable TMap< FName, FVisualLogExtensionInterface * > AllExtensions Visual Logger extensions map.
Protected variable bool: 1 bBlockedAllCategories If set all categories are blocked from logging
Protected variable bool: 1 bContainsInvalidRedirects Indicates there are entries in the redirection map that are invalid
Protected variable bool: 1 bForceUniqueLogNames Controls how we generate log names.
Protected variable bool: 1 bIsFlushRequired Indicates that entries were added/updated and that a flush is required
Protected variable bool: 1 bIsRecordingOnServer Variable set (from cheat manager) when logging is active on server
Protected variable bool: 1 bIsRecordingToFile If set we are recording to file
Protected variable bool: 1 bIsRecordingToTrace If set we are recording to insights trace
Protected variable TArray< FName > CategoryAllowList List of categories that are still allowed to be logged when logging is blocking
Protected variable FChildToOwnerRedirectionMap ChildToOwnerMap For any object that has requested redirection this map holds where we should redirect the traffic to
Protected variable TArray< UClass * > ClassAllowList Allowed classes - only instances of these classes will be logged.
Protected variable FVisualLoggerObjectEntryMap CurrentEntryPerObject Current entry with all data.
Protected variable FRWLock EntryRWLock Read Write lock protecting object entries.
Protected variable TFunction< double(const UObject *)> GetTimeStampFunc Function to call when getting the time stamp
Protected variable TMap< double, int32 > LastUniqueIds Last generated unique id for given times tamp
Protected variable FVisualLogFilenameGetterDelegate LogFileNameGetter Delegate to set project specific file name for vlogs
Protected variable TSet< FObjectKey > ObjectAllowList Allowed objects - takes priority over class allow list and should be used to create exceptions in it if ObjectAllowList is empty (default) everything will log do NOT read from those pointers, they can be invalid!
Protected variable TMap< FObjectKey, FName > ObjectToClassNameMap Map to contain class names for Objects (they can be destroyed after while)
Protected variable TMap< FObjectKey, FName > ObjectToNameMap Map to contain names for Objects (they can be destroyed after while)
Protected variable FObjectToWorldMapType ObjectToWorldMap Cached map to world information because it's just raw pointer and not real object.
Protected variable TArray< FVisualLogDevice * > OutputDevices Array of output devices to redirect to
Protected variable FRWLock RedirectRWLock Read Write lock protecting redirection maps (ChildToOwnerMap and ObjectToWorldMap)
Protected variable double StartRecordingToFileTime Start recording time
Protected variable TArray< FVisualLoggerObjectEntryMap * > ThreadCurrentEntryMaps Threads current entry maps.
Protected variable FTSTicker::FDelegateHandle TickerHandle Handle to the registered ticker to flush entries

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void  
Public function void  
Public function void

AddDevice ( FVisualLogDevice* InDevice
)

 Add visual logger output device
Public function void

AddObjectToAllowList ( const UObject& InObject
)

  
Public function Static void

ArrowLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FVector& Start,
const FVector& End,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

ArrowLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const FVector& Start,
const FVector& End,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 Arrow.
Public function void

BlockAllCategories ( const bool bInBlock
)

 Blocks all categories from logging. It can be bypassed with the category allow list
Public function Static void

CategorizedLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const FmtType& Fmt,
Types... Args
)

 Regular text log.
Public function Static void

CategorizedLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FmtType& Fmt,
Types... Args
)

  
Public function Static bool

CheckVisualLogInputInternal ( const UObject* Object,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
UWorld** World,
FVisualLogEntry** CurrentEntry
)

 Internal check for each usage of visual logger
Public function Static void

CircleLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const FVector& Center,
const FVector& UpAxis,
const float Radius,
const FColor& Color,
const uint16 Thickness,
const FmtType& Fmt,
Types... Args
)

 Circle log.
Public function Static void

CircleLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FVector& Center,
const FVector& UpAxis,
const float Radius,
const FColor& Color,
const uint16 Thickness,
const FmtType& Fmt,
Types... Args
)

  
Public function void

Cleanup ( UWorld* OldWorld,
bool bReleaseMemory
)

 Removes all logged data.
Public function void  
Public function void  
Public function void Disables recording to file and discards all data without saving it to file
Public function Static void

EventLog ( const UObject* LogOwner,
const FName EventTag1,
const FVisualLogEventBase& Event1,
const FVisualLogEventBase& Event2
)

 Log events
Public function Static void

EventLog ( const UObject* LogOwner,
const FName EventTag1,
const FVisualLogEventBase& Event1,
const FVisualLogEventBase& Event2,
const FVisualLogEventBase& Event3
)

 Log events
Public function Static void

EventLog ( const UObject* LogOwner,
const FVisualLogEventBase& Event1,
const FName EventTag1,
const FName EventTag2,
const FName EventTag3,
const FName EventTag4,
const FName EventTag5,
const FName EventTag6
)

  
Public function Static void

EventLog ( const UObject* LogOwner,
const FName EventTag1,
const FVisualLogEventBase& Event1,
const FVisualLogEventBase& Event2,
const FVisualLogEventBase& Event3,
const FVisualLogEventBase& Event4,
const FVisualLogEventBase& Event5,
const FVisualLogEventBase& Event6
)

 Log events
Public function Static void

EventLog ( const UObject* LogOwner,
const FName EventTag1,
const FVisualLogEventBase& Event1,
const FName EventTag2,
const FName EventTag3,
const FName EventTag4,
const FName EventTag5,
const FName EventTag6
)

 Log events
Public function Static void

EventLog ( const UObject* LogOwner,
const FName EventTag1,
const FVisualLogEventBase& Event1,
const FVisualLogEventBase& Event2,
const FVisualLogEventBase& Event3,
const FVisualLogEventBase& Event4,
const FVisualLogEventBase& Event5
)

 Log events
Public function Static void

EventLog ( const UObject* LogOwner,
const FName EventTag1,
const FVisualLogEventBase& Event1,
const FVisualLogEventBase& Event2,
const FVisualLogEventBase& Event3,
const FVisualLogEventBase& Event4
)

 Log events
Public function Static UObject *

FindRedirection ( const UObject* Object
)

 Find and return redirection object for given object
Protected function void

FlushEntry ( FVisualLogEntry& Entry,
const FObjectKey& ObjectKey
)

 Serializes a single entry and resets it.
Public function void Moves all threads entries into the global entry map
Public function Static void

GeometryBoxLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FBox& Box,
const FMatrix& Matrix,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

GeometryBoxLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const FBox& Box,
const FMatrix& Matrix,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 Box log.
Public function Static void

GeometryConvexLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const TArray< FVector >& Points,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 2d Convex shape
Public function Static void

GeometryConvexLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const TArray< FVector >& Points,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const FVector& Location,
float Radius,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 Location/Sphere log.
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const TArray< FVector >& Vertices,
const TArray< int32 >& Indices,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const FVector& Start,
const FVector& End,
const FColor& Color,
const uint16 Thickness,
const FmtType& Fmt,
Types... Args
)

 Segment log.
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FVector& Start,
const FVector& End,
const FColor& Color,
const uint16 Thickness,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const FVector& Start,
const FVector& End,
const float Radius,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 Cylinder log.
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FVector& Start,
const FVector& End,
const float Radius,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const FVector& Origin,
const FVector& Direction,
const float Length,
const float Angle,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 Cone log.
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FVector& Origin,
const FVector& Direction,
const float Length,
const float Angle,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const TArray< FVector >& Vertices,
const TArray< int32 >& Indices,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 3d Mesh log
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FVector& Base,
float HalfHeight,
float Radius,
const FQuat& Rotation,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const FVector& Location,
float Radius,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

GeometryShapeLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const FVector& Base,
float HalfHeight,
float Radius,
const FQuat& Rotation,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 Capsule log.
Public function Static FVisualLogger &

Get ()

 Static getter
Public function Const const TMap< FName, FVisualLogExtensionInterface * > & Returns reference to map with all registered extension
Public function Const const TArray< FName > & Returns category allow list for logging
Public function FChildToOwnerRedirectionMap &  
Public function Const const TArray< FVisualLogDevice * > & Remove visual logger output device
Public function FVisualLogEntry *

GetEntryToWrite ( const UObject* Object,
double TimeStamp,
ECreateIfNeeded ShouldCreate
)

 Returns current entry for given TimeStamp or creates another one but first it serialize previous entry as completed to vislog devices.
Public function Const FVisualLogExtensionInterface *

GetExtensionForTag ( const FName TagName
)

 Returns extension identified by given tag
Public function FVisualLogEntry *

GetLastEntryForObject ( const UObject* Object
)

 Retrieves last used entry for given UObject
Public function FObjectToWorldMapType &  
Public function Static FOwnerToChildrenRedirectionMap &

GetRedirectionMap ( const UObject* InObject
)

  
Public function Const double

GetTimeStampForObject ( const UObject* Object
)

 Returns time stamp for object
Public function int32

GetUniqueId ( double Timestamp
)

 Generates and returns Id unique for given timestamp - used to connect different logs between (ex. text log with geometry shape)
Public function Static void

HistogramDataLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
FName GraphName,
FName DataName,
const FVector2D& Data,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

HistogramDataLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
FName GraphName,
FName DataName,
const FVector2D& Data,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 Histogram data.
Public function Const bool Checks if all categories are blocked
Public function Const bool

IsCategoryAllowed ( const FName& Name
)

  
Public function Const bool

IsCategoryLogged ( const FLogCategoryBase& Category
)

 Check if log category can be recorded, verify before using GetEntryToWrite!
Public function Const bool

IsClassAllowed ( const UClass& InClass
)

  
Public function Const bool

IsObjectAllowed ( const UObject* InObject
)

  
Public function Static bool Return information is vlog recording is enabled or not
Public function Const bool  
Public function Const bool Return information is vlog recording is enabled or not
Public function Static void

NavAreaShapeLogf ( const UObject* LogOwner,
const FName& CategoryName,
ELogVerbosity::Type Verbosity,
const TArray< FVector >& ConvexPoints,
float MinZ,
float MaxZ,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

  
Public function Static void

NavAreaShapeLogf ( const UObject* LogOwner,
const FLogCategoryBase& Category,
ELogVerbosity::Type Verbosity,
const TArray< FVector >& ConvexPoints,
float MinZ,
float MaxZ,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

 NavArea/Extruded convex log.
Public function Static void

NavigationDataDump ( const UObject* LogOwner,
const FName& CategoryName,
const ELogVerbosity::Type Verbosity,
const FBox& Box
)

 Navigation data debug snapshot.
Public function Static void

NavigationDataDump ( const UObject* LogOwner,
const FLogCategoryBase& Category,
const ELogVerbosity::Type Verbosity,
const FBox& Box
)

 Navigation data debug snapshot.
Public function Static void

Redirect ( const UObject* FromObject,
const UObject* ToObject
)

 Set log owner redirection from one object to another, to combine logs
Public function void

RegisterExtension ( FName TagName,
FVisualLogExtensionInterface* ExtensionInterface
)

 Register extension to use by LogVisualizer
Public function void Remove visual logger output device
Public function void

SetGetTimeStampFunc ( TFunction< double(const UObject*)> Function
)

 Sets function to call to get a timestamp instead of the default implementation (i.e. world time)
Public function void

SetIsRecording ( const bool bInIsRecording
)

 Starts visual log collecting and recording
Public function void

SetIsRecordingOnServer ( const bool bInIsRecording
)

  
Public function void

SetIsRecordingToFile ( bool InIsRecording
)

 Starts visual log collecting and recording
Public function void

SetIsRecordingToTrace ( const bool bInIsRecording
)

 Starts visual log collecting and recording to insights traces (for Rewind Debugger)
Public function void

SetLogFileNameGetter ( const FVisualLogFilenameGetterDelegate& InLogFileNameGetter
)

 FileName getter to set project specific file name for vlogs - highly encouraged to use FVisualLogFilenameGetterDelegate::CreateUObject with this
Public function void

SetUseUniqueNames ( const bool bEnable
)

 Configure whether VisLog should be using decorated, unique names
Public function Virtual void Called on engine shutdown to flush all, etc.
Protected function void

Tick ( float DeltaTime
)

 Flushes entries recorded in the frame
Public function void

UnregisterExtension ( FName TagName,
FVisualLogExtensionInterface* ExtensionInterface
)

 Removes previously registered extension

Overridden from FOutputDevice

  Type Name Description
Public function Virtual void

Flush ()

 Flush and serialize data if timestamp allows it

Typedefs

Name Description
FChildToOwnerRedirectionMap  
FNavigationDataDump  
FObjectToWorldMapType  
FOwnerToChildrenRedirectionMap  
FVisualLoggerObjectEntryMap  

Constants

Name Description
bIsRecording If set we are recording and collecting all vlog data
NavigationDataDumpDelegate  
WorldToRedirectionMap Map for inter-objects redirections.

Deprecated Functions

  Type Name Description
Public function void Use AddCategoryToAllowList instead
Public function void Use AddObjectToAllowList instead
Public function void

AddWhitelistedObject ( const UObject& InObject
)

 Use AddObjectToAllowList instead
Public function void Use ClearCategoryAllowList instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page