IToolsContextQueriesAPI::ExecuteSceneSnapQuery

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

Windows
MacOS
Linux

Warnings

  • implementations are not required (and may not be able) to support snapping

References

Module

InteractiveToolsFramework

Header

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

Include

#include "ToolContextInterfaces.h"

Syntax

bool ExecuteSceneSnapQuery
(
    const FSceneSnapQueryRequest & Request,
    TArray< FSceneSnapQueryResult > & Results
) const

Remarks

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

implementations are not required (and may not be able) to support snapping

Returns

true if any valid snap target was found

Parameters

Parameter

Description

Request

snap query configuration

Results

list of potential snap results

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss