USceneSnappingManager

[USceneSnappingManager](API\Runtime\InteractiveToolsFramework\SceneQueries\USceneSnappingManager) is intended to be used as a base class for a Snapping implementation stored in the ContextObjectStore of an InteractiveToolsContext.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/SceneQueries/SceneSnappingManager.h

Include

#include "SceneQueries/SceneSnappingManager.h"

Syntax

class USceneSnappingManager : public UObject

Remarks

USceneSnappingManager is intended to be used as a base class for a Snapping implementation stored in the ContextObjectStore of an InteractiveToolsContext. ITF classes like Tools and Gizmos can then access this object and run snap queries via the various API functions.

USceneSnappingManager::Find() can be used to look up a registered USceneSnappingManager, if one is available

See UModelingSceneSnappingManager for a sample implementation.

Functions

Name Description

Public function Virtual Const

bool

 

ExecuteSceneHitQuery

(
    const FSceneHitQueryRequest& Reque...,
    FSceneHitQueryResult& ResultOut
)

Try to find a Hit Object in the scene that satisfies the Hit Query

Public function Virtual Const

bool

 

ExecuteSceneSnapQuery

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

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

Public function Static

USceneSnappi...

 

Find

(
    UInteractiveToolManager* ToolM...
)

Public function Static

USceneSnappi...

 

Find

(
    UInteractiveGizmoManager* Gizm...
)