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::ViewportInteraction::ViewportDisplayNotifications Class Reference

Interface for viewport selection behaviors. More...

#include <ViewportMessages.h>

Inherited by AzToolsFramework::ViewportInteraction::InternalViewportSelectionRequests, and AzToolsFramework::ViewportInteraction::ViewportSelectionRequests.

Public Member Functions

virtual void DisplayViewportSelection (const AzFramework::ViewportInfo &, AzFramework::DebugDisplayRequests &)
 
virtual void DisplayViewportSelection2d (const AzFramework::ViewportInfo &, AzFramework::DebugDisplayRequests &)
 

Detailed Description

Interface for viewport selection behaviors.

Member Function Documentation

◆ DisplayViewportSelection()

virtual void AzToolsFramework::ViewportInteraction::ViewportDisplayNotifications::DisplayViewportSelection ( const AzFramework::ViewportInfo &  ,
AzFramework::DebugDisplayRequests &   
)
inlinevirtual

Display drawing in world space. DisplayViewportSelection is called from EditorInteractionSystemComponent::DisplayViewport. DisplayViewport exists on the AzFramework::ViewportDebugDisplayEventBus and is called from CRenderViewport. DisplayViewportSelection is called after CalculateVisibleEntityDatas on the EditorVisibleEntityDataCache, this ensures usage of the entity cache will be up to date (do not implement AzFramework::ViewportDebugDisplayEventBus directly if wishing to use the EditorVisibleEntityDataCache).

Reimplemented in AzToolsFramework::EditorPickEntitySelection, and AzToolsFramework::EditorTransformComponentSelection.

◆ DisplayViewportSelection2d()

virtual void AzToolsFramework::ViewportInteraction::ViewportDisplayNotifications::DisplayViewportSelection2d ( const AzFramework::ViewportInfo &  ,
AzFramework::DebugDisplayRequests &   
)
inlinevirtual

Display drawing in screen space. DisplayViewportSelection2d is called after DisplayViewportSelection when the viewport has been configured to be orthographic in CRenderViewport. All screen space drawing can be performed here.

Reimplemented in AzToolsFramework::EditorTransformComponentSelection.

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