CSCI441::FreeCam Class Reference

A camera that implements a FreeCam camera model. More...

#include <FreeCam.hpp>

Inheritance diagram for CSCI441::FreeCam:

Public Member Functions
	FreeCam (GLfloat aspectRatio=1.0f, GLfloat fovy=45.0f, GLfloat nearClipPlane=0.001f, GLfloat farClipPlane=1000.0f)
	FreeCam (const FreeCam &)=default
	construct a copy an existing camera
FreeCam &	operator= (const FreeCam &)=default
	assign a copy of an existing camera
	FreeCam (FreeCam &&)=default
	construct a camera by moving ane existing camera object
FreeCam &	operator= (FreeCam &&)=default
	reassign an existing camera to ourselves
	~FreeCam () override=default
	properly destroy concrete children
void	recomputeOrientation () override
	converts spherical theta & phi to cartesian x,y,z direction vector
void	moveForward (GLfloat movementFactor) override
	updates the camera's position by the adding the camera's direction to the camera's position
void	moveBackward (GLfloat movementFactor) override
	updates the camera's position by the adding the camera's negative direction to the camera's position
Public Member Functions inherited from CSCI441::PerspectiveCamera
	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

Additional Inherited Members
Protected Member Functions inherited from CSCI441::PerspectiveCamera
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
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

A camera that implements a FreeCam camera model.

Note

camera direction is controlled by setting theta & phi and rotating the camera

Constructor & Destructor Documentation

FreeCam()

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

inlineexplicit

creates a FreeCam object with the specified perspective projection

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

moveBackward()

void CSCI441::FreeCam::moveBackward ( GLfloat  movementFactor )

inlineoverridevirtual

updates the camera's position by the adding the camera's negative direction to the camera's position

Parameters

movementFactor

distance factor to scale the movement step

Note

internally sets the camera's view matrix

Implements CSCI441::Camera.

moveForward()

void CSCI441::FreeCam::moveForward ( GLfloat  movementFactor )

inlineoverridevirtual

updates the camera's position by the adding the camera's direction to the camera's position

Parameters

movementFactor

distance factor to scale the movement step

Note

internally sets the camera's view matrix

Implements CSCI441::Camera.

operator=() [1/2]

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

default

assign a copy of an existing camera

Returns

our newly assigned camera

operator=() [2/2]

FreeCam & CSCI441::FreeCam::operator= ( FreeCam &&  )

default

reassign an existing camera to ourselves

Returns

our newly assigned camera

recomputeOrientation()

void CSCI441::FreeCam::recomputeOrientation ( )

inlineoverridevirtual

converts spherical theta & phi to cartesian x,y,z direction vector

Note

sets the camera's direction vector to point outward from a sphere centered at the camera's position and updates the camera's look at point to be a point on the sphere offset from the camera's position.

internally sets the camera's view matrix

Implements CSCI441::Camera.

---

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

• FreeCam.hpp