IInteractiveToolCameraFocusAPI Class Reference

#include <InteractiveToolQueryInterfaces.h>

Inheritance diagram for IInteractiveToolCameraFocusAPI:

Public Member Functions
virtual bool	SupportsWorldSpaceFocusBox ()
virtual FBox	GetWorldSpaceFocusBox ()
virtual bool	SupportsWorldSpaceFocusPoint ()
virtual bool	GetWorldSpaceFocusPoint (const FRay &WorldRay, FVector &PointOut)

Detailed Description

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.

Member Function Documentation

GetWorldSpaceFocusBox()

virtual FBox IInteractiveToolCameraFocusAPI::GetWorldSpaceFocusBox ( )

inlinevirtual

Returns

the current Focus Box

Reimplemented in UMultiSelectionTool, and USingleSelectionTool.

GetWorldSpaceFocusPoint()

virtual bool IInteractiveToolCameraFocusAPI::GetWorldSpaceFocusPoint ( const FRay &  WorldRay, FVector &  PointOut  )

inlinevirtual

Parameters

WorldRay	3D Ray that should be used to find the focus point, generally ray under cursor
PointOut	computed Focus Point

Returns

true if a Focus Point was found, can return false if (eg) the ray missed the target objects

Reimplemented in UMeshSurfacePointTool, UMultiSelectionTool, and USingleSelectionTool.

SupportsWorldSpaceFocusBox()

virtual bool IInteractiveToolCameraFocusAPI::SupportsWorldSpaceFocusBox ( )

inlinevirtual

Returns

true if the implementation can provide a Focus Box

Reimplemented in UMultiSelectionTool, and USingleSelectionTool.

SupportsWorldSpaceFocusPoint()

virtual bool IInteractiveToolCameraFocusAPI::SupportsWorldSpaceFocusPoint ( )

inlinevirtual

Returns

true if the implementation can provide a Focus Point

Reimplemented in UMultiSelectionTool, and USingleSelectionTool.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolQueryInterfaces.h