Navigation
API > API/Developer > API/Developer/TraceInsights > API/Developer/TraceInsights/Insights
Inheritance Hierarchy
- IModuleInterface
- IUnrealInsightsModule
References
| Module | TraceInsights |
| Header | /Engine/Source/Developer/TraceInsights/Public/Insights/IUnrealInsightsModule.h |
| Include | #include "Insights/IUnrealInsightsModule.h" |
Syntax
class IUnrealInsightsModule : public IModuleInterface
Remarks
Interface for an Unreal Insights module.
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | ConnectToStore
(
const TCHAR* InStoreHost, |
Connects to a specified store. | |
| void | Creates the default trace store (for "Browser" mode). | ||
| void | CreateSessionViewer
(
bool bAllowDebugTools |
Called when the application starts in "Viewer" mode. | |
| bool | Exec
(
const TCHAR* Cmd, |
Execute command. | |
| const FInsightsMajorTabConfig & | FindMajorTabConfig
(
const FName& InMajorTabId |
Finds a major tab config for the specified id. | |
| FOnRegisterMajorTabExtensions * | FindMajorTabLayoutExtension
(
const FName& InMajorTabId |
||
| TSharedPtr< const TraceServices::IAnalysisSession > | Gets the current analysis session. | ||
| FString | Gets the default trace store (for "Browser" mode). | ||
| TSharedPtr<::Insights::IInsightsManager > | Gets the Insights manager. | ||
| UE::Trace::FStoreClient * | Gets the store client. | ||
| void | InitializeTesting
(
bool InInitAutomationModules, |
Called to initialize testing in stand alone Insights. | |
| FOnInsightsMajorTabCreated & | Callback invoked when a major tab is created | ||
| FOnRegisterMajorTabExtensions & | OnRegisterMajorTabExtension
(
const FName& InMajorTabId |
Allows for registering a delegate callback for populating a FInsightsMajorTabExtender structure. | |
| void | RegisterComponent
(
TSharedPtr< IInsightsComponent > Component |
Registers an IInsightsComponent. | |
| void | RegisterMajorTabConfig
(
const FName& InMajorTabId, |
Registers a major tab layout. | |
| void | ScheduleCommand
(
const FString& InCmd |
Called to schedule a command to run after session analysis is complete. | |
| void | SetUnrealInsightsLayoutIni
(
const FString& InIniPath |
Sets the ini path for saving persistent layout data. | |
| void | Called when the application shuts-down. | ||
| void | StartAnalysisForLastLiveSession
(
float InRetryTime |
Starts analysis of the last live session. | |
| void | StartAnalysisForTrace
(
uint32 InTraceId, |
Starts analysis of the specified trace. Called when the application starts in "Viewer" mode. | |
| void | StartAnalysisForTraceFile
(
const TCHAR* InTraceFile, |
Starts analysis of the specified *.utrace file. | |
| void | UnregisterComponent
(
TSharedPtr< IInsightsComponent > Component |
Unregisters an IInsightsComponent. | |
| void | UnregisterMajorTabConfig
(
const FName& InMajorTabId |
Unregisters a major tab layout. This will revert the major tab to spawning with its default layout |