Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
IInteractiveToolCameraFocusAPI provides two functions that can be used to extract "Focus" / "Region of Interest" information about an active Tool:
GetWorldSpaceFocusBox() - provides a bounding box for an "active region" if one is known. An example of using the FocusBox would be to center/zoom the camera in a 3D viewport onto this box when the user hits a hotkey (eg 'f' in the Editor). Should default to the entire active object, if no subregion is available.
GetWorldSpaceFocusPoint() - provides a "Focus Point" at the cursor ray if one is known. This can be used to (eg) center the camera at the focus point.
The above functions should not be called unless the corresponding SupportsX() function returns true.
| Name | IInteractiveToolCameraFocusAPI |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolQueryInterfaces.h |
| Include Path | #include "InteractiveToolQueryInterfaces.h" |
Syntax
class IInteractiveToolCameraFocusAPI
Derived Classes
IInteractiveToolCameraFocusAPI derived class hierarchy
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBox GetWorldSpaceFocusBox() |
InteractiveToolQueryInterfaces.h | ||
virtual bool GetWorldSpaceFocusPoint
(
const FRay& WorldRay, |
InteractiveToolQueryInterfaces.h | ||
virtual bool SupportsWorldSpaceFocusBox() |
InteractiveToolQueryInterfaces.h | ||
virtual bool SupportsWorldSpaceFocusPoint() |
InteractiveToolQueryInterfaces.h |