className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
Timeline
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
|
TraceServices
|
typedef [ITimeline](API\Developer\TraceServices\TraceServices\Containers\ITimeline)< [FTimingProfilerEvent](API\Developer\TraceServices\TraceServices\Model\FTimingProfilerEvent) > Timeline
|
[] |
|
ITimingProfilerProvider::~ITimingProfilerProvider
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
|
TraceServices
|
virtual ~ITimingProfilerProvider()
|
[] |
|
ITimingProfilerProvider
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
|
TraceServices
|
class ITimingProfilerProvider : public [TraceServices::IProvider](API\Developer\TraceServices\TraceServices\Model\IProvider)
|
[] |
|
ITimingProfilerTimerReader::GetMetadata
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
|
TraceServices
|
[TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > GetMetadata ( uint32 TimerId ) const
|
[] |
|
ITimingProfilerTimerReader::GetTimer
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
|
TraceServices
|
const [FTimingProfilerTimer](API\Developer\TraceServices\TraceServices\Model\FTimingProfilerTimer) * GetTimer ( uint32 TimerId ) const
|
[] |
|
ITimingProfilerProvider::GetGpu2TimelineIndex
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
|
TraceServices
|
bool GetGpu2TimelineIndex ( uint32 & OutTimelineIndex ) const
|
[] |
|
ITimingProfilerTimerReader::GetTimerCount
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
|
TraceServices
|
uint32 GetTimerCount() const
|
[] |
|
ITimingProfilerTimerReader
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
|
TraceServices
|
class ITimingProfilerTimerReader
|
[] |
|
TagIdType
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
|
Id type for tags.
|
TraceServices
|
typedef uint32 TagIdType
|
[] |
TraceServices::EContextSwitchEnumerationResult
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/ContextSwitches.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum EContextSwitchEnumerationResult { Continue, Stop, } }
|
[] |
TraceServices::ECounterDisplayHint
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Counters.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ECounterDisplayHint { CounterDisplayHint_None, CounterDisplayHint_Memory, } }
|
[] |
TraceServices::ETaskEnumerationOption
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TasksProfiler.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ETaskEnumerationOption { Alive, Launched, Active, WaitingForPrerequisites, Queued, Executing, WaitingForNested, Completed, Count, } }
|
[] |
TraceServices::ETaskEnumerationResult
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TasksProfiler.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ETaskEnumerationResult { Continue, Stop, } }
|
[] |
TraceServices::EResolvedSymbolFilterStatus
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Modules.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum EResolvedSymbolFilterStatus { Unknown = 0, Filtered, NotFiltered, } }
|
[] |
TraceServices::ELoadTimeProfilerObjectEventType
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/LoadTimeProfiler.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ELoadTimeProfilerObjectEventType { LoadTimeProfilerObjectEventType_Create, LoadTimeProfilerObjectEventType_Serialize, LoadTimeProfilerObjectEventType_PostLoad, LoadTimeProfilerObjectEventType_None, } }
|
[] |
TraceServices::ENetProfilerDeliveryStatus
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/NetProfiler.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ENetProfilerDeliveryStatus { Unknown, Delivered, Dropped, } }
|
[] |
TraceServices::ENetProfilerAggregationMode
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/NetProfiler.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ENetProfilerAggregationMode { None, Aggregate, InstanceMax, } }
|
[] |
TraceServices::ENetProfilerConnectionMode
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/NetProfiler.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ENetProfilerConnectionMode { Outgoing = 0, Incoming = 1, Count, } }
|
[] |
TraceServices::ENetProfilerChannelCloseReason
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/NetProfiler.h
|
Mirrored from EChannelCloseReason on the runtime side.
|
TraceServices
|
namespace TraceServices { enum ENetProfilerChannelCloseReason { Destroyed = 0, Dormancy, LevelUnloaded, Relevancy, TearOff, } }
|
[] |
TraceServices::ENetProfilerConnectionState
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/NetProfiler.h
|
Mirrored from EConnectionState on the runtime side.
|
TraceServices
|
namespace TraceServices { enum ENetProfilerConnectionState { USOCK_Invalid = 0, USOCK_Closed = 1, USOCK_Pending = 2, USOCK_Open = 3, } }
|
[] |
TraceServices::ENetProfilerStatsCounterType
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/NetProfiler.h
|
This must be kept in sync with ENetTraceStatsCounterType in NetTrace.h.
|
TraceServices
|
namespace TraceServices { enum ENetProfilerStatsCounterType { Packet = 0, Frame = 1, } }
|
[] |
TraceServices::ECacheFlags
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h
|
Flags defining the behaviour of a cache entry
|
TraceServices
|
namespace TraceServices { enum ECacheFlags { ECacheFlags_NoGlobalCaching = 1 << 1, } }
|
[] |
TraceServices::ECounterOpType
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Counters.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ECounterOpType { Set = 0, Add = 1, } }
|
[] |
TraceServices::EFileActivityType
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/LoadTimeProfiler.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum EFileActivityType { FileActivityType_Open, FileActivityType_ReOpen, FileActivityType_Close, FileActivityType_Read, FileActivityType_Write, FileActivityType_Count, FileActivityType_Invalid = FileActivityType_Count, } }
|
[] |
TraceServices::EModuleStatus
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Modules.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum EModuleStatus { Discovered, Pending, Loaded, VersionMismatch, NotFound, Failed, StatusNum, FailedStatusStart = VersionMismatch, } }
|
[] |
TraceServices::ESymbolQueryResult
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Modules.h
|
Result of a query. Since symbol resolving can be deferred this signals if a symbol has been resolved, waiting to be resolved or wasn't found at all.
|
TraceServices
|
namespace TraceServices { enum ESymbolQueryResult { Pending, OK, NotLoaded, Mismatch, NotFound, StatusNum, } }
|
[] |
TraceServices::ETableDiffResult
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TableMerge.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ETableDiffResult { ESuccess = 0, EFail = 1, } }
|
[] |
TraceServices::ETableImportResult
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TableImport.h
|
Public interface to rewind debugger
|
TraceServices
|
namespace TraceServices { enum ETableImportResult { ESuccess = 0, EFail = 1, } }
|
[] |
TraceServices::ModuleStatusToString
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Modules.h
|
TraceServices
|
namespace TraceServices { const TCHAR * TraceServices::ModuleStatusToString ( [EModuleStatus](API\Developer\TraceServices\TraceServices\Model\TraceServices__EModuleStatus) Result ) }
|
[] |
|
TraceServices::QueryResultToString
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Modules.h
|
Helper method to get a string representation of the query result.
|
TraceServices
|
namespace TraceServices { const TCHAR * TraceServices::QueryResultToString ( [ESymbolQueryResult](API\Developer\TraceServices\TraceServices\Model\TraceServices__ESymbolQueryResul-) Result ) }
|
[] |
TraceServices::CreateCpuProfilerAnalyzer
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/AnalyzerFactories.h
|
Create an IAnalyzer object for external analysis.
|
TraceServices
|
namespace TraceServices { [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [UE::Trace::IAnalyzer](API\Developer\TraceAnalysis\Trace\IAnalyzer) > TraceServices::CreateCpuProfilerAnalyzer ( [IAnalysisSession](API\Developer\TraceServices\TraceServices\Model\IAnalysisSession) & InSession, [IEditableTimingProfilerProvider](API\Developer\TraceServices\TraceServices\Model\IEditableTimingProfilerProvider) & InEditableTimingProfilerProvider, [IEditableThreadProvider](API\Developer\TraceServices\TraceServices\Model\IEditableThreadProvider) & InEditableThreadProvider ) }
|
[] |
TraceServices::CreateAnalysisSession
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/AnalyzerFactories.h
|
Create anIAnalysisSessionobject for external analysis.
|
TraceServices
|
namespace TraceServices { [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalysisSession](API\Developer\TraceServices\TraceServices\Model\IAnalysisSession) > TraceServices::CreateAnalysisSession ( uint32 InTraceId, const TCHAR * InSessionName, [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [UE::Trace::IInDataStream](API\Developer\TraceAnalysis\Trace\IInDataStream) > && InDataStream ) }
|
[] |
TraceServices::CreateBookmarksAnalyzer
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/AnalyzerFactories.h
|
Create an IAnalyzer object for analyzing bookmark events.
|
TraceServices
|
namespace TraceServices { [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [UE::Trace::IAnalyzer](API\Developer\TraceAnalysis\Trace\IAnalyzer) > TraceServices::CreateBookmarksAnalyzer ( [IAnalysisSession](API\Developer\TraceServices\TraceServices\Model\IAnalysisSession) & InSession, [IEditableBookmarkProvider](API\Developer\TraceServices\TraceServices\Model\IEditableBookmarkProvider) & InEditableBookmarkProvider ) }
|
[] |
TraceServices::CreateCountersAnalyzer
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/AnalyzerFactories.h
|
Create an IAnalyzer object for analyzing counter events.
|
TraceServices
|
namespace TraceServices { [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [UE::Trace::IAnalyzer](API\Developer\TraceAnalysis\Trace\IAnalyzer) > TraceServices::CreateCountersAnalyzer ( [IAnalysisSession](API\Developer\TraceServices\TraceServices\Model\IAnalysisSession) & InSession, [IEditableCounterProvider](API\Developer\TraceServices\TraceServices\Model\IEditableCounterProvider) & InEditableCounterProvider ) }
|
[] |
TraceServices::FTraceAnalyzerUtils::LegacyAttachmentString
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Utils.h
|
TraceServices
|
namespace TraceServices { namespace FTraceAnalyzerUtils { template<typename AttachedCharType> [FString](API\Runtime\Core\Containers\FString) TraceServices::FTraceAnalyzerUtils::LegacyAttachmentString ( const ANSICHAR * FieldName, const [UE::Trace::IAnalyzer::FOnEventContext](API\Developer\TraceAnalysis\Trace\IAnalyzer\FOnEventContext) & Context ) } }
|
[] |
|
TraceServices::FTraceAnalyzerUtils::LegacyAttachmentArray
|
/Engine/Source/Developer/TraceServices/Public/TraceServices/Utils.h
|
TraceServices
|
namespace TraceServices { namespace FTraceAnalyzerUtils { [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > TraceServices::FTraceAnalyzerUtils::LegacyAttachmentArray ( const ANSICHAR * FieldName, const [UE::Trace::IAnalyzer::FOnEventContext](API\Developer\TraceAnalysis\Trace\IAnalyzer\FOnEventContext) & Context ) } }
|
[] |
|
FTreeMapAttribute::~FTreeMapAttribute
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Virtual destructor
|
TreeMap
|
virtual ~FTreeMapAttribute()
|
[] |
FTreeMapAttribute::FTreeMapAttribute
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Default constructor
|
TreeMap
|
FTreeMapAttribute()
|
[] |
FTreeMapAttribute
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Describes a customized attribute of a tree node
|
TreeMap
|
class FTreeMapAttribute
|
[
{
"type": "FTreeMapAttribu...",
"name": "DefaultValue",
"description": "Default value to use when none is specified on a node"
},
{
"type": "FName",
"name": "Name",
"description": "Name of this attribute"
},
{
"type": "TMap<FName, FT...",
"name": "Values",
"description": "Maps a value name to the data that describes that value"
}
] |
FTreeMapAttributeData::FTreeMapAttributeData
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Default constructor forFTreeMapAttributeData
|
TreeMap
|
FTreeMapAttributeData()
|
[] |
FTreeMapAttributeData::FTreeMapAttributeData
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Intitialization constructor forFTreeMapAttributeData
|
TreeMap
|
FTreeMapAttributeData ( const [FName](API\Runtime\Core\UObject\FName) InitValue )
|
[] |
FTreeMapAttributeData
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Stores data for a specific attribute type on a node
|
TreeMap
|
class FTreeMapAttributeData
|
[
{
"type": "FName",
"name": "Value",
"description": "Value for this data"
}
] |
FTreeMapAttributeValue::~FTreeMapAttributeValue
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Virtual destructor
|
TreeMap
|
virtual ~FTreeMapAttributeValue()
|
[] |
FTreeMapAttributeValue
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Describes a value for an attribute of a tree node
|
TreeMap
|
class FTreeMapAttributeValue
|
[
{
"type": "FName",
"name": "Name",
"description": "Name of this value"
},
{
"type": "FLinearColor",
"name": "NodeColor",
"description": "The node color that this value maps to"
},
{
"type": "float",
"name": "NodeSize",
"description": "The node size that this value maps to"
}
] |
FTreeMapNodeData::CopyNodeInto
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Copies this node into another node (not children, though. The copied node will have no children.)
|
TreeMap
|
void CopyNodeInto ( [FTreeMapNodeData](API\Developer\TreeMap\FTreeMapNodeData) & NodeCopy ) const
|
[] |
FTreeMapNodeData::CopyNodeRecursively
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Returns a copy of this node; all child nodes are copied, too!
|
TreeMap
|
FTreeMapNodeDataRef CopyNodeRecursively() const
|
[] |
FTreeMapNodeData::IsLeafNode
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Returns true if this is a leaf node
|
TreeMap
|
bool IsLeafNode() const
|
[] |
FTreeMapAttributeValue::FTreeMapAttributeValue
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Default constructor
|
TreeMap
|
FTreeMapAttributeValue()
|
[] |
FTreeMapNodeData::operator==
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
TreeMap
|
bool operator== ( const [FTreeMapNodeData](API\Developer\TreeMap\FTreeMapNodeData) & Other ) const
|
[] |
|
FTreeMapNodeData::operator!=
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
TreeMap
|
bool operator!= ( const [FTreeMapNodeData](API\Developer\TreeMap\FTreeMapNodeData) & Other ) const
|
[] |
|
FTreeMapNodeData::FTreeMapNodeData
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Default constructor forFTreeMapNodeData
|
TreeMap
|
FTreeMapNodeData()
|
[] |
FTreeMapNodeData
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Single node in a tree map, which may have any number of child nodes, each with their own children and so on
|
TreeMap
|
class FTreeMapNodeData : public [TSharedFromThis< FTreeMapNodeData >](API\Runtime\Core\Templates\TSharedFromThis)
|
[
{
"type": "TMap<FName, FT...",
"name": "Attributes",
"description": "Map of attribute name to it's respective bit of data"
},
{
"type": "constFSlateBru...",
"name": "BackgroundBrush",
"description": "Background brush for this node's box (optional)"
},
{
"type": "FString",
"name": "CenterText",
"description": "Center info text."
},
{
"type": "TArray< FTreeMa...",
"name": "Children",
"description": "List of child nodes"
},
{
"type": "FLinearColor",
"name": "Color",
"description": "Color for this node. This will be set automatically unless you use a customization."
},
{
"type": "TArray<FString...",
"name": "HashTags",
"description": "Hashtags for this node."
},
{
"type": "FString",
"name": "LogicalName",
"description": "Logical name, if set this is used for comparison"
},
{
"type": "FString",
"name": "Name",
"description": "Node name display."
},
{
"type": "FString",
"name": "Name2",
"description": "Node name (line 2)."
},
{
"type": "FTreeMapNodeDat...",
"name": "Parent",
"description": "Back pointer to parent node, or NULL if no parent exists (root node)"
},
{
"type": "float",
"name": "Size",
"description": "Size of this node."
}
] |
FTreeMapNodeVisualInfo
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Visual ID for a node, generated by the tree map system
|
TreeMap
|
struct FTreeMapNodeVisualInfo
|
[
{
"type": "bool",
"name": "bIsInteractive",
"description": "True if the node is 'interactive'."
},
{
"type": "FSlateFontInfo",
"name": "CenterTextFont",
"description": ""
},
{
"type": "FLinearColor",
"name": "Color",
"description": "Node color"
},
{
"type": "FSlateFontInfo",
"name": "Name2Font",
"description": ""
},
{
"type": "FSlateFontInfo",
"name": "NameFont",
"description": "Node fonts"
},
{
"type": "FTreeMapNodeDat...",
"name": "NodeData",
"description": "Pointer back to the node data this visual was originally created from"
},
{
"type": "FVector2D",
"name": "Position",
"description": "Position for this node"
},
{
"type": "FVector2D",
"name": "Size",
"description": "Size for this node"
}
] |
FTreeMapOptions::FTreeMapOptions
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Default constructor forFTreeMapOptionsthat initializes good defaults
|
TreeMap
|
FTreeMapOptions()
|
[] |
FTreeMapOptions
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Configuration for a new tree map
|
TreeMap
|
struct FTreeMapOptions
|
[
{
"type": "FSlateFontInfo",
"name": "CenterTextFont",
"description": "Font for any text that's centered inside the middle of the node."
},
{
"type": "float",
"name": "ContainerInnerPadding",
"description": "Padding around a set of children inside of containers, under the container's title area"
},
{
"type": "float",
"name": "DisplayHeight",
"description": "Height of whole display area"
},
{
"type": "float",
"name": "DisplayWidth",
"description": "Width of whole display area"
},
{
"type": "int32",
"name": "FontSizeChangeBasedOnDepth",
"description": "Number of font sizes to drop with each depth level of the tree"
},
{
"type": "float",
"name": "MinimumInteractiveNodeSize",
"description": "Minimize size of a tree node that will be allowed to have a title and padding."
},
{
"type": "float",
"name": "MinimumVisibleNodeSize",
"description": "Minimize size of a tree node that will be drawn at all, below this size it is invisible"
},
{
"type": "FSlateFontInfo",
"name": "Name2Font",
"description": "Font for second line of text, under the title."
},
{
"type": "FSlateFontInfo",
"name": "NameFont",
"description": "Font to use for titles."
},
{
"type": "float",
"name": "NestedContainerOuterPadding",
"description": "Padding around the outside of nested container nodes in the tree"
},
{
"type": "float",
"name": "TopLevelContainerOuterPadding",
"description": "Padding around the outside of top-level container nodes in the tree"
},
{
"type": "ETreeMapType",
"name": "TreeMapType",
"description": "Type of tree map"
}
] |
FTreeMapStyle::Get
|
/Engine/Source/Developer/TreeMap/Public/TreeMapStyle.h
|
TreeMap
|
static const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) & Get()
|
[] |
|
FTreeMapStyle::GetStyleSetName
|
/Engine/Source/Developer/TreeMap/Public/TreeMapStyle.h
|
TreeMap
|
static [FName](API\Runtime\Core\UObject\FName) GetStyleSetName()
|
[] |
|
FTreeMapStyle::Initialize
|
/Engine/Source/Developer/TreeMap/Public/TreeMapStyle.h
|
TreeMap
|
static void Initialize()
|
[] |
|
FTreeMapStyle::Shutdown
|
/Engine/Source/Developer/TreeMap/Public/TreeMapStyle.h
|
TreeMap
|
static void Shutdown()
|
[] |
|
StyleInstance
|
/Engine/Source/Developer/TreeMap/Public/TreeMapStyle.h
|
TreeMap
|
static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > StyleInstance;
|
[] |
|
FTreeMapStyle
|
/Engine/Source/Developer/TreeMap/Public/TreeMapStyle.h
|
Style data forSTreeMap
|
TreeMap
|
class FTreeMapStyle
|
[] |
ITreeMap::CreateTreeMap
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Static: Creates a tree map object, given tree node source data
The newly-createdITreeMapinstance
|
TreeMap
|
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITreeMap](API\Developer\TreeMap\ITreeMap) > CreateTreeMap ( const [FTreeMapOptions](API\Developer\TreeMap\FTreeMapOptions) & Options, const FTreeMapNodeDataRef & RootNodeData )
|
[] |
ITreeMap::GetVisuals
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Gets the visuals for this tree map. Be careful not to destroy the original tree while still using the visual objects, otherwise the back pointers to the original tree nodes will be trash! Visuals are ordered such that nested visuals appear later in the list than their parents (so they can be drawn back to front, etc.)
List of visuals
|
TreeMap
|
[TArray](API\Runtime\Core\Containers\TArray)< [FTreeMapNodeVisualInfo](API\Developer\TreeMap\FTreeMapNodeVisualInfo) > GetVisuals()
|
[] |
ITreeMap::ParseOPMLToTreeMapData
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Parses an OPML XML document and converts the outliner content to tree map node data
The root tree node for the parsed data, or an invalid pointer if something went wrong
|
TreeMap
|
static FTreeMapNodeDataPtr ParseOPMLToTreeMapData ( const [FString](API\Runtime\Core\Containers\FString) & OPMLFilePath, [FString](API\Runtime\Core\Containers\FString) & OutErrorMessage )
|
[] |
ITreeMap::~ITreeMap
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Virtual destructor
|
TreeMap
|
virtual ~ITreeMap()
|
[] |
ITreeMap
|
/Engine/Source/Developer/TreeMap/Public/ITreeMap.h
|
Public tree map interface
|
TreeMap
|
class ITreeMap
|
[] |
ITreeMapCustomization::GetAttributes
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Returns all of the possible attributes in this customization. Each attribute defines a set of possible values for that attribute.
|
TreeMap
|
const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), FTreeMapAttributePtr > & GetAttributes() const
|
[] |
ITreeMapCustomization::GetDefaultColorByAttribute
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Returns the default attribute type to color the nodes based on
|
TreeMap
|
virtual FTreeMapAttributePtr GetDefaultColorByAttribute() const
|
[] |
ITreeMapCustomization::GetDefaultSizeByAttribute
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Returns the default attribute type to size the nodes based on
|
TreeMap
|
virtual FTreeMapAttributePtr GetDefaultSizeByAttribute() const
|
[] |
ITreeMapCustomization::GetName
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Returns the name of this customization
|
TreeMap
|
[FName](API\Runtime\Core\UObject\FName) GetName() const
|
[] |
ITreeMapCustomization::ProcessHashTagsRecursively
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Optional override that can be called to convert hash tags on tree nodes into proper attribute values. This is useful if you've loaded tree node data from a file and want to take the raw hash tag strings and make values for those.
|
TreeMap
|
virtual void ProcessHashTagsRecursively ( const FTreeMapNodeDataRef & Node ) const
|
[] |
ITreeMapCustomization::~ITreeMapCustomization
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
Virtual destructor
|
TreeMap
|
virtual ~ITreeMapCustomization()
|
[] |
ITreeMapCustomization
|
/Engine/Source/Developer/TreeMap/Public/ITreeMapCustomization.h
|
ImplementITreeMapCustomizationand pass it along when creating your tree map to allow for custom attributes and formatting features!
|
TreeMap
|
class ITreeMapCustomization
|
[] |
STreeMap::ApplyVisualizationToNodes
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Called to apply the current 'size based on' and 'color based on' settings to the tree
|
TreeMap
|
void ApplyVisualizationToNodes ( const FTreeMapNodeDataRef & Node )
|
[] |
STreeMap::ApplyVisualizationToNodesRecursively
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Recursively applies the active visualization to all nodes, such as size by attribute, or color by attribute
|
TreeMap
|
void ApplyVisualizationToNodesRecursively ( const FTreeMapNodeDataRef & Node, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & DefaultColor, const int32 TreeDepth )
|
[] |
STreeMap::CanZoomOut
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Returns true if it is possible to zoom out
|
TreeMap
|
bool CanZoomOut() const
|
[] |
STreeMap::ComputeDesiredSize
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.
|
TreeMap
|
virtual FVector2D ComputeDesiredSize ( float ) const
|
[] |
STreeMap::Construct
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Construct the widget
|
TreeMap
|
void Construct ( const [FArguments](API\Developer\TreeMap\STreeMap\FArguments) & InArgs, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FTreeMapNodeData](API\Developer\TreeMap\FTreeMapNodeData) > & InTreeMapNodeData, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITreeMapCustomization](API\Developer\TreeMap\ITreeMapCustomization) > & InCustomization )
|
[] |
STreeMap::FArguments::AllowEditing
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Sets whether the user can edit the tree map interactively by dragging nodes around and typing new node labels
|
TreeMap
|
WidgetArgsType & AllowEditing &40; const TAttribute< bool > & InAttribute &41;
|
[] |
STreeMap::FArguments::BackgroundImage
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Background image to use for the tree map canvas area
|
TreeMap
|
WidgetArgsType & BackgroundImage &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;
|
[] |
STreeMap::FArguments::BorderPadding
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Border Padding around fill bar
|
TreeMap
|
WidgetArgsType & BorderPadding &40; const TAttribute< FVector2D > & InAttribute &41;
|
[] |
STreeMap::FArguments::CenterTextFont
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Font for any text that's centered inside the middle of the node. Leaf nodes only. Usually a bit larger. Works just like NameFont
|
TreeMap
|
WidgetArgsType & CenterTextFont &40; const TAttribute< FSlateFontInfo > & InAttribute &41;
|
[] |
STreeMap::FArguments::ChildContainerTextPadding
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
How many pixels to pad text that's drawn inside of a container (not the top-level container, though)
|
TreeMap
|
WidgetArgsType & ChildContainerTextPadding &40; float InArg &41;
|
[] |
STreeMap::FArguments::ContainerInnerPadding
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
How many pixels of spacing between the container and its child containers. Adding padding makes the tree look better, but you lose some sizing accuracy
|
TreeMap
|
WidgetArgsType & ContainerInnerPadding &40; float InArg &41;
|
[] |
STreeMap::FArguments::HoveredNodeBackground
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Background to use for nodes that the mouse is hovering over
|
TreeMap
|
WidgetArgsType & HoveredNodeBackground &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;
|
[] |
STreeMap::DeleteHoveredNode
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Deletes the node under the mouse cursor, if any (undoable!)
|
TreeMap
|
[FReply](API\Runtime\SlateCore\Input\FReply) DeleteHoveredNode()
|
[] |
STreeMap::FArguments::MinimumVisibleTreeNodeSize
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Minimum size in pixels of a tree node that we should bother including in the UI. Below this size, you'll need to drill down to see the node.
|
TreeMap
|
WidgetArgsType & MinimumVisibleTreeNodeSize &40; int32 InArg &41;
|
[] |
STreeMap::FArguments::MinimumInteractiveTreeNodeSize
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Minimum size of node that can be interacted with, if small you need to drill down into parent first
|
TreeMap
|
WidgetArgsType & MinimumInteractiveTreeNodeSize &40; int32 InArg &41;
|
[] |
STreeMap::FArguments::Name2Font
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Font for second line of text, under the title. Leaf nodes only. Usually a bit smaller. Works just like NameFont
|
TreeMap
|
WidgetArgsType & Name2Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;
|
[] |
STreeMap::FArguments::NameFont
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Sets the font used to draw the text. Note the height of the font may change automatically based on the tree node size
|
TreeMap
|
WidgetArgsType & NameFont &40; const TAttribute< FSlateFontInfo > & InAttribute &41;
|
[] |
STreeMap::FArguments::NavigationTransitionTime
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
How many seconds to animate the visual transition when the user navigates to a new tree node, or after a modification of the tree takes place
|
TreeMap
|
WidgetArgsType & NavigationTransitionTime &40; float InArg &41;
|
[] |
STreeMap::FArguments::NodeBackground
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Background to use for each tree node
|
TreeMap
|
WidgetArgsType & NodeBackground &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;
|
[] |
STreeMap::FArguments::OnTreeMapNodeDoubleClicked
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Optional delegate that fires when the node is double-clicked in the tree. If you don't override this, the tree will use its default handling of double-click, which will re-root the tree on the node under the cursor
|
TreeMap
|
WidgetArgsType & OnTreeMapNodeDoubleClicked &40; const FOnTreeMapNodeInteracted & InDelegate &41;
|
[] |
STreeMap::FArguments::OnTreeMapNodeRightClicked
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Optional delegate that fires when the node is right-clicked in the tree. If you don't override this nothing will happen unless a customization is specified
|
TreeMap
|
WidgetArgsType & OnTreeMapNodeRightClicked &40; const FOnTreeMapNodeInteracted & InDelegate &41;
|
[] |
STreeMap::FArguments::TopLevelContainerOuterPadding
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
How many pixels of padding around the outside of the root-level tree node box. Adding padding makes the tree look better, but you lose some sizing accuracy
|
TreeMap
|
WidgetArgsType & TopLevelContainerOuterPadding &40; float InArg &41;
|
[] |
WidgetArgsType
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
TreeMap
|
typedef FArguments WidgetArgsType
|
[] |
|
STreeMap::FArguments::FArguments
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
TreeMap
|
FArguments&40;&41;
|
[] |
|
STreeMap::FArguments::NestedContainerOuterPadding
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
How many pixels of padding around the outside of a non-root tree node's box. Adding padding makes the tree look better, but you lose some sizing accuracy
|
TreeMap
|
WidgetArgsType & NestedContainerOuterPadding &40; float InArg &41;
|
[] |
FArguments
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
TreeMap
|
struct FArguments : public [TSlateBaseNamedArgs< STreeMap >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
|
[] |
|
STreeMap::FindNodeInCopiedTree
|
/Engine/Source/Developer/TreeMap/Public/STreeMap.h
|
Searches for the specified node in an identical copy of the node tree.
|
TreeMap
|
FTreeMapNodeDataPtr FindNodeInCopiedTree ( const FTreeMapNodeDataRef & NodeToFind, const FTreeMapNodeDataRef & OriginalNode, const FTreeMapNodeDataRef & CopiedRootNode ) const
|
[] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.