AzManipulatorTestFramework::ViewportInteraction Class Reference

Implementation of the viewport interaction model to handle viewport interaction requests. More...

#include <ViewportInteraction.h>

Inherits AzManipulatorTestFramework::ViewportInteractionInterface, AzToolsFramework::ViewportInteraction::ViewportInteractionRequestBus::Handler, UnitTest::ViewportSettingsTestImpl, and AzToolsFramework::ViewportInteraction::EditorEntityViewportInteractionRequestBus::Handler.

Public Member Functions
	ViewportInteraction (AZStd::shared_ptr< AzFramework::DebugDisplayRequests > debugDisplayRequests)
void	SetCameraState (const AzFramework::CameraState &cameraState) override
	Sets the camera state.
AzFramework::DebugDisplayRequests &	GetDebugDisplay () override
	Retrieves the debug display.
void	SetGridSnapping (bool enabled) override
	Sets if grid snapping is enabled or not.
void	SetAngularSnapping (bool enabled) override
	Sets if angular snapping is enabled or not.
void	SetGridSize (float size) override
	Sets the grid size.
void	SetAngularStep (float step) override
	Sets the angular step.
AzFramework::ViewportId	GetViewportId () const override
	Gets the viewport id.
void	UpdateVisibility () override
void	SetStickySelect (bool enabled) override
	Sets if sticky select is enabled or not.
void	SetIconsVisible (bool visible) override
	Sets if icons are visible in the viewport.
void	SetHelpersVisible (bool visible) override
	Sets if helpers are visible in the viewport.
AzFramework::CameraState	GetCameraState () override
	Returns the camera state.
AzFramework::ScreenPoint	ViewportWorldToScreen (const AZ::Vector3 &worldPosition) override
AZ::Vector3	ViewportScreenToWorld (const AzFramework::ScreenPoint &screenPosition) override
AzToolsFramework::ViewportInteraction::ProjectedViewportRay	ViewportScreenToWorldRay (const AzFramework::ScreenPoint &screenPosition) override
float	DeviceScalingFactor () override
void	FindVisibleEntities (AZStd::vector< AZ::EntityId > &visibleEntities) override
virtual AzFramework::CameraState	GetCameraState ()=0
	Returns the camera state.
virtual void	SetCameraState (const AzFramework::CameraState &cameraState)=0
	Sets the camera state.
virtual AzFramework::DebugDisplayRequests &	GetDebugDisplay ()=0
	Retrieves the debug display.
virtual void	SetGridSnapping (bool enabled)=0
	Sets if grid snapping is enabled or not.
virtual void	SetAngularSnapping (bool enabled)=0
	Sets if angular snapping is enabled or not.
virtual void	SetGridSize (float size)=0
	Sets the grid size.
virtual void	SetAngularStep (float step)=0
	Sets the angular step.
virtual AzFramework::ViewportId	GetViewportId () const =0
	Gets the viewport id.
virtual void	UpdateVisibility ()=0
virtual void	SetStickySelect (bool enabled)=0
	Sets if sticky select is enabled or not.
virtual void	SetIconsVisible (bool visible)=0
	Sets if icons are visible in the viewport.
virtual void	SetHelpersVisible (bool visible)=0
	Sets if helpers are visible in the viewport.

Detailed Description

Implementation of the viewport interaction model to handle viewport interaction requests.

Member Function Documentation

GetCameraState()

AzFramework::CameraState AzManipulatorTestFramework::ViewportInteraction::GetCameraState ( )

overridevirtual

Returns the camera state.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

GetDebugDisplay()

AzFramework::DebugDisplayRequests & AzManipulatorTestFramework::ViewportInteraction::GetDebugDisplay ( )

overridevirtual

Retrieves the debug display.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

GetViewportId()

AzFramework::ViewportId AzManipulatorTestFramework::ViewportInteraction::GetViewportId ( ) const

overridevirtual

Gets the viewport id.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

SetAngularSnapping()

void AzManipulatorTestFramework::ViewportInteraction::SetAngularSnapping ( bool  enabled )

overridevirtual

Sets if angular snapping is enabled or not.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

SetAngularStep()

void AzManipulatorTestFramework::ViewportInteraction::SetAngularStep ( float  step )

overridevirtual

Sets the angular step.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

SetCameraState()

void AzManipulatorTestFramework::ViewportInteraction::SetCameraState ( const AzFramework::CameraState &  cameraState )

overridevirtual

Sets the camera state.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

SetGridSize()

void AzManipulatorTestFramework::ViewportInteraction::SetGridSize ( float  size )

overridevirtual

Sets the grid size.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

SetGridSnapping()

void AzManipulatorTestFramework::ViewportInteraction::SetGridSnapping ( bool  enabled )

overridevirtual

Sets if grid snapping is enabled or not.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

SetHelpersVisible()

void AzManipulatorTestFramework::ViewportInteraction::SetHelpersVisible ( bool  visible )

overridevirtual

Sets if helpers are visible in the viewport.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

SetIconsVisible()

void AzManipulatorTestFramework::ViewportInteraction::SetIconsVisible ( bool  visible )

overridevirtual

Sets if icons are visible in the viewport.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

SetStickySelect()

void AzManipulatorTestFramework::ViewportInteraction::SetStickySelect ( bool  enabled )

overridevirtual

Sets if sticky select is enabled or not.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

UpdateVisibility()

void AzManipulatorTestFramework::ViewportInteraction::UpdateVisibility ( )

overridevirtual

Updates the visibility state. Updates which entities are currently visible given the current camera state.

Implements AzManipulatorTestFramework::ViewportInteractionInterface.

---

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

• Code/Framework/AzManipulatorTestFramework/Include/AzManipulatorTestFramework/ViewportInteraction.h