IToolsContextQueriesAPI Class Reference

#include <ToolContextInterfaces.h>

Public Member Functions
virtual	~IToolsContextQueriesAPI ()
virtual UWorld *	GetCurrentEditingWorld () const =0
virtual void	GetCurrentSelectionState (FToolBuilderState &StateOut) const =0
virtual void	GetCurrentViewState (FViewCameraState &StateOut) const =0
virtual EToolContextCoordinateSystem	GetCurrentCoordinateSystem () const
virtual EToolContextTransformGizmoMode	GetCurrentTransformGizmoMode () const
virtual FToolContextSnappingConfiguration	GetCurrentSnappingSettings () const
virtual UMaterialInterface *	GetStandardMaterial (EStandardToolContextMaterials MaterialType) const =0
virtual FViewport *	GetHoveredViewport () const =0
virtual FViewport *	GetFocusedViewport () const =0

Detailed Description

Users of the Tools Framework need to implement IToolsContextQueriesAPI to provide access to scene state information like the current UWorld, active USelections, etc.

Constructor & Destructor Documentation

~IToolsContextQueriesAPI()

virtual IToolsContextQueriesAPI::~IToolsContextQueriesAPI ( )

inlinevirtual

Member Function Documentation

GetCurrentCoordinateSystem()

virtual EToolContextCoordinateSystem IToolsContextQueriesAPI::GetCurrentCoordinateSystem ( ) const

inlinevirtual

Request current external coordinate-system setting. Defaults to World coordinates.

GetCurrentEditingWorld()

virtual UWorld * IToolsContextQueriesAPI::GetCurrentEditingWorld ( ) const

pure virtual

Returns

the UWorld currently being targetted by the ToolsContext, default location for new Actors/etc

GetCurrentSelectionState()

virtual void IToolsContextQueriesAPI::GetCurrentSelectionState ( FToolBuilderState &  StateOut ) const

pure virtual

Collect up current-selection information for the current scene state (ie what is selected in Editor, etc)

Parameters

StateOut

this structure is populated with available state information

GetCurrentSnappingSettings()

virtual FToolContextSnappingConfiguration IToolsContextQueriesAPI::GetCurrentSnappingSettings ( ) const

inlinevirtual

Request current external snapping settings. Defaults to no snapping.

GetCurrentTransformGizmoMode()

virtual EToolContextTransformGizmoMode IToolsContextQueriesAPI::GetCurrentTransformGizmoMode ( ) const

inlinevirtual

Request current external Gizmo Mode setting. Defaulting this to Combined gizmo as this was the default behavior before UE-5.2.

GetCurrentViewState()

virtual void IToolsContextQueriesAPI::GetCurrentViewState ( FViewCameraState &  StateOut ) const

pure virtual

Request information about current view state

Parameters

StateOut

this structure is populated with available state information

GetFocusedViewport()

virtual FViewport * IToolsContextQueriesAPI::GetFocusedViewport ( ) const

pure virtual

Returns

the last valid viewport that received some input, or nullptr.

GetHoveredViewport()

virtual FViewport * IToolsContextQueriesAPI::GetHoveredViewport ( ) const

pure virtual

Returns

the last valid viewport that was hovered, or nullptr.

GetStandardMaterial()

virtual UMaterialInterface * IToolsContextQueriesAPI::GetStandardMaterial ( EStandardToolContextMaterials  MaterialType ) const

pure virtual

Many tools need standard types of materials that the user should provide (eg a vertex-color material, etc)

Parameters

MaterialType

the type of material being requested

Returns

Instance of material to use for this purpose

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/InteractiveToolsFramework/Public/ToolContextInterfaces.h