AzManipulatorTestFramework::ViewportInteractionInterface Class Reference

This interface is used to simulate the editor environment while the manipulators are under test. More...

#include <AzManipulatorTestFramework.h>

Inherited by AzManipulatorTestFramework::ViewportInteraction.

Public Member Functions
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

This interface is used to simulate the editor environment while the manipulators are under test.

Member Function Documentation

GetCameraState()

virtual AzFramework::CameraState AzManipulatorTestFramework::ViewportInteractionInterface::GetCameraState ( )

pure virtual

Returns the camera state.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

GetDebugDisplay()

virtual AzFramework::DebugDisplayRequests & AzManipulatorTestFramework::ViewportInteractionInterface::GetDebugDisplay ( )

pure virtual

Retrieves the debug display.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

GetViewportId()

virtual AzFramework::ViewportId AzManipulatorTestFramework::ViewportInteractionInterface::GetViewportId ( ) const

pure virtual

Gets the viewport id.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

SetAngularSnapping()

virtual void AzManipulatorTestFramework::ViewportInteractionInterface::SetAngularSnapping ( bool  enabled )

pure virtual

Sets if angular snapping is enabled or not.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

SetAngularStep()

virtual void AzManipulatorTestFramework::ViewportInteractionInterface::SetAngularStep ( float  step )

pure virtual

Sets the angular step.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

SetCameraState()

virtual void AzManipulatorTestFramework::ViewportInteractionInterface::SetCameraState ( const AzFramework::CameraState &  cameraState )

pure virtual

Sets the camera state.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

SetGridSize()

virtual void AzManipulatorTestFramework::ViewportInteractionInterface::SetGridSize ( float  size )

pure virtual

Sets the grid size.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

SetGridSnapping()

virtual void AzManipulatorTestFramework::ViewportInteractionInterface::SetGridSnapping ( bool  enabled )

pure virtual

Sets if grid snapping is enabled or not.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

SetHelpersVisible()

virtual void AzManipulatorTestFramework::ViewportInteractionInterface::SetHelpersVisible ( bool  visible )

pure virtual

Sets if helpers are visible in the viewport.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

SetIconsVisible()

virtual void AzManipulatorTestFramework::ViewportInteractionInterface::SetIconsVisible ( bool  visible )

pure virtual

Sets if icons are visible in the viewport.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

SetStickySelect()

virtual void AzManipulatorTestFramework::ViewportInteractionInterface::SetStickySelect ( bool  enabled )

pure virtual

Sets if sticky select is enabled or not.

Implemented in AzManipulatorTestFramework::ViewportInteraction.

UpdateVisibility()

virtual void AzManipulatorTestFramework::ViewportInteractionInterface::UpdateVisibility ( )

pure virtual

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

Implemented in AzManipulatorTestFramework::ViewportInteraction.

---

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

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