CSCI441::PerspectiveCamera Class Reference

Abstract Class to represent a perspective camera. Stores aspect ratio and field of view. More...

#include <PerspectiveCamera.hpp>

Inheritance diagram for CSCI441::PerspectiveCamera:

Public Member Functions
	PerspectiveCamera (GLfloat aspectRatio=1.0f, GLfloat fovy=45.0f, GLfloat nearClipPlane=0.001f, GLfloat farClipPlane=1000.0f)
	initializes the Perspective Camera
	~PerspectiveCamera () override=default
	properly destroy concrete children
virtual void	setAspectRatio (GLfloat aspectRatio) final
	updates the camera's aspect ratio
virtual void	setVerticalFOV (GLfloat fovy) final
	updates the camera's vertical field of view
virtual void	setNearClipPlane (GLfloat near) final
	updates the camera's near clip plane
virtual void	setFarClipPlane (GLfloat far) final
	updates the camera's far clip plane
Public Member Functions inherited from CSCI441::Camera
virtual	~Camera ()=default
	properly destroy concrete children
virtual void	recomputeOrientation ()=0
	Uses theta, phi, & radius to update the camera's view matrix parameters. The camera orientation is controlled via spherical coordinates and this method would orient and/or position the camera in cartesian coordinates.
virtual void	moveForward (GLfloat movementFactor)=0
	steps forward along the camera's view
virtual void	moveBackward (GLfloat movementFactor)=0
	steps backward along the camera's view
virtual void	rotate (GLfloat dTheta, GLfloat dPhi)
	rotates the camera's POV by adding to theta & phi then ensuring phi stays within the (0, pi) range and finally calls through to recomputeOrientation() to update the view parameters after the rotation
virtual void	computeViewMatrix () final
	creates the View Matrix based on the position, lookAt point, and up vector
virtual glm::mat4	getProjectionMatrix () const final
	returns the current projection matrix for the associated camera
virtual glm::mat4	getViewMatrix () const final
	returns the current view matrix for the associated camera
virtual glm::vec3	getPosition () const final
	returns the current camera position in world space
virtual glm::vec3	getLookAtPoint () const final
	returns the current lookAt point in world space
virtual glm::vec3	getUpVector () const final
	returns the current up vector in world space
virtual GLfloat	getTheta () const final
	returns the current theta value in radians
virtual GLfloat	getPhi () const final
	returns the current phi value in radians
virtual GLfloat	getRadius () const final
	returns the current radius in world space
virtual void	setPosition (const glm::vec3 pos) final
	sets the camera's position in world space
virtual void	setLookAtPoint (const glm::vec3 lookAt) final
	sets the camera's lookAt point in world space
virtual void	setUpVector (const glm::vec3 up) final
	sets the camera's up vector in world space
virtual void	setTheta (const GLfloat t) final
	sets the camera's theta angle in radians
virtual void	setPhi (const GLfloat p) final
	sets the camera's phi angle in radians
virtual void	setRadius (const GLfloat r) final
	sets the camera's radius in world space

Protected Member Functions
void	mUpdateProjectionMatrix ()
	computes the perspective projection matrix for the camera
	PerspectiveCamera (const PerspectiveCamera &)=default
	construct a copy an existing camera
PerspectiveCamera &	operator= (const PerspectiveCamera &)=default
	assign a copy of an existing camera
	PerspectiveCamera (PerspectiveCamera &&)=default
	construct a camera by moving ane existing camera object
PerspectiveCamera &	operator= (PerspectiveCamera &&)=default
	reassign an existing camera to ourselves
Protected Member Functions inherited from CSCI441::Camera
	Camera ()
	create a default camera at the origin, looking down the negative Z axis oriented with the world coordinate system
	Camera (const Camera &)=default
	construct a copy an existing camera
Camera &	operator= (const Camera &)=default
	assign a copy of an existing camera
	Camera (Camera &&)=default
	construct a camera by moving ane existing camera object
Camera &	operator= (Camera &&)=default
	reassign an existing camera to ourselves

Additional Inherited Members
Protected Attributes inherited from CSCI441::Camera
glm::mat4	mProjectionMatrix
	stores the Projection Matrix
glm::mat4	mViewMatrix
	stores the View Matrix corresponding to the inverse of the Camera's Matrix
glm::vec3	mCameraPosition
	the cartesian position in world space of the camera
glm::vec3	mCameraDirection
	the cartesian direction the camera is facing in world space
glm::vec3	mCameraLookAtPoint
	the world space point in front of the camera
glm::vec3	mCameraUpVector
	the up vector of the camera specified in world space
GLfloat	mCameraTheta
	spherical angle for yaw direction in radians
GLfloat	mCameraPhi
	spherical angle for pitch direction in radians
GLfloat	mCameraRadius
	spherical magnitude for direction in world space

Detailed Description

Abstract Class to represent a perspective camera. Stores aspect ratio and field of view.

Constructor & Destructor Documentation

PerspectiveCamera()

CSCI441::PerspectiveCamera::PerspectiveCamera ( GLfloat  aspectRatio = 1.0f, GLfloat  fovy = 45.0f, GLfloat  nearClipPlane = 0.001f, GLfloat  farClipPlane = 1000.0f  )

inlineexplicit

initializes the Perspective Camera

Parameters

aspectRatio	aspect ratio of view plane (defaults to 1.0f)
fovy	vertical field of view (defaults to 45.0f)
nearClipPlane	near z clip plane (defaults to 0.001f)
farClipPlane	far z clip plane (defaults to 1000.0f)

Note

field of view specified in degrees

Member Function Documentation

operator=() [1/2]

PerspectiveCamera & CSCI441::PerspectiveCamera::operator= ( const PerspectiveCamera &  )

protecteddefault

assign a copy of an existing camera

Returns

our newly assigned camera

operator=() [2/2]

PerspectiveCamera & CSCI441::PerspectiveCamera::operator= ( PerspectiveCamera &&  )

protecteddefault

reassign an existing camera to ourselves

Returns

our newly assigned camera

setAspectRatio()

void CSCI441::PerspectiveCamera::setAspectRatio ( GLfloat  aspectRatio )

inlinefinalvirtual

updates the camera's aspect ratio

Parameters

aspectRatio

new aspect ratio to apply to camera

Note

internally updates the camera's projection matrix

setFarClipPlane()

void CSCI441::PerspectiveCamera::setFarClipPlane ( GLfloat  far )

inlinefinalvirtual

updates the camera's far clip plane

Parameters

far	new far clip plane to apply to camera

Note

internally updates the camera's projection matrix

setNearClipPlane()

void CSCI441::PerspectiveCamera::setNearClipPlane ( GLfloat  near )

inlinefinalvirtual

updates the camera's near clip plane

Parameters

near	new near clip plane to apply to camera

Note

internally updates the camera's projection matrix

setVerticalFOV()

void CSCI441::PerspectiveCamera::setVerticalFOV ( GLfloat  fovy )

inlinefinalvirtual

updates the camera's vertical field of view

Parameters

fovy	new vertical field of view to apply to camera

Note

internally updates the camera's projection matrix

---

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

• PerspectiveCamera.hpp