Muto::SceneCamera Class Reference

#include <SceneCamera.h>

Inheritance diagram for Muto::SceneCamera:

Public Types
enum class	ProjectionType { Perspective = 0 , Orthographic = 1 }

Public Member Functions
float	GetOrthographicFarClip () const
float	GetOrthographicNearClip () const
float	GetOrthographicSize () const
float	GetPerspectiveFarClip () const
float	GetPerspectiveNearClip () const
float	GetPerspectiveVerticalFOV () const
ProjectionType	GetProjectionType () const
	SceneCamera ()
void	SetOrthographic (float size, float nearClip, float farClip)
void	SetOrthographicFarClip (float farClip)
void	SetOrthographicNearClip (float nearClip)
void	SetOrthographicSize (float size)
void	SetPerspective (float verticalFOV, float nearClip, float farClip)
void	SetPerspectiveFarClip (float farClip)
void	SetPerspectiveNearClip (float nearClip)
void	SetPerspectiveVerticalFOV (float verticalFov)
void	SetProjectionType (ProjectionType type)
void	SetViewportSize (uint32_t width, uint32_t height)
virtual	~SceneCamera ()=default
Public Member Functions inherited from Muto::Camera
	Camera ()=default
	Camera (const glm::mat4 &projection)
const glm::mat4 &	GetProjection () const
	~Camera ()=default

Private Member Functions
void	RecalculateProjection ()

Private Attributes
float	m_AspectRatio = 0.0f
float	m_OrthographicFar = 1.0f
float	m_OrthographicNear = -1.0f
float	m_OrthographicSize = 10.0f
float	m_PerspectiveFar = 1000.0f
float	m_PerspectiveFOV = glm::radians(45.0f)
float	m_PerspectiveNear = 0.01f
ProjectionType	m_ProjectionType = ProjectionType::Orthographic

Additional Inherited Members
Protected Attributes inherited from Muto::Camera
glm::mat4	m_Projection = glm::mat4(1.0f)

Member Enumeration Documentation

ProjectionType

enum class Muto::SceneCamera::ProjectionType

strong

Enumerator
Perspective
Orthographic

{ Perspective = 0, Orthographic = 1 };

Constructor & Destructor Documentation

SceneCamera()

Muto::SceneCamera::SceneCamera

(

)

    {
        RecalculateProjection();
    }

References RecalculateProjection().

~SceneCamera()

virtual Muto::SceneCamera::~SceneCamera ( )

virtualdefault

Member Function Documentation

GetOrthographicFarClip()

float Muto::SceneCamera::GetOrthographicFarClip ( ) const

inline

{ return m_OrthographicFar; }

References m_OrthographicFar.

GetOrthographicNearClip()

float Muto::SceneCamera::GetOrthographicNearClip ( ) const

inline

{ return m_OrthographicNear; }

References m_OrthographicNear.

GetOrthographicSize()

float Muto::SceneCamera::GetOrthographicSize ( ) const

inline

{ return m_OrthographicSize; }

References m_OrthographicSize.

GetPerspectiveFarClip()

float Muto::SceneCamera::GetPerspectiveFarClip ( ) const

inline

{ return m_PerspectiveFar; }

References m_PerspectiveFar.

GetPerspectiveNearClip()

float Muto::SceneCamera::GetPerspectiveNearClip ( ) const

inline

{ return m_PerspectiveNear; }

References m_PerspectiveNear.

GetPerspectiveVerticalFOV()

float Muto::SceneCamera::GetPerspectiveVerticalFOV ( ) const

inline

{ return m_PerspectiveFOV; }

GetProjectionType()

ProjectionType Muto::SceneCamera::GetProjectionType ( ) const

inline

{ return m_ProjectionType; }

References m_ProjectionType.

RecalculateProjection()

void Muto::SceneCamera::RecalculateProjection ( )

private

    {
        if (m_ProjectionType == ProjectionType::Perspective)
        {
            m_Projection = glm::perspective(m_PerspectiveFOV, m_AspectRatio, m_PerspectiveNear, m_PerspectiveFar);
        }
        else
        {
            float orthoLeft = -m_OrthographicSize * m_AspectRatio * 0.5f;
            float orthoRight = m_OrthographicSize * m_AspectRatio * 0.5f;
            float orthoBottom = -m_OrthographicSize * 0.5f;
            float orthoTop = m_OrthographicSize * 0.5f;
 
            m_Projection = glm::ortho(orthoLeft, orthoRight,
                orthoBottom, orthoTop, m_OrthographicNear, m_OrthographicFar);
        }
 
    }

References m_AspectRatio, m_OrthographicSize, m_ProjectionType, and Perspective.

Referenced by SceneCamera(), SetOrthographic(), SetOrthographicFarClip(), SetOrthographicNearClip(), SetOrthographicSize(), SetPerspective(), SetPerspectiveFarClip(), SetPerspectiveNearClip(), SetPerspectiveVerticalFOV(), SetProjectionType(), and SetViewportSize().

SetOrthographic()

void Muto::SceneCamera::SetOrthographic	(	float	size,
		float	nearClip,
		float	farClip
	)

    {
        m_OrthographicSize = size;
        m_OrthographicNear = nearClip;
        m_OrthographicFar = farClip;
        RecalculateProjection();
    }

References m_OrthographicFar, m_OrthographicNear, m_OrthographicSize, and RecalculateProjection().

SetOrthographicFarClip()

void Muto::SceneCamera::SetOrthographicFarClip ( float  farClip )

inline

{ m_OrthographicFar = farClip; RecalculateProjection(); }

References m_OrthographicFar, and RecalculateProjection().

SetOrthographicNearClip()

void Muto::SceneCamera::SetOrthographicNearClip ( float  nearClip )

inline

{ m_OrthographicNear = nearClip; RecalculateProjection(); }

References m_OrthographicNear, and RecalculateProjection().

SetOrthographicSize()

void Muto::SceneCamera::SetOrthographicSize ( float  size )

inline

{ m_OrthographicSize = size; RecalculateProjection(); }

References m_OrthographicSize, and RecalculateProjection().

SetPerspective()

void Muto::SceneCamera::SetPerspective	(	float	verticalFOV,
		float	nearClip,
		float	farClip
	)

    {
        m_ProjectionType = ProjectionType::Perspective;
        m_PerspectiveFOV = verticalFOV;
        m_PerspectiveNear = nearClip;
        m_PerspectiveFar = farClip;
        RecalculateProjection();
    }

References m_PerspectiveFar, m_PerspectiveNear, m_ProjectionType, Perspective, and RecalculateProjection().

SetPerspectiveFarClip()

void Muto::SceneCamera::SetPerspectiveFarClip ( float  farClip )

inline

{ m_PerspectiveFar = farClip; RecalculateProjection(); }

References m_PerspectiveFar, and RecalculateProjection().

SetPerspectiveNearClip()

void Muto::SceneCamera::SetPerspectiveNearClip ( float  nearClip )

inline

{ m_PerspectiveNear = nearClip; RecalculateProjection(); }

References m_PerspectiveNear, and RecalculateProjection().

SetPerspectiveVerticalFOV()

void Muto::SceneCamera::SetPerspectiveVerticalFOV ( float  verticalFov )

inline

{ m_PerspectiveFOV = verticalFov; RecalculateProjection(); }

References RecalculateProjection().

SetProjectionType()

void Muto::SceneCamera::SetProjectionType ( ProjectionType  type )

inline

{ m_ProjectionType = type; RecalculateProjection(); }

References m_ProjectionType, and RecalculateProjection().

SetViewportSize()

void Muto::SceneCamera::SetViewportSize	(	uint32_t	width,
		uint32_t	height
	)

    {
        m_AspectRatio = (float)width / (float)height;
        RecalculateProjection();
    }

References m_AspectRatio, and RecalculateProjection().

Member Data Documentation

m_AspectRatio

float Muto::SceneCamera::m_AspectRatio = 0.0f

private

Referenced by RecalculateProjection(), and SetViewportSize().

m_OrthographicFar

float Muto::SceneCamera::m_OrthographicFar = 1.0f

private

Referenced by GetOrthographicFarClip(), SetOrthographic(), and SetOrthographicFarClip().

m_OrthographicNear

float Muto::SceneCamera::m_OrthographicNear = -1.0f

private

Referenced by GetOrthographicNearClip(), SetOrthographic(), and SetOrthographicNearClip().

m_OrthographicSize

float Muto::SceneCamera::m_OrthographicSize = 10.0f

private

Referenced by GetOrthographicSize(), RecalculateProjection(), SetOrthographic(), and SetOrthographicSize().

m_PerspectiveFar

float Muto::SceneCamera::m_PerspectiveFar = 1000.0f

private

Referenced by GetPerspectiveFarClip(), SetPerspective(), and SetPerspectiveFarClip().

m_PerspectiveFOV

float Muto::SceneCamera::m_PerspectiveFOV = glm::radians(45.0f)

private

m_PerspectiveNear

float Muto::SceneCamera::m_PerspectiveNear = 0.01f

private

Referenced by GetPerspectiveNearClip(), SetPerspective(), and SetPerspectiveNearClip().

m_ProjectionType

ProjectionType Muto::SceneCamera::m_ProjectionType = ProjectionType::Orthographic

private

Referenced by GetProjectionType(), RecalculateProjection(), SetPerspective(), and SetProjectionType().

---

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

• Muto/src/Scene/SceneCamera.h
• Muto/src/Scene/SceneCamera.cpp