MAGE  v0.171.0
Matthias Advanced Game Engine
mage::rendering::OrthographicCamera Class Reference

#include <orthographic_camera.hpp>

Inheritance diagram for mage::rendering::OrthographicCamera:
mage::rendering::Camera mage::Component

Public Member Functions

 OrthographicCamera (ID3D11Device &device)
 
 OrthographicCamera (const OrthographicCamera &camera)=delete
 
 OrthographicCamera (OrthographicCamera &&camera) noexcept
 
virtual ~OrthographicCamera ()
 
OrthographicCameraoperator= (const OrthographicCamera &camera)=delete
 
OrthographicCameraoperator= (OrthographicCamera &&camera) noexcept
 
const F32x2 GetSize () const noexcept
 
void SetSize (F32x2 size) noexcept
 
virtual const XMMATRIX XM_CALLCONV GetCameraToProjectionMatrix () const noexcept override
 
virtual const XMMATRIX XM_CALLCONV GetProjectionToCameraMatrix () const noexcept override
 
- Public Member Functions inherited from mage::rendering::Camera
virtual ~Camera ()
 
Cameraoperator= (const Camera &camera)=delete
 
Cameraoperator= (Camera &&camera) noexcept
 
const F32x2 GetClippingPlanes () const noexcept
 
void SetClippingPlanes (F32x2 clipping_planes) noexcept
 
CameraLensGetLens () noexcept
 
const CameraLensGetLens () const noexcept
 
ViewportGetViewport () noexcept
 
const ViewportGetViewport () const noexcept
 
CameraSettingsGetSettings () noexcept
 
const CameraSettingsGetSettings () const noexcept
 
void UpdateBuffer (ID3D11DeviceContext &device_context, AntiAliasing aa) const
 
template<typename PipelineStageT >
void BindBuffer (ID3D11DeviceContext &device_context, U32 slot) const noexcept
 
- Public Member Functions inherited from mage::Component
virtual ~Component ()
 
Componentoperator= (const Component &component) noexcept
 
Componentoperator= (Component &&component) noexcept
 
State GetState () const noexcept
 
void SetState (State state) noexcept
 
U64 GetGuid () const noexcept
 
bool HasOwner () const noexcept
 
ProxyPtr< NodeGetOwner () noexcept
 
ProxyPtr< const NodeGetOwner () const noexcept
 

Private Attributes

F32x2 m_size
 

Additional Inherited Members

- Protected Member Functions inherited from mage::rendering::Camera
 Camera (ID3D11Device &device)
 
 Camera (const Camera &camera)=delete
 
 Camera (Camera &&camera) noexcept
 
- Protected Member Functions inherited from mage::Component
 Component () noexcept
 
 Component (const Component &component) noexcept
 
 Component (Component &&component) noexcept
 

Detailed Description

A class of orthographic cameras.

Constructor & Destructor Documentation

◆ OrthographicCamera() [1/3]

mage::rendering::OrthographicCamera::OrthographicCamera ( ID3D11Device &  device)
explicit

Constructs an orthographic camera.

Parameters
[in,out]deviceA reference to the device.

◆ OrthographicCamera() [2/3]

mage::rendering::OrthographicCamera::OrthographicCamera ( const OrthographicCamera camera)
delete

Constructs an orthographic camera from the given orthographic camera.

Parameters
[in]cameraA reference to the orthographic camera to copy.

◆ OrthographicCamera() [3/3]

mage::rendering::OrthographicCamera::OrthographicCamera ( OrthographicCamera &&  camera)
defaultnoexcept

Constructs an orthographic camera by moving the given orthographic camera.

Parameters
[in]cameraA reference to the orthographic camera to move.

◆ ~OrthographicCamera()

mage::rendering::OrthographicCamera::~OrthographicCamera ( )
virtualdefault

Destructs this orthographic camera.

Member Function Documentation

◆ GetCameraToProjectionMatrix()

virtual const XMMATRIX XM_CALLCONV mage::rendering::OrthographicCamera::GetCameraToProjectionMatrix ( ) const
overridevirtualnoexcept

Returns the camera-to-projection matrix of this orthographic camera.

Returns
The camera-to-projection matrix of this orthographic camera.

Implements mage::rendering::Camera.

◆ GetProjectionToCameraMatrix()

virtual const XMMATRIX XM_CALLCONV mage::rendering::OrthographicCamera::GetProjectionToCameraMatrix ( ) const
overridevirtualnoexcept

Returns the projection-to-camera matrix of this orthographic camera.

Returns
The projection-to-camera matrix of this orthographic camera.

Implements mage::rendering::Camera.

◆ GetSize()

const F32x2 mage::rendering::OrthographicCamera::GetSize ( ) const
noexcept

Returns the size of the projection plane of this orthographic camera expressed in camera space.

Returns
The size of the projection plane of this orthographic camera expressed in camera space.

◆ operator=() [1/2]

OrthographicCamera& mage::rendering::OrthographicCamera::operator= ( const OrthographicCamera camera)
delete

Copies the given orthographic camera to this orthographic camera.

Parameters
[in]cameraA reference to the orthographic camera to copy.
Returns
A reference to the copy of the given orthographic camera (i.e. this orthographic camera).

◆ operator=() [2/2]

OrthographicCamera & mage::rendering::OrthographicCamera::operator= ( OrthographicCamera &&  camera)
defaultnoexcept

Moves the given orthographic camera to this orthographic camera.

Parameters
[in]cameraA reference to the orthographic camera to move.
Returns
A reference to the moved orthographic camera (i.e. this orthographic camera).

◆ SetSize()

void mage::rendering::OrthographicCamera::SetSize ( F32x2  size)
noexcept

Sets the size of the projection plane of this orthographic camera expressed in camera space to the given size.

Parameters
[in]sizeThe size.

Member Data Documentation

◆ m_size

F32x2 mage::rendering::OrthographicCamera::m_size
private

The size of the projection plane of this orthographic camera expressed in camera space.