#include <ViewportControllerInterface.h>
Inherited by AzFramework::MultiViewportController< TViewportControllerInstance, Priority >, AzFramework::SingleViewportController, and AzFramework::ViewportControllerList.
Public Member Functions | |
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 |
The interface for a Viewport Controller which handles input events and periodic updates for one or more registered Viewports.
|
inlinevirtual |
Gets the priority at which this controller will receive input events. If set to DispatchToAllPriorities, the controller will receive events multiple times for each available priority level. This typically is only needed in the case of a list of other viewport controllers, each with their own priority (handled by ViewportControllerList for most cases).
Reimplemented in AzFramework::MultiViewportController< TViewportControllerInstance, Priority >, and AzFramework::ViewportControllerList.
|
inlinevirtual |
Handles an input event dispatched to a given viewportContext.
Reimplemented in AzFramework::ViewportControllerList, and AzFramework::MultiViewportController< TViewportControllerInstance, Priority >.
|
pure virtual |
Registers a ViewportContext to be handled by this controller. The controller will receive OnInputChannelEvent and OnUpdateViewport notifications for the viewports.
Implemented in AzFramework::MultiViewportController< TViewportControllerInstance, Priority >, AzFramework::SingleViewportController, and AzFramework::ViewportControllerList.
|
inlinevirtual |
Called to notify this controller that its input state should be reset. This is called when input events, such as key up events, may have been missed and it should be assumed that all input channels are in their default (i.e. no buttons pressed or other input provided) state.
Reimplemented in AzFramework::MultiViewportController< TViewportControllerInstance, Priority >, and AzFramework::ViewportControllerList.
|
pure virtual |
Unregisters a viewport from being handled by this controller. No further events will be received from this viewport after this is called.
Implemented in AzFramework::MultiViewportController< TViewportControllerInstance, Priority >, AzFramework::SingleViewportController, and AzFramework::ViewportControllerList.
|
inlinevirtual |
Updates the current state of the viewport. This should be used to update e.g. the camera transform and will be called every frame for each registered viewport.
Reimplemented in AzFramework::ViewportControllerList, and AzFramework::MultiViewportController< TViewportControllerInstance, Priority >.