Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FVisualLogger |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/VisualLogger/VisualLogger.h |
| Include Path | #include "VisualLogger/VisualLogger.h" |
Syntax
class FVisualLogger : public FOutputDevice
Inheritance Hierarchy
- FOutputDevice → FVisualLogger
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVisualLogger() |
VisualLogger/VisualLogger.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FVisualLogger() |
VisualLogger/VisualLogger.h |
Structs
| Name | Remarks |
|---|---|
| FObjectNames | |
| FVisualLoggerObjectEntryMap |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FChildToOwnerRedirectionMap | TMap< FObjectKey, TWeakObjectPtr< const UObject > > | VisualLogger/VisualLogger.h | |
| FNavigationDataDump | TMulticastDelegate_SixParams< void, const UObject *, const FName &, const ELogVerbosity::Type, const FBox &, const UWorld &, FVisualLogEntry & > | VisualLogger/VisualLogger.h | |
| FObjectToWorldMapType | TMap< FObjectKey, TWeakObjectPtr< const UWorld > > | VisualLogger/VisualLogger.h | |
| FOwnerToChildrenRedirectionMap | TMap< FObjectKey, TArray< TWeakObjectPtr< const UObject > > > | VisualLogger/VisualLogger.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bIsRecording | int32 | If set we are recording and collecting all vlog data | VisualLogger/VisualLogger.h |
| NavigationDataDumpDelegate | FNavigationDataDump | VisualLogger/VisualLogger.h | |
| WorldToRedirectionMap | TMap< const UWorld *, FOwnerToChildrenRedirectionMap > | Map for inter-objects redirections. | VisualLogger/VisualLogger.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddCategoryToAllowList
(
FName Category |
VisualLogger/VisualLogger.h | ||
void AddClassToAllowList
(
UClass& InClass |
VisualLogger/VisualLogger.h | ||
void AddDevice
(
FVisualLogDevice* InDevice |
Add visual logger output device | VisualLogger/VisualLogger.h | |
void AddObjectToAllowList
(
const UObject& InObject |
VisualLogger/VisualLogger.h | ||
void BlockAllCategories
(
const bool bInBlock |
Blocks all categories from logging. It can be bypassed with the category allow list | VisualLogger/VisualLogger.h | |
void Cleanup
(
UWorld* OldWorld, |
Removes all logged data. | VisualLogger/VisualLogger.h | |
void ClearCategoryAllowList() |
VisualLogger/VisualLogger.h | ||
void ClearObjectAllowList() |
VisualLogger/VisualLogger.h | ||
void DiscardRecordingToFile() |
Disables recording to file and discards all data without saving it to file | VisualLogger/VisualLogger.h | |
bool ExecuteOnLastEntryForObject
(
const UObject* Object, |
Executes the provided function using the last used entry for given UObject if any. | VisualLogger/VisualLogger.h | |
void FlushThreadsEntries() |
Moves all threads entries into the global entry map | VisualLogger/VisualLogger.h | |
const TMap< FName, FVisualLogExtensionInterface * > & GetAllExtensions() |
Returns reference to map with all registered extension | VisualLogger/VisualLogger.h | |
| Returns category allow list for logging | VisualLogger/VisualLogger.h | ||
FChildToOwnerRedirectionMap & GetChildToOwnerRedirectionMap() |
VisualLogger/VisualLogger.h | ||
const TArray< FVisualLogDevice * > & GetDevices() |
Remove visual logger output device | VisualLogger/VisualLogger.h | |
FVisualLogEntry * GetEntryToWrite
(
const UObject* Object, |
Returns current entry for given TimeStamp or creates another one but first it serialize previous entry as completed to vislog devices. | VisualLogger/VisualLogger.h | |
FVisualLogExtensionInterface * GetExtensionForTag
(
const FName TagName |
Returns extension identified by given tag | VisualLogger/VisualLogger.h | |
FVisualLogEntry * GetLastEntryForObject
(
const UObject* Object |
Retrieves last used entry for given UObject | VisualLogger/VisualLogger.h | |
FObjectToWorldMapType & GetObjectToWorldMap() |
VisualLogger/VisualLogger.h | ||
double GetTimeStampForObject
(
const UObject* Object |
Returns a current time stamp to associate with a recorded event that occurred on Object (used for ordering events on a timeline) | VisualLogger/VisualLogger.h | |
int32 GetUniqueId
(
double Timestamp |
Generates and returns Id unique for given timestamp - used to connect different logs between (ex. text log with geometry shape) | VisualLogger/VisualLogger.h | |
bool IsBlockedForAllCategories() |
Checks if all categories are blocked | VisualLogger/VisualLogger.h | |
bool IsCategoryAllowed
(
const FName& Name |
VisualLogger/VisualLogger.h | ||
bool IsCategoryLogged
(
const FLogCategoryBase& Category |
Check if log category can be recorded, verify before using GetEntryToWrite! | VisualLogger/VisualLogger.h | |
bool IsClassAllowed
(
const UClass& InClass |
VisualLogger/VisualLogger.h | ||
bool IsObjectAllowed
(
const UObject* InObject |
VisualLogger/VisualLogger.h | ||
bool IsRecordingOnServer() |
VisualLogger/VisualLogger.h | ||
bool IsRecordingToFile() |
Return information is vlog recording is enabled or not | VisualLogger/VisualLogger.h | |
void OnDataReset() |
Use when a visual logger device has discarded all of its data, waiting for new data. | VisualLogger/VisualLogger.h | |
void RegisterExtension
(
FName TagName, |
Register extension to use by LogVisualizer | VisualLogger/VisualLogger.h | |
void RemoveDevice
(
FVisualLogDevice* InDevice |
Remove visual logger output device | VisualLogger/VisualLogger.h | |
| Sets function to call to get a timestamp instead of the default implementation (e.g. using a network synchronized clock instead of the local world time) | VisualLogger/VisualLogger.h | ||
void SetIsRecording
(
const bool bInIsRecording |
Starts visual log collecting and recording | VisualLogger/VisualLogger.h | |
void SetIsRecordingOnServer
(
const bool bInIsRecording |
VisualLogger/VisualLogger.h | ||
void SetIsRecordingToFile
(
bool InIsRecording |
Starts visual log collecting and recording | VisualLogger/VisualLogger.h | |
void SetIsRecordingToTrace
(
const bool bInIsRecording |
Starts visual log collecting and recording to insights traces (for Rewind Debugger) | VisualLogger/VisualLogger.h | |
void SetLogFileNameGetter
(
const FVisualLogFilenameGetterDelegate& InLogFileNameGetter |
FileName getter to set project specific file name for vlogs - highly encouraged to use FVisualLogFilenameGetterDelegate::CreateUObject with this | VisualLogger/VisualLogger.h | |
void SetUseUniqueNames
(
const bool bEnable |
Configure whether VisLog should be using decorated, unique names | VisualLogger/VisualLogger.h | |
virtual void Shutdown() |
VisualLogger/VisualLogger.h | ||
void UnregisterExtension
(
FName TagName, |
Removes previously registered extension | VisualLogger/VisualLogger.h |
Overridden from FOutputDevice
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Flush() |
Flush and serialize data if timestamp allows it | VisualLogger/VisualLogger.h | |
virtual void TearDown() |
Called on engine shutdown to flush all, etc. | VisualLogger/VisualLogger.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void FlushEntry
(
FVisualLogEntry& Entry, |
Serializes a single entry and resets it. | VisualLogger/VisualLogger.h | |
void Tick
(
float DeltaTime |
Flushes entries recorded in the frame | VisualLogger/VisualLogger.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void ArrowLineLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ArrowLineLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ArrowLineLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ArrowLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ArrowLogf
(
const UObject* LogOwner, |
Arrow. | VisualLogger/VisualLogger.h | |
static void ArrowLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void BoxLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void BoxLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void BoxLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CapsuleLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CapsuleLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CapsuleLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CategorizedLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CategorizedLogf
(
const UObject* LogOwner, |
Regular text log. | VisualLogger/VisualLogger.h | |
static void CategorizedLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static bool CheckVisualLogInputInternal
(
const UObject* Object, |
Internal check for each usage of visual logger | VisualLogger/VisualLogger.h | |
static void CircleLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CircleLogf
(
const UObject* LogOwner, |
Circle log. | VisualLogger/VisualLogger.h | |
static void CircleLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ConeLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ConeLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ConeLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ConvexLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ConvexLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void ConvexLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CoordinateSystemLogf
(
const UObject* LogOwner, |
Coordinate System. | VisualLogger/VisualLogger.h | |
static void CoordinateSystemLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CoordinateSystemLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CylinderLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CylinderLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void CylinderLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void DiscLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void DiscLogf
(
const UObject* LogOwner, |
Disc/circle log. | VisualLogger/VisualLogger.h | |
static void DiscLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void EventLog
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void EventLog
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void EventLog
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void EventLog
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
| Log events | VisualLogger/VisualLogger.h | ||
| VisualLogger/VisualLogger.h | |||
static void EventLog
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
| Find and return redirection object for given object | VisualLogger/VisualLogger.h | ||
static void GeometryBoxLogf
(
const UObject* LogOwner, |
Box log. | VisualLogger/VisualLogger.h | |
static void GeometryBoxLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void GeometryConvexLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void GeometryConvexLogf
(
const UObject* LogOwner, |
2d Convex shape | VisualLogger/VisualLogger.h | |
static void GeometryShapeLogf
(
const UObject* LogOwner, |
Capsule log. | VisualLogger/VisualLogger.h | |
static void GeometryShapeLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void GeometryShapeLogf
(
const UObject* LogOwner, |
Cone log. | VisualLogger/VisualLogger.h | |
static void GeometryShapeLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void GeometryShapeLogf
(
const UObject* LogOwner, |
Cylinder log. | VisualLogger/VisualLogger.h | |
static void GeometryShapeLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void GeometryShapeLogf
(
const UObject* LogOwner, |
Segment log. | VisualLogger/VisualLogger.h | |
static void GeometryShapeLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void GeometryShapeLogf
(
const UObject* LogOwner, |
3d Mesh log | VisualLogger/VisualLogger.h | |
static void GeometryShapeLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void GeometryShapeLogf
(
const UObject* LogOwner, |
Location log. | VisualLogger/VisualLogger.h | |
static void GeometryShapeLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static FVisualLogger & Get() |
Static getter | VisualLogger/VisualLogger.h | |
static FVisualLogEntry * GetEntryToWrite
(
const UObject* LogOwner, |
Returns the current (or new) entry for the given object; alternatively nullptr if we aren't allowed to vlog with the given parameters. | VisualLogger/VisualLogger.h | |
static FOwnerToChildrenRedirectionMap & GetRedirectionMap
(
const UObject* InObject |
VisualLogger/VisualLogger.h | ||
static void HistogramDataLogf
(
const UObject* LogOwner, |
Histogram data. | VisualLogger/VisualLogger.h | |
static void HistogramDataLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
| VisualLogger/VisualLogger.h | |||
static bool IsRecording() |
Return information is vlog recording is enabled or not | VisualLogger/VisualLogger.h | |
static void LocationLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void LocationLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void LocationLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void MeshLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
| VisualLogger/VisualLogger.h | |||
| VisualLogger/VisualLogger.h | |||
static void NavAreaShapeLogf
(
const UObject* LogOwner, |
NavArea/Extruded convex log. | VisualLogger/VisualLogger.h | |
static void NavAreaShapeLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void NavigationDataDump
(
const UObject* LogOwner, |
Navigation data debug snapshot. | VisualLogger/VisualLogger.h | |
static void NavigationDataDump
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void PulledConvexLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void PulledConvexLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void PulledConvexLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
| Set log owner redirection from one object to another, to combine logs | VisualLogger/VisualLogger.h | ||
static void SegmentLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void SegmentLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void SegmentLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void SphereLogf
(
const UObject* LogOwner, |
Sphere log. | VisualLogger/VisualLogger.h | |
static void SphereLogf
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h | ||
static void SphereLogfImpl
(
const UObject* LogOwner, |
VisualLogger/VisualLogger.h |