nc::Camera Class Reference

Basic camera component. More...

#include <Camera.h>

Inheritance diagram for nc::Camera:

Public Member Functions
	Camera (Entity self, const CameraProperties &properties={}) noexcept
	Construct a new Camera object. More...
auto	ViewMatrix () const noexcept -> DirectX::FXMMATRIX
	Get the camera's view matrix. More...
auto	ProjectionMatrix () const noexcept -> DirectX::FXMMATRIX
	Get the camera's projection matrix. More...
auto	InverseProjectionMatrix () const noexcept -> DirectX::FXMMATRIX
	Get the camera's inverse projection matrix. More...
auto	CastToNearAndFarPlanes (const Vector2 &normalizedDeviceCoords) const -> NearFarPoints
	Unproject 2D normalized device coordinates into 3D points on the near and far planes.
auto	GetProperties () const -> const CameraProperties &
	Get the camera properties.
auto	CalculateFrustum () const noexcept -> Frustum
	Calculate the camera's viewport. More...
virtual void	UpdateViewMatrix (DirectX::FXMMATRIX transformationMatrix)
	Construct a new view matrix based on the current transform.
virtual void	UpdateProjectionMatrix (float width, float height)
	Construct a new projection matrix based on input values. More...
virtual void	EnableUpdate () noexcept
	Enable execution of the Run() method in thhe derived class. More...
virtual void	DisableUpdate () noexcept
	Disable execution of the Run() method in the derived class. More...
Public Member Functions inherited from nc::FreeComponent
	FreeComponent (Entity entity) noexcept
Public Member Functions inherited from nc::ComponentBase
	ComponentBase (Entity entity) noexcept
	ComponentBase (const ComponentBase &)=delete
	ComponentBase (ComponentBase &&)=default
ComponentBase &	operator= (const ComponentBase &)=delete
ComponentBase &	operator= (ComponentBase &&)=default
Entity	ParentEntity () const noexcept

Detailed Description

Basic camera component.

Constructor & Destructor Documentation

Camera()

nc::Camera::Camera ( Entity  self, const CameraProperties &  properties = {}  )

noexcept

Construct a new Camera object.

Parameters

self	The parent entity.
properties	Camera properties.

Member Function Documentation

CalculateFrustum()

auto nc::Camera::CalculateFrustum ( ) const -> Frustum

noexcept

Calculate the camera's viewport.

Returns

Frustum

DisableUpdate()

virtual void nc::Camera::DisableUpdate ( )

inlinevirtualnoexcept

Disable execution of the Run() method in the derived class.

Note

It is only necessary to implement this if the derived class has update logic running in a FrameLogic.

Reimplemented in nc::SceneNavigationCamera.

EnableUpdate()

virtual void nc::Camera::EnableUpdate ( )

inlinevirtualnoexcept

Enable execution of the Run() method in thhe derived class.

Note

It is only necessary to implement this if the derived class has update logic running in a FrameLogic.

Reimplemented in nc::SceneNavigationCamera.

InverseProjectionMatrix()

auto nc::Camera::InverseProjectionMatrix ( ) const -> DirectX::FXMMATRIX

inlinenoexcept

Get the camera's inverse projection matrix.

Returns

DirectX::FXMMATRIX

ProjectionMatrix()

auto nc::Camera::ProjectionMatrix ( ) const -> DirectX::FXMMATRIX

inlinenoexcept

Get the camera's projection matrix.

Returns

DirectX::FXMMATRIX

UpdateProjectionMatrix()

virtual void nc::Camera::UpdateProjectionMatrix ( float  width, float  height  )

virtual

Construct a new projection matrix based on input values.

Parameters

width	Screen width
height	Screen height

ViewMatrix()

auto nc::Camera::ViewMatrix ( ) const -> DirectX::FXMMATRIX

inlinenoexcept

Get the camera's view matrix.

Returns

DirectX::FXMMATRIX

---

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

• include/ncengine/graphics/Camera.h