IToolsContextQueriesAPI

Users of the Tools Framework need to implement [IToolsContextQueriesAPI](API\Runtime\InteractiveToolsFramework\IToolsContextQueriesAPI) to provide access to scene state information like the current [UWorld](API\Runtime\Engine\Engine\UWorld), active USelections, etc.

Windows
MacOS
Linux

References

Module

InteractiveToolsFramework

Header

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

Include

#include "ToolContextInterfaces.h"

Syntax

class IToolsContextQueriesAPI

Remarks

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

Destructors

Name Description

Public function Virtual

~IToolsContextQueriesAPI()

Functions

Name Description

Public function Const

bool

 

ExecuteSceneSnapQuery

(
    const FSceneSnapQueryRequest& Requ...,
    TArray< FSceneSnapQueryResult >& R...
)

Try to find Snap Targets in the scene that satisfy the Snap Query.

Public function Const

EToolContext...

 

GetCurrentCoordinateSystem()

Request current external coordinate-system setting

Public function Const

void

 

GetCurrentSelectionState

(
    FToolBuilderState& StateOut
)

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

Public function Const

void

 

GetCurrentViewState

(
    FViewCameraState& StateOut
)

Request information about current view state

Public function Const

HHitProxy &#...

 

GetHitProxy

(
    int32 X,
    int32 Y
)

When selecting, sometimes we need a hit proxy rather than a physics trace or other raycast.

Public function Const

UMaterialInt...

 

GetStandardMaterial

(
    EStandardToolContextMaterials Mater...
)

Many tools need standard types of materials that the user should provide (eg a vertex-color material, etc)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss