1. Epic GamesDeveloper
  3. IUnrealInsightsModule

IUnrealInsightsModule

Interface for an Unreal Insights module.

API > API/Developer > API/Developer/TraceInsights

Interface for an Unreal Insights module.

   
Name IUnrealInsightsModule
Type class
Header File /Engine/Source/Developer/TraceInsights/Public/Insights/IUnrealInsightsModule.h
Include Path #include "Insights/IUnrealInsightsModule.h"

Syntax

class IUnrealInsightsModule : public IModuleInterface

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IUnrealInsightsModule()

   Insights/IUnrealInsightsModule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ConnectToStore ( const TCHAR* InStoreHost,
uint32 InStorePort
)

 Connects to a specified store. Insights/IUnrealInsightsModule.h  

void CreateDefaultStore()

 Creates the default trace store (for "Browser" mode). Insights/IUnrealInsightsModule.h  

void CreateSessionViewer ( bool bAllowDebugTools
)

 Called when the application starts in "Viewer" mode. Insights/IUnrealInsightsModule.h  

bool Exec ( const TCHAR* Cmd,
FOutputDevice& Ar
)

 Execute command. Insights/IUnrealInsightsModule.h  

const FInsightsMajorTabConfig & FindMajorTabConfig ( const FName& InMajorTabId
) const

 Finds a major tab config for the specified id. Insights/IUnrealInsightsModule.h  

FOnRegisterMajorTabExtensions * FindMajorTabLayoutExtension ( const FName& InMajorTabId
)

   Insights/IUnrealInsightsModule.h  

TSharedPtr< const TraceServices::IAnalysisSession > GetAnalysisSession()

 Gets the current analysis session. Insights/IUnrealInsightsModule.h  

FString GetDefaultStoreDir()

 Gets the default trace store (for "Browser" mode). Insights/IUnrealInsightsModule.h  

TSharedPtr<::Insights::IInsightsManager > GetInsightsManager()

 Gets the Insights manager. Insights/IUnrealInsightsModule.h  

UE::Trace::FStoreClient * GetStoreClient()

 Gets the store client. Insights/IUnrealInsightsModule.h  

void InitializeTesting ( bool InInitAutomationModules,
bool InAutoQuit
)

 Called to initialize testing in stand alone Insights. Insights/IUnrealInsightsModule.h  

FOnInsightsMajorTabCreated & OnMajorTabCreated()

 Callback invoked when a major tab is created Insights/IUnrealInsightsModule.h  

FOnRegisterMajorTabExtensions & OnRegisterMajorTabExtension ( const FName& InMajorTabId
)

 Allows for registering a delegate callback for populating a FInsightsMajorTabExtender structure. Insights/IUnrealInsightsModule.h  
Registers an IInsightsComponent. Insights/IUnrealInsightsModule.h  

void RegisterMajorTabConfig ( const FName& InMajorTabId,
const FInsightsMajorTabConfig& InConfig
)

 Registers a major tab layout. Insights/IUnrealInsightsModule.h  

void ScheduleCommand ( const FString& InCmd
)

 Called to schedule a command to run after session analysis is complete. Insights/IUnrealInsightsModule.h  

void SetAutoQuit ( bool bInAutoQuit,
bool bInWaitForSymbolResolver
)

 Sets the AutoQuit behavior when analysis is completed. Insights/IUnrealInsightsModule.h  

void SetUnrealInsightsLayoutIni ( const FString& InIniPath
)

 Sets the ini path for saving persistent layout data. Insights/IUnrealInsightsModule.h  

void ShutdownUserInterface()

 Called when the application shuts-down. Insights/IUnrealInsightsModule.h  

void StartAnalysisForLastLiveSession ( float InRetryTime
)

 Starts analysis of the last live session. Insights/IUnrealInsightsModule.h  

void StartAnalysisForTrace ( uint32 InTraceId
)

 Starts analysis of the specified trace. Called when the application starts in "Viewer" mode. Insights/IUnrealInsightsModule.h  

virtual void StartAnalysisForTrace ( uint32 InTraceId,
bool bInAutoQuit,
bool bInWaitForSymbolResolver
)

   Insights/IUnrealInsightsModule.h  

void StartAnalysisForTraceFile ( const TCHAR* InTraceFile
)

 Starts analysis of the specified *.utrace file. Insights/IUnrealInsightsModule.h  

virtual void StartAnalysisForTraceFile ( const TCHAR* InTraceFile,
bool bInAutoQuit,
bool bInWaitForSymbolResolver
)

   Insights/IUnrealInsightsModule.h  

uint16 StartAnalysisWithDirectTrace ( const TCHAR* InStreamName,
uint16 InPort
)

 Starts analysis for a direct connection from the tracing application (might be self). Insights/IUnrealInsightsModule.h  

void StartAnalysisWithStream ( TUniquePtr< UE::Trace::IInDataStream >&& InStream,
const TCHAR* InStreamName
)

 Start analysis given a data stream. Insights/IUnrealInsightsModule.h  
Unregisters an IInsightsComponent. Insights/IUnrealInsightsModule.h  

void UnregisterMajorTabConfig ( const FName& InMajorTabId
)

 Unregisters a major tab layout. This will revert the major tab to spawning with its default layout Insights/IUnrealInsightsModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page