Open 3D Engine AzFramework 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.
AzFramework::ViewportRequests Class Referenceabstract

#include <ViewportBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = ViewportId
 

Public Member Functions

virtual const AZ::Matrix4x4 & GetCameraViewMatrix () const =0
 Gets the current camera's world to view matrix.
 
virtual AZ::Matrix3x4 GetCameraViewMatrixAsMatrix3x4 () const =0
 Gets the current camera's world to view matrix as a Matrix3x4.
 
virtual void SetCameraViewMatrix (const AZ::Matrix4x4 &matrix)=0
 Sets the current camera's world to view matrix.
 
virtual const AZ::Matrix4x4 & GetCameraProjectionMatrix () const =0
 Gets the current camera's projection (view to clip) matrix.
 
virtual void SetCameraProjectionMatrix (const AZ::Matrix4x4 &matrix)=0
 Sets the current camera's projection (view to clip) matrix.
 
virtual AZ::Transform GetCameraTransform () const =0
 Convenience method, gets the AZ::Transform corresponding to this camera's world to view matrix.
 
virtual void SetCameraTransform (const AZ::Transform &transform)=0
 Convenience method, sets the camera's world to view matrix from this AZ::Transform.
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

Provides an interface to query and set various view/camera properties. These include a camera's view matrix, projection matrix and transform (inverse of view matrix).

Note
The bus is addressed by ViewportId and should be preferred over existing global camera buses.

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