Navigation
API > API/Developer > API/Developer/TraceInsights
| Name | ISpatialPlotViewExtender |
| Type | class |
| Header File | /Engine/Source/Developer/TraceInsights/Public/Insights/SpatialProfiler/ISpatialPlotViewExtender.h |
| Include Path | #include "Insights/SpatialProfiler/ISpatialPlotViewExtender.h" |
Syntax
class ISpatialPlotViewExtender : public IModularFeature
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISpatialPlotViewExtender() |
Insights/SpatialProfiler/ISpatialPlotViewExtender.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FText GetLayerDisplayName() |
Insights/SpatialProfiler/ISpatialPlotViewExtender.h | ||
FName GetLayerName() |
Must be unique across all registered extenders. | Insights/SpatialProfiler/ISpatialPlotViewExtender.h | |
bool HasDataForSession
(
const TraceServices::IAnalysisSession& InAnalysisSession |
Whether this extender has data available for the given session. | Insights/SpatialProfiler/ISpatialPlotViewExtender.h | |
void OnBeginSession
(
const TraceServices::IAnalysisSession& InAnalysisSession |
Insights/SpatialProfiler/ISpatialPlotViewExtender.h | ||
void OnEndSession() |
Insights/SpatialProfiler/ISpatialPlotViewExtender.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AppendTooltip
(
FTooltipDrawState& InOutTooltip, |
Appends tooltip content for hit-tested regions/markers. Return true if content was added. | Insights/SpatialProfiler/ISpatialPlotViewExtender.h | |
virtual TSharedPtr< SWidget > CreateControlPanel() |
Creates the control panel widget. Called from FOnSpawnTab when the tab is opened. | Insights/SpatialProfiler/ISpatialPlotViewExtender.h | |
virtual void EnumerateMarkers
(
TFunctionRef< void(const FSpatialPlotMarker&)> InCallback |
Insights/SpatialProfiler/ISpatialPlotViewExtender.h | ||
virtual void EnumerateRegions
(
TFunctionRef< void(const FSpatialPlotRegion&)> InCallback |
Insights/SpatialProfiler/ISpatialPlotViewExtender.h | ||
virtual bool ExtendContextMenu
(
FMenuBuilder& InOutMenuBuilder, |
Appends context-menu entries for hit-tested regions/markers. Return true if entries were added. | Insights/SpatialProfiler/ISpatialPlotViewExtender.h | |
virtual uint32 GetChangeSerial () |
Returns a serial that changes when extender data changes. | Insights/SpatialProfiler/ISpatialPlotViewExtender.h | |
virtual FSlateIcon GetLayerIcon() |
Insights/SpatialProfiler/ISpatialPlotViewExtender.h | ||
virtual TOptional< FSpatialPlotLegend > GetLegend() |
Returns a legend describing the color mapping for this extender's regions. | Insights/SpatialProfiler/ISpatialPlotViewExtender.h | |
virtual bool HasControlPanel() |
Whether this extender provides a control panel widget, auto-docked in the right panel. | Insights/SpatialProfiler/ISpatialPlotViewExtender.h | |
virtual void Tick
(
const FSpatialPlotViewExtenderTickParams& InTickParams |
Insights/SpatialProfiler/ISpatialPlotViewExtender.h |