Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Users of the Tools Framework need to implement IToolsContextQueriesAPI to provide access to scene state information like the current UWorld, active USelections, etc.
| Name | IToolsContextQueriesAPI |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/ToolContextInterfaces.h |
| Include Path | #include "ToolContextInterfaces.h" |
Syntax
class IToolsContextQueriesAPI
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IToolsContextQueriesAPI() |
ToolContextInterfaces.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EToolContextCoordinateSystem GetCurrentCoordinateSystem() |
Request current external coordinate-system setting. Defaults to World coordinates. | ToolContextInterfaces.h | |
UWorld * GetCurrentEditingWorld() |
ToolContextInterfaces.h | ||
void GetCurrentSelectionState
(
FToolBuilderState& StateOut |
Collect up current-selection information for the current scene state (ie what is selected in Editor, etc) | ToolContextInterfaces.h | |
virtual FToolContextSnappingConfiguration GetCurrentSnappingSettings() |
Request current external snapping settings. Defaults to no snapping. | ToolContextInterfaces.h | |
| Request current external Gizmo Mode setting. | ToolContextInterfaces.h | ||
void GetCurrentViewState
(
FViewCameraState& StateOut |
Request information about current view state | ToolContextInterfaces.h | |
FViewport * GetFocusedViewport() |
ToolContextInterfaces.h | ||
FViewport * GetHoveredViewport() |
ToolContextInterfaces.h | ||
UMaterialInterface * GetStandardMaterial
(
EStandardToolContextMaterials MaterialType |
Many tools need standard types of materials that the user should provide (eg a vertex-color material, etc) | ToolContextInterfaces.h |