Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
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.
| Name | USceneSnappingManager |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/SceneQueries/SceneSnappingManager.h |
| Include Path | #include "SceneQueries/SceneSnappingManager.h" |
Syntax
UCLASS (MinimalAPI)
class USceneSnappingManager : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USceneSnappingManager
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ExecuteSceneHitQuery
(
const FSceneHitQueryRequest& Request, |
Try to find a Hit Object in the scene that satisfies the Hit Query | SceneQueries/SceneSnappingManager.h | |
virtual bool ExecuteSceneSnapQuery
(
const FSceneSnapQueryRequest& Request, |
Try to find Snap Targets/Results in the scene that satisfy the Snap Query. | SceneQueries/SceneSnappingManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static USceneSnappingManager * Find
(
UInteractiveToolManager* ToolManager |
SceneQueries/SceneSnappingManager.h | ||
static USceneSnappingManager * Find
(
UInteractiveGizmoManager* GizmoManager |
SceneQueries/SceneSnappingManager.h |