Camera for the editor's scene view. More...

#include <SceneNavigationCamera.h>

Inheritance diagram for nc::SceneNavigationCamera:

Public Member Functions
	SceneNavigationCamera (Entity self, const CameraProperties &cameraProperties={}, const SceneCameraConfig &config={})
	Construct a new Scene Navigation Camera object. More...

void	Run (Entity self, ecs::Ecs world, float dt)
	Handle input and update transform. (for use with FrameLogic/InvokeFreeComponent) More...

void	EnableUpdate () noexcept override
	Enable execution of the Run() method in thhe derived class. More...

void	DisableUpdate () noexcept override
	Disable execution of the Run() method in the derived class. More...

Public Member Functions inherited from nc::Camera
	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

Camera for the editor's scene view.

Pan: Hold middle mouse button Look: Hold right mouse button Zoom: Mouse wheel

Constructor & Destructor Documentation

◆ SceneNavigationCamera()

nc::SceneNavigationCamera::SceneNavigationCamera	(	Entity	self,
		const CameraProperties &	cameraProperties = `{}`,
		const SceneCameraConfig &	config = `{}`
	)

Construct a new Scene Navigation Camera object.

Parameters

self	The owning entity
config	Camera movement settings

Member Function Documentation

◆ DisableUpdate()

void nc::SceneNavigationCamera::DisableUpdate ( )

inlineoverridevirtualnoexcept

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 from nc::Camera.

◆ EnableUpdate()

void nc::SceneNavigationCamera::EnableUpdate ( )

inlineoverridevirtualnoexcept

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 from nc::Camera.

◆ Run()

void nc::SceneNavigationCamera::Run	(	Entity	self,
		ecs::Ecs	world,
		float	dt
	)

Handle input and update transform. (for use with FrameLogic/InvokeFreeComponent)