Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AzToolsFramework::EditorComponentSelectionRequests Class Reference

#include <ComponentEntitySelectionBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual AZ::Aabb GetEditorSelectionBoundsViewport (const AzFramework::ViewportInfo &viewportInfo)
 Returns an AABB that encompasses the object.
 
virtual bool EditorSelectionIntersectRayViewport (const AzFramework::ViewportInfo &viewportInfo, const AZ::Vector3 &src, const AZ::Vector3 &dir, float &distance)
 Returns true if editor selection ray intersects with the handler.
 
virtual bool SupportsEditorRayIntersect ()
 Returns if the component overrides EditorSelectionIntersectRay(Viewport) interface, otherwise selection will be based only on an AABB test.
 
virtual bool SupportsEditorRayIntersectViewport (const AzFramework::ViewportInfo &viewportInfo)
 Returns if the component overrides EditorSelectionIntersectRay(Viewport) interface, otherwise selection will be based only on an AABB test.
 

Detailed Description

Bus for customizing Entity selection logic from within the EditorComponents. Used to provide with custom implementation for Ray intersection tests, specifying AABB, etc.

Member Function Documentation

◆ EditorSelectionIntersectRayViewport()

virtual bool AzToolsFramework::EditorComponentSelectionRequests::EditorSelectionIntersectRayViewport ( const AzFramework::ViewportInfo &  viewportInfo,
const AZ::Vector3 &  src,
const AZ::Vector3 &  dir,
float &  distance 
)
inlinevirtual

Returns true if editor selection ray intersects with the handler.

Returns
True if the editor selection ray intersects the handler.
Note
ViewportInfo may be necessary if the all or part of the object stays at a constant size regardless of camera position.

◆ GetEditorSelectionBoundsViewport()

virtual AZ::Aabb AzToolsFramework::EditorComponentSelectionRequests::GetEditorSelectionBoundsViewport ( const AzFramework::ViewportInfo &  viewportInfo)
inlinevirtual

Returns an AABB that encompasses the object.

Returns
AABB that encompasses the object.
Note
ViewportInfo may be necessary if the all or part of the object stays at a constant size regardless of camera position.

◆ SupportsEditorRayIntersectViewport()

virtual bool AzToolsFramework::EditorComponentSelectionRequests::SupportsEditorRayIntersectViewport ( const AzFramework::ViewportInfo &  viewportInfo)
inlinevirtual

Returns if the component overrides EditorSelectionIntersectRay(Viewport) interface, otherwise selection will be based only on an AABB test.

Note
Overload of SupportsEditorRayIntersect which accepts a ViewportInfo containing the ViewportId, this can be used to lookup the intersection setting per viewport.
The documentation for this class was generated from the following file: