AzFramework::SingleViewportController Class Reference

#include <SingleViewportController.h>

Inherits AzFramework::ViewportControllerInterface.

Public Member Functions
ViewportId	GetViewportId () const
void	RegisterViewportContext (ViewportId viewport) override
void	UnregisterViewportContext (ViewportId viewport) override
Public Member Functions inherited from AzFramework::ViewportControllerInterface
virtual bool	HandleInputChannelEvent (const ViewportControllerInputEvent &event)
virtual void	ResetInputChannels ()
virtual void	UpdateViewport (const ViewportControllerUpdateEvent &event)
virtual void	RegisterViewportContext (ViewportId viewport)=0
virtual void	UnregisterViewportContext (ViewportId viewport)=0
virtual ViewportControllerPriority	GetPriority () const

Detailed Description

SingleViewportController defines a viewport controller interface that supports only registering one viewport at any given time. This can be used for simple cases in which the viewport controller will not be shared in a ViewportControllerList between multiple viewports.

Member Function Documentation

RegisterViewportContext()

void AzFramework::SingleViewportController::RegisterViewportContext ( ViewportId  viewport )

overridevirtual

Registers a ViewportContext to be handled by this controller. The controller will receive OnInputChannelEvent and OnUpdateViewport notifications for the viewports.

Implements AzFramework::ViewportControllerInterface.

UnregisterViewportContext()

void AzFramework::SingleViewportController::UnregisterViewportContext ( ViewportId  viewport )

overridevirtual

Unregisters a viewport from being handled by this controller. No further events will be received from this viewport after this is called.

Implements AzFramework::ViewportControllerInterface.

---

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

• Code/Framework/AzFramework/AzFramework/Viewport/SingleViewportController.h