diff --git a/ArcballCam.hpp b/ArcballCam.hpp index 1cc915b1..c39d3450 100644 --- a/ArcballCam.hpp +++ b/ArcballCam.hpp @@ -1,5 +1,5 @@ /** - * @file ArcballC.hpp + * @file ArcballCam.hpp * @brief Abstract Camera class * @author Dr. Jeffrey Paone * @@ -14,33 +14,31 @@ #include "Camera.hpp" -/// \namespace CSCI441 -/// \desc CSCI441 Helper Functions for OpenGL namespace CSCI441 { - /// \desc concrete CSCI441::Camera implementation to implement an ArcBall camera model + /// A camera that implements an ArcBall camera model. /// \note camera direction is controlled by setting theta & phi and rotating the camera class ArcballCam : public CSCI441::Camera { public: explicit ArcballCam(GLfloat minRadius = 2.0f, GLfloat maxRadius = 30.0f) : _minRadius(minRadius), _maxRadius(maxRadius) {} - /// \desc converts spherical theta & phi to cartesian x,y,z direction vector + /// converts spherical theta & phi to cartesian x,y,z direction vector /// \note sets the camera's position to be on a sphere centered /// at the camera's look at position. internally sets the /// camera's view matrix void recomputeOrientation() final; - /// \desc updates the camera's position by decreasing the camera's radius + /// updates the camera's position by decreasing the camera's radius /// \param movementFactor distance factor to scale the movement step /// \note internally sets the camera's view matrix void moveForward(GLfloat movementFactor) final; - /// \desc updates the camera's position by increasing the camera's radius + /// updates the camera's position by increasing the camera's radius /// \param movementFactor distance factor to scale the movement step /// \note internally sets the camera's view matrix void moveBackward(GLfloat movementFactor) final; private: - /// \desc updates the camera position and recalculates the view matrix + // updates the camera position and recalculates the view matrix void _updateArcballCameraViewMatrix(); void _clampRadius(); diff --git a/Camera.hpp b/Camera.hpp index d3fea5a6..e3816364 100644 --- a/Camera.hpp +++ b/Camera.hpp @@ -19,39 +19,37 @@ #include #ifndef M_PI -#define M_PI 3.14159265 +#define M_PI 3.14159265f #endif -/// \namespace CSCI441 -/// \desc CSCI441 Helper Functions for OpenGL namespace CSCI441 { - /// \desc Abstract Class to represent a synthetic camera. The following methods + /// Abstract Class to represent a synthetic camera. The following methods /// must be overridden:
/// - recomputeOrientation()
/// - moveForward()
/// - moveBackward()
class Camera { public: - /// \desc properly destroy concrete children + /// properly destroy concrete children virtual ~Camera() = default; - /// \desc Uses theta, phi, & radius to update the + /// 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 recomputeOrientation() = 0; - /// \desc steps forward along the camera's view + /// steps forward along the camera's view /// \param movementFactor scaling factor for distance to move virtual void moveForward(GLfloat movementFactor) = 0; - /// \desc steps backward along the camera's view + /// steps backward along the camera's view /// \param movementFactor scaling factor for distance to move virtual void moveBackward(GLfloat movementFactor) = 0; - /// \desc rotates the camera's POV by adding to theta & phi + /// 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 @@ -62,65 +60,65 @@ namespace CSCI441 { /// and rotation can then be disabled. virtual void rotate(GLfloat dTheta, GLfloat dPhi); - /// \desc creates the View Matrix based on the position, lookAt point, and up vector + /// creates the View Matrix based on the position, lookAt point, and up vector void computeViewMatrix() { _viewMatrix = glm::lookAt( _position, _lookAtPoint, _upVector ); } - /// \desc returns the current view matrix + /// returns the current view matrix [[nodiscard]] glm::mat4 getViewMatrix() { return _viewMatrix; } - /// \desc returns the current camera position in world space + /// returns the current camera position in world space [[nodiscard]] glm::vec3 getPosition() const { return _position; } - /// \desc returns the current lookAt point in world space + /// returns the current lookAt point in world space [[nodiscard]] glm::vec3 getLookAtPoint() const { return _lookAtPoint; } - /// \desc returns the current up vector in world space + /// returns the current up vector in world space [[nodiscard]] glm::vec3 getUpVector() const { return _upVector; } - /// \desc returns the current theta value in radians + /// returns the current theta value in radians [[nodiscard]] GLfloat getTheta() const { return _theta; } - /// \desc returns the current phi value in radians + /// returns the current phi value in radians [[nodiscard]] GLfloat getPhi() const { return _phi; } - /// \desc sets the camera's position in world space + /// sets the camera's position in world space /// \param pos the new camera world space position void setPosition( glm::vec3 pos ) { _position = pos; } - /// \desc sets the camera's lookAt point in world space + /// sets the camera's lookAt point in world space /// \param lookAt the new camera world space lookAt point void setLookAtPoint( glm::vec3 lookAt ) { _lookAtPoint = lookAt; } - /// \desc sets the camera's up vector in world space + /// sets the camera's up vector in world space /// \param up the new camera world space up vector void setUpVector( glm::vec3 up ) { _upVector = up; } - /// \desc sets the camera's theta angle in radians + /// sets the camera's theta angle in radians /// \param t the new camera theta angle in radians void setTheta( GLfloat t ) { _theta = t; } - /// \desc sets the camera's phi angle in radians + /// sets the camera's phi angle in radians /// \param p the new camera phi angle in radians void setPhi( GLfloat p ) { _phi = p; } - /// \desc sets the camera's radius + /// sets the camera's radius /// \param r the new camera radius void setRadius( GLfloat r ) { _radius = r; } protected: Camera(); - /// \desc stores the View Matrix corresponding to the inverse of the Camera's Matrix + /// stores the View Matrix corresponding to the inverse of the Camera's Matrix glm::mat4 _viewMatrix; - /// \desc the cartesian position in world space of the camera + /// the cartesian position in world space of the camera glm::vec3 _position; - /// \desc the cartesian direction the camera is facing in world space + /// the cartesian direction the camera is facing in world space glm::vec3 _direction; - /// \desc the world space point in front of the camera + /// the world space point in front of the camera glm::vec3 _lookAtPoint; - /// \desc the up vector of the camera specified in world space + /// the up vector of the camera specified in world space glm::vec3 _upVector; - /// \desc spherical angle for yaw direction in radians + /// spherical angle for yaw direction in radians GLfloat _theta; - /// \desc spherical angle for pitch direction in radians + /// spherical angle for pitch direction in radians GLfloat _phi; - /// \desc spherical magnitude for direction in world space + /// spherical magnitude for direction in world space GLfloat _radius; private: - /// \desc keeps phi within the range (0, pi) to prevent the camera from flipping over + // keeps phi within the range (0, pi) to prevent the camera from flipping over void _clampPhi(); }; } diff --git a/FixedCam.hpp b/FixedCam.hpp index d42d46ef..0d009def 100644 --- a/FixedCam.hpp +++ b/FixedCam.hpp @@ -15,14 +15,18 @@ #include namespace CSCI441 { - /// \desc A camera that can be positioned and oriented but never moved or - /// rotated. + /// A camera that can be positioned and oriented but never moved or rotated. /// \note Must position via setPosition() /// \note Must orient via setLookAtPoint() class FixedCam : public CSCI441::Camera { public: + /// does nothing void recomputeOrientation() final; + /// does nothing + /// \param unused does nothing void moveForward(GLfloat unused) final; + /// does nothing + /// \param unused does nothing void moveBackward(GLfloat unused) final; }; } diff --git a/FreeCam.hpp b/FreeCam.hpp index bfa40925..bbb8493f 100644 --- a/FreeCam.hpp +++ b/FreeCam.hpp @@ -14,34 +14,32 @@ #include "Camera.hpp" -/// \namespace CSCI441 -/// \desc CSCI441 Helper Functions for OpenGL namespace CSCI441 { - /// \desc concrete CSCI441::Camera implementation to implement a FreeCam camera model + /// A camera that implements a FreeCam camera model. /// \note camera direction is controlled by setting theta & phi and rotating the camera class FreeCam : public CSCI441::Camera { public: - /// \desc converts spherical theta & phi to cartesian x,y,z direction vector + /// 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 void recomputeOrientation() final; - /// \desc updates the camera's position by the adding the camera's direction to the + /// updates the camera's position by the adding the camera's direction to the /// camera's position /// \param movementFactor distance factor to scale the movement step /// \note internally sets the camera's view matrix void moveForward(GLfloat movementFactor) final; - /// \desc updates the camera's position by the adding the camera's negative direction to the + /// updates the camera's position by the adding the camera's negative direction to the /// camera's position /// \param movementFactor distance factor to scale the movement step /// \note internally sets the camera's view matrix void moveBackward(GLfloat movementFactor) final; private: - /// \desc updates the look at point and recalculates the view matrix + // updates the look at point and recalculates the view matrix void _updateFreeCameraViewMatrix(); }; } diff --git a/docs/_arcball_cam_8hpp.html b/docs/_arcball_cam_8hpp.html new file mode 100644 index 00000000..47c8ff90 --- /dev/null +++ b/docs/_arcball_cam_8hpp.html @@ -0,0 +1,108 @@ + + + + + + + +CSCI441 OpenGL Library: ArcballCam.hpp File Reference + + + + + + + + + +
+
+ + + + + + +
+
CSCI441 OpenGL Library 3.12.1 +
+
CS@Mines CSCI441 Computer Graphics Course Library
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+
+Classes | +Namespaces
+
ArcballCam.hpp File Reference
+
+
+ +

Abstract Camera class. +More...

+
#include "Camera.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  CSCI441::ArcballCam
 
+ + + + +

+Namespaces

namespace  CSCI441
 CSCI441 Helper Functions for OpenGL.
 
+

Detailed Description

+

Abstract Camera class.

+
Author
Dr. Jeffrey Paone
+
Copyright
MIT License Copyright (c) 2021 Dr. Jeffrey Paone
+

These functions, classes, and constants help minimize common code that needs to be written.

+
+ +
+Generated by doxygen 1.9.6 +
+ + diff --git a/docs/_arcball_cam_8hpp_source.html b/docs/_arcball_cam_8hpp_source.html index 1176de7b..4124746b 100644 --- a/docs/_arcball_cam_8hpp_source.html +++ b/docs/_arcball_cam_8hpp_source.html @@ -73,75 +73,76 @@
ArcballCam.hpp
-
1
+Go to the documentation of this file.
1
12#ifndef CSCI441_ARCBALL_CAM_HPP
13#define CSCI441_ARCBALL_CAM_HPP
14
15#include "Camera.hpp"
16
-
19namespace CSCI441 {
-
22 class ArcballCam : public CSCI441::Camera {
-
23 public:
-
24 explicit ArcballCam(GLfloat minRadius = 2.0f, GLfloat maxRadius = 30.0f) : _minRadius(minRadius), _maxRadius(maxRadius) {}
-
25
-
30 void recomputeOrientation() final;
-
31
-
35 void moveForward(GLfloat movementFactor) final;
-
36
-
40 void moveBackward(GLfloat movementFactor) final;
-
41
-
42 private:
-
44 void _updateArcballCameraViewMatrix();
+
17namespace CSCI441 {
+
20 class ArcballCam : public CSCI441::Camera {
+
21 public:
+
22 explicit ArcballCam(GLfloat minRadius = 2.0f, GLfloat maxRadius = 30.0f) : _minRadius(minRadius), _maxRadius(maxRadius) {}
+
23
+
28 void recomputeOrientation() final;
+
29
+
33 void moveForward(GLfloat movementFactor) final;
+
34
+
38 void moveBackward(GLfloat movementFactor) final;
+
39
+
40 private:
+
41 // updates the camera position and recalculates the view matrix
+
42 void _updateArcballCameraViewMatrix();
+
43
+
44 void _clampRadius();
45
-
46 void _clampRadius();
-
47
-
48 GLfloat _minRadius;
-
49 GLfloat _maxRadius;
-
50 };
-
51}
-
52
-
53inline void CSCI441::ArcballCam::recomputeOrientation() {
-
54 // compute direction vector based on spherical to cartesian conversion
-
55 _direction.x = glm::sin( _theta )*glm::sin( _phi ) * _radius;
-
56 _direction.y = -glm::cos( _phi ) * _radius;
-
57 _direction.z = -glm::cos( _theta )*glm::sin( _phi ) * _radius;
-
58
-
59 _updateArcballCameraViewMatrix();
-
60}
-
61
-
62inline void CSCI441::ArcballCam::moveForward(GLfloat movementFactor) {
-
63 _radius -= movementFactor;
-
64 _clampRadius();
-
65 recomputeOrientation();
-
66}
-
67
-
68inline void CSCI441::ArcballCam::moveBackward(GLfloat movementFactor) {
-
69 _radius += movementFactor;
-
70 _clampRadius();
-
71 recomputeOrientation();
-
72}
-
73
-
74inline void CSCI441::ArcballCam::_updateArcballCameraViewMatrix() {
-
75 setPosition( _lookAtPoint + _direction );
-
76 computeViewMatrix();
-
77}
-
78
-
79inline void CSCI441::ArcballCam::_clampRadius() {
-
80 _radius = glm::clamp(_radius, _minRadius, _maxRadius);
-
81}
-
82
-
83#endif // CSCI441_ARCBALL_CAM_HPP
+
46 GLfloat _minRadius;
+
47 GLfloat _maxRadius;
+
48 };
+
49}
+
50
+
51inline void CSCI441::ArcballCam::recomputeOrientation() {
+
52 // compute direction vector based on spherical to cartesian conversion
+
53 _direction.x = glm::sin( _theta )*glm::sin( _phi ) * _radius;
+
54 _direction.y = -glm::cos( _phi ) * _radius;
+
55 _direction.z = -glm::cos( _theta )*glm::sin( _phi ) * _radius;
+
56
+
57 _updateArcballCameraViewMatrix();
+
58}
+
59
+
60inline void CSCI441::ArcballCam::moveForward(GLfloat movementFactor) {
+
61 _radius -= movementFactor;
+
62 _clampRadius();
+
63 recomputeOrientation();
+
64}
+
65
+
66inline void CSCI441::ArcballCam::moveBackward(GLfloat movementFactor) {
+
67 _radius += movementFactor;
+
68 _clampRadius();
+
69 recomputeOrientation();
+
70}
+
71
+
72inline void CSCI441::ArcballCam::_updateArcballCameraViewMatrix() {
+
73 setPosition( _lookAtPoint + _direction );
+
74 computeViewMatrix();
+
75}
+
76
+
77inline void CSCI441::ArcballCam::_clampRadius() {
+
78 _radius = glm::clamp(_radius, _minRadius, _maxRadius);
+
79}
+
80
+
81#endif // CSCI441_ARCBALL_CAM_HPP
Camera.hpp
Abstract Camera class.
-
CSCI441::ArcballCam
Definition: ArcballCam.hpp:22
-
CSCI441::ArcballCam::recomputeOrientation
void recomputeOrientation() final
Definition: ArcballCam.hpp:53
-
CSCI441::ArcballCam::moveForward
void moveForward(GLfloat movementFactor) final
Definition: ArcballCam.hpp:62
-
CSCI441::ArcballCam::moveBackward
void moveBackward(GLfloat movementFactor) final
Definition: ArcballCam.hpp:68
-
CSCI441::Camera
Definition: Camera.hpp:34
-
CSCI441::Camera::_phi
GLfloat _phi
\desc spherical angle for pitch direction in radians
Definition: Camera.hpp:118
-
CSCI441::Camera::_direction
glm::vec3 _direction
\desc the cartesian direction the camera is facing in world space
Definition: Camera.hpp:109
-
CSCI441::Camera::_theta
GLfloat _theta
\desc spherical angle for yaw direction in radians
Definition: Camera.hpp:116
-
CSCI441::Camera::_radius
GLfloat _radius
\desc spherical magnitude for direction in world space
Definition: Camera.hpp:120
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441::ArcballCam
Definition: ArcballCam.hpp:20
+
CSCI441::ArcballCam::recomputeOrientation
void recomputeOrientation() final
Definition: ArcballCam.hpp:51
+
CSCI441::ArcballCam::moveForward
void moveForward(GLfloat movementFactor) final
Definition: ArcballCam.hpp:60
+
CSCI441::ArcballCam::moveBackward
void moveBackward(GLfloat movementFactor) final
Definition: ArcballCam.hpp:66
+
CSCI441::Camera
Definition: Camera.hpp:32
+
CSCI441::Camera::_phi
GLfloat _phi
spherical angle for pitch direction in radians
Definition: Camera.hpp:116
+
CSCI441::Camera::_direction
glm::vec3 _direction
the cartesian direction the camera is facing in world space
Definition: Camera.hpp:107
+
CSCI441::Camera::_theta
GLfloat _theta
spherical angle for yaw direction in radians
Definition: Camera.hpp:114
+
CSCI441::Camera::_radius
GLfloat _radius
spherical magnitude for direction in world space
Definition: Camera.hpp:118
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_c_s_c_i441_8hpp.html b/docs/_c_s_c_i441_8hpp.html index ea663b06..0dce4b0f 100644 --- a/docs/_c_s_c_i441_8hpp.html +++ b/docs/_c_s_c_i441_8hpp.html @@ -76,7 +76,7 @@

Includes all CSCI 441 class helper files. More...

-
#include "ArcballCam.hpp"
+
#include "ArcballCam.hpp"
#include "Camera.hpp"
#include "ComputeShaderProgram.hpp"
#include "FixedCam.hpp"
diff --git a/docs/_c_s_c_i441_8hpp_source.html b/docs/_c_s_c_i441_8hpp_source.html index 9ba74970..5436b71a 100644 --- a/docs/_c_s_c_i441_8hpp_source.html +++ b/docs/_c_s_c_i441_8hpp_source.html @@ -77,7 +77,7 @@
28#ifndef CSCI441_CSCI441_HPP
29#define CSCI441_CSCI441_HPP
30
-
31#include "ArcballCam.hpp" // arcball cam implementation
+
31#include "ArcballCam.hpp" // arcball cam implementation
32#include "Camera.hpp" // abstract Camera class
33#include "ComputeShaderProgram.hpp" // helper class to compile and use compute shaders
34#include "FixedCam.hpp" // static camera implementation
@@ -94,6 +94,7 @@
45#include "UniformBufferObject.hpp" // helper class to use UBOs
46
47#endif // CSCI441_CSCI441_HPP
+
ArcballCam.hpp
Abstract Camera class.
Camera.hpp
Abstract Camera class.
ComputeShaderProgram.hpp
Class to work with OpenGL Compute Shaders.
FixedCam.hpp
Includes all CSCI 441 class helper files.
diff --git a/docs/_camera_8hpp.html b/docs/_camera_8hpp.html index a5f0dd0e..37e2228c 100644 --- a/docs/_camera_8hpp.html +++ b/docs/_camera_8hpp.html @@ -101,7 +101,7 @@

Macros

-#define M_PI   3.14159265 +#define M_PI   3.14159265f  

Detailed Description

diff --git a/docs/_camera_8hpp_source.html b/docs/_camera_8hpp_source.html index 6aa044c9..03024eec 100644 --- a/docs/_camera_8hpp_source.html +++ b/docs/_camera_8hpp_source.html @@ -84,110 +84,111 @@
19#include <glm/gtc/matrix_transform.hpp>
20
21#ifndef M_PI
-
22#define M_PI 3.14159265
+
22#define M_PI 3.14159265f
23#endif
24
-
27namespace CSCI441 {
-
28
-
34 class Camera {
-
35 public:
-
37 virtual ~Camera() = default;
-
38
-
44 virtual void recomputeOrientation() = 0;
-
45
-
48 virtual void moveForward(GLfloat movementFactor) = 0;
-
49
-
52 virtual void moveBackward(GLfloat movementFactor) = 0;
-
53
-
63 virtual void rotate(GLfloat dTheta, GLfloat dPhi);
-
64
-
66 void computeViewMatrix() { _viewMatrix = glm::lookAt( _position, _lookAtPoint, _upVector ); }
-
67
-
69 [[nodiscard]] glm::mat4 getViewMatrix() { return _viewMatrix; }
-
71 [[nodiscard]] glm::vec3 getPosition() const { return _position; }
-
73 [[nodiscard]] glm::vec3 getLookAtPoint() const { return _lookAtPoint; }
-
75 [[nodiscard]] glm::vec3 getUpVector() const { return _upVector; }
-
77 [[nodiscard]] GLfloat getTheta() const { return _theta; }
-
79 [[nodiscard]] GLfloat getPhi() const { return _phi; }
-
80
-
83 void setPosition( glm::vec3 pos ) { _position = pos; }
-
86 void setLookAtPoint( glm::vec3 lookAt ) { _lookAtPoint = lookAt; }
-
89 void setUpVector( glm::vec3 up ) { _upVector = up; }
-
92 void setTheta( GLfloat t ) { _theta = t; }
-
95 void setPhi( GLfloat p ) { _phi = p; }
-
98 void setRadius( GLfloat r ) { _radius = r; }
-
99
-
100 protected:
-
101 Camera();
-
102
-
104 glm::mat4 _viewMatrix;
-
105
-
107 glm::vec3 _position;
-
109 glm::vec3 _direction;
-
111 glm::vec3 _lookAtPoint;
-
113 glm::vec3 _upVector;
-
114
-
116 GLfloat _theta;
-
118 GLfloat _phi;
-
120 GLfloat _radius;
-
121
-
122 private:
-
124 void _clampPhi();
-
125 };
-
126}
-
127
-
128inline CSCI441::Camera::Camera() :
-
129 _viewMatrix( glm::mat4(1.0f) ),
-
130 _position( glm::vec3(0.0f, 0.0f, 0.0f ) ),
-
131 _direction( glm::vec3( 0.0f, 0.0f, -1.0f ) ),
-
132 _lookAtPoint( glm::vec3( 0.0f, 0.0f, -1.0f ) ),
-
133 _upVector( glm::vec3( 0.0f, 1.0f, 0.0f ) ),
-
134 _theta( 0.0f ),
-
135 _phi( M_PI / 2.0f ),
-
136 _radius( 1.0f ) {
-
137}
-
138
-
139inline void CSCI441::Camera::rotate(GLfloat dTheta, GLfloat dPhi) {
-
140 _theta += dTheta; // update theta
-
141 _phi += dPhi; // update phi
-
142 _clampPhi(); // bounds check phi
-
143 recomputeOrientation(); // convert to cartesian
-
144}
-
145
-
146inline void CSCI441::Camera::_clampPhi() {
-
147 if(_phi <= 0.0f) _phi = 0.0f+0.001f;
-
148 if(_phi >= M_PI) _phi = M_PI-0.001f;
-
149}
-
150
-
151#endif // CSCI441_CAMERA_HPP
-
CSCI441::Camera
Definition: Camera.hpp:34
-
CSCI441::Camera::_phi
GLfloat _phi
\desc spherical angle for pitch direction in radians
Definition: Camera.hpp:118
-
CSCI441::Camera::_lookAtPoint
glm::vec3 _lookAtPoint
\desc the world space point in front of the camera
Definition: Camera.hpp:111
-
CSCI441::Camera::setTheta
void setTheta(GLfloat t)
Definition: Camera.hpp:92
+
25namespace CSCI441 {
+
26
+
32 class Camera {
+
33 public:
+
35 virtual ~Camera() = default;
+
36
+
42 virtual void recomputeOrientation() = 0;
+
43
+
46 virtual void moveForward(GLfloat movementFactor) = 0;
+
47
+
50 virtual void moveBackward(GLfloat movementFactor) = 0;
+
51
+
61 virtual void rotate(GLfloat dTheta, GLfloat dPhi);
+
62
+
64 void computeViewMatrix() { _viewMatrix = glm::lookAt( _position, _lookAtPoint, _upVector ); }
+
65
+
67 [[nodiscard]] glm::mat4 getViewMatrix() { return _viewMatrix; }
+
69 [[nodiscard]] glm::vec3 getPosition() const { return _position; }
+
71 [[nodiscard]] glm::vec3 getLookAtPoint() const { return _lookAtPoint; }
+
73 [[nodiscard]] glm::vec3 getUpVector() const { return _upVector; }
+
75 [[nodiscard]] GLfloat getTheta() const { return _theta; }
+
77 [[nodiscard]] GLfloat getPhi() const { return _phi; }
+
78
+
81 void setPosition( glm::vec3 pos ) { _position = pos; }
+
84 void setLookAtPoint( glm::vec3 lookAt ) { _lookAtPoint = lookAt; }
+
87 void setUpVector( glm::vec3 up ) { _upVector = up; }
+
90 void setTheta( GLfloat t ) { _theta = t; }
+
93 void setPhi( GLfloat p ) { _phi = p; }
+
96 void setRadius( GLfloat r ) { _radius = r; }
+
97
+
98 protected:
+
99 Camera();
+
100
+
102 glm::mat4 _viewMatrix;
+
103
+
105 glm::vec3 _position;
+
107 glm::vec3 _direction;
+
109 glm::vec3 _lookAtPoint;
+
111 glm::vec3 _upVector;
+
112
+
114 GLfloat _theta;
+
116 GLfloat _phi;
+
118 GLfloat _radius;
+
119
+
120 private:
+
121 // keeps phi within the range (0, pi) to prevent the camera from flipping over
+
122 void _clampPhi();
+
123 };
+
124}
+
125
+
126inline CSCI441::Camera::Camera() :
+
127 _viewMatrix( glm::mat4(1.0f) ),
+
128 _position( glm::vec3(0.0f, 0.0f, 0.0f ) ),
+
129 _direction( glm::vec3( 0.0f, 0.0f, -1.0f ) ),
+
130 _lookAtPoint( glm::vec3( 0.0f, 0.0f, -1.0f ) ),
+
131 _upVector( glm::vec3( 0.0f, 1.0f, 0.0f ) ),
+
132 _theta( 0.0f ),
+
133 _phi( M_PI / 2.0f ),
+
134 _radius( 1.0f ) {
+
135}
+
136
+
137inline void CSCI441::Camera::rotate(GLfloat dTheta, GLfloat dPhi) {
+
138 _theta += dTheta; // update theta
+
139 _phi += dPhi; // update phi
+
140 _clampPhi(); // bounds check phi
+
141 recomputeOrientation(); // convert to cartesian
+
142}
+
143
+
144inline void CSCI441::Camera::_clampPhi() {
+
145 if(_phi <= 0.0f) _phi = 0.0f+0.001f;
+
146 if(_phi >= M_PI) _phi = M_PI-0.001f;
+
147}
+
148
+
149#endif // CSCI441_CAMERA_HPP
+
CSCI441::Camera
Definition: Camera.hpp:32
+
CSCI441::Camera::_phi
GLfloat _phi
spherical angle for pitch direction in radians
Definition: Camera.hpp:116
+
CSCI441::Camera::_lookAtPoint
glm::vec3 _lookAtPoint
the world space point in front of the camera
Definition: Camera.hpp:109
+
CSCI441::Camera::setTheta
void setTheta(GLfloat t)
Definition: Camera.hpp:90
CSCI441::Camera::moveBackward
virtual void moveBackward(GLfloat movementFactor)=0
-
CSCI441::Camera::getPhi
GLfloat getPhi() const
\desc returns the current phi value in radians
Definition: Camera.hpp:79
-
CSCI441::Camera::setPhi
void setPhi(GLfloat p)
Definition: Camera.hpp:95
-
CSCI441::Camera::getViewMatrix
glm::mat4 getViewMatrix()
\desc returns the current view matrix
Definition: Camera.hpp:69
-
CSCI441::Camera::setRadius
void setRadius(GLfloat r)
Definition: Camera.hpp:98
-
CSCI441::Camera::getPosition
glm::vec3 getPosition() const
\desc returns the current camera position in world space
Definition: Camera.hpp:71
-
CSCI441::Camera::setUpVector
void setUpVector(glm::vec3 up)
Definition: Camera.hpp:89
+
CSCI441::Camera::getPhi
GLfloat getPhi() const
returns the current phi value in radians
Definition: Camera.hpp:77
+
CSCI441::Camera::setPhi
void setPhi(GLfloat p)
Definition: Camera.hpp:93
+
CSCI441::Camera::getViewMatrix
glm::mat4 getViewMatrix()
returns the current view matrix
Definition: Camera.hpp:67
+
CSCI441::Camera::setRadius
void setRadius(GLfloat r)
Definition: Camera.hpp:96
+
CSCI441::Camera::getPosition
glm::vec3 getPosition() const
returns the current camera position in world space
Definition: Camera.hpp:69
+
CSCI441::Camera::setUpVector
void setUpVector(glm::vec3 up)
Definition: Camera.hpp:87
CSCI441::Camera::recomputeOrientation
virtual void recomputeOrientation()=0
-
CSCI441::Camera::_direction
glm::vec3 _direction
\desc the cartesian direction the camera is facing in world space
Definition: Camera.hpp:109
-
CSCI441::Camera::_upVector
glm::vec3 _upVector
\desc the up vector of the camera specified in world space
Definition: Camera.hpp:113
-
CSCI441::Camera::getUpVector
glm::vec3 getUpVector() const
\desc returns the current up vector in world space
Definition: Camera.hpp:75
-
CSCI441::Camera::setLookAtPoint
void setLookAtPoint(glm::vec3 lookAt)
Definition: Camera.hpp:86
-
CSCI441::Camera::computeViewMatrix
void computeViewMatrix()
\desc creates the View Matrix based on the position, lookAt point, and up vector
Definition: Camera.hpp:66
-
CSCI441::Camera::~Camera
virtual ~Camera()=default
\desc properly destroy concrete children
-
CSCI441::Camera::setPosition
void setPosition(glm::vec3 pos)
Definition: Camera.hpp:83
-
CSCI441::Camera::_theta
GLfloat _theta
\desc spherical angle for yaw direction in radians
Definition: Camera.hpp:116
+
CSCI441::Camera::_direction
glm::vec3 _direction
the cartesian direction the camera is facing in world space
Definition: Camera.hpp:107
+
CSCI441::Camera::_upVector
glm::vec3 _upVector
the up vector of the camera specified in world space
Definition: Camera.hpp:111
+
CSCI441::Camera::getUpVector
glm::vec3 getUpVector() const
returns the current up vector in world space
Definition: Camera.hpp:73
+
CSCI441::Camera::setLookAtPoint
void setLookAtPoint(glm::vec3 lookAt)
Definition: Camera.hpp:84
+
CSCI441::Camera::computeViewMatrix
void computeViewMatrix()
creates the View Matrix based on the position, lookAt point, and up vector
Definition: Camera.hpp:64
+
CSCI441::Camera::~Camera
virtual ~Camera()=default
properly destroy concrete children
+
CSCI441::Camera::setPosition
void setPosition(glm::vec3 pos)
Definition: Camera.hpp:81
+
CSCI441::Camera::_theta
GLfloat _theta
spherical angle for yaw direction in radians
Definition: Camera.hpp:114
CSCI441::Camera::moveForward
virtual void moveForward(GLfloat movementFactor)=0
-
CSCI441::Camera::getLookAtPoint
glm::vec3 getLookAtPoint() const
\desc returns the current lookAt point in world space
Definition: Camera.hpp:73
-
CSCI441::Camera::_viewMatrix
glm::mat4 _viewMatrix
\desc stores the View Matrix corresponding to the inverse of the Camera's Matrix
Definition: Camera.hpp:104
-
CSCI441::Camera::_radius
GLfloat _radius
\desc spherical magnitude for direction in world space
Definition: Camera.hpp:120
-
CSCI441::Camera::_position
glm::vec3 _position
\desc the cartesian position in world space of the camera
Definition: Camera.hpp:107
-
CSCI441::Camera::getTheta
GLfloat getTheta() const
\desc returns the current theta value in radians
Definition: Camera.hpp:77
-
CSCI441::Camera::rotate
virtual void rotate(GLfloat dTheta, GLfloat dPhi)
Definition: Camera.hpp:139
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441::Camera::getLookAtPoint
glm::vec3 getLookAtPoint() const
returns the current lookAt point in world space
Definition: Camera.hpp:71
+
CSCI441::Camera::_viewMatrix
glm::mat4 _viewMatrix
stores the View Matrix corresponding to the inverse of the Camera's Matrix
Definition: Camera.hpp:102
+
CSCI441::Camera::_radius
GLfloat _radius
spherical magnitude for direction in world space
Definition: Camera.hpp:118
+
CSCI441::Camera::_position
glm::vec3 _position
the cartesian position in world space of the camera
Definition: Camera.hpp:105
+
CSCI441::Camera::getTheta
GLfloat getTheta() const
returns the current theta value in radians
Definition: Camera.hpp:75
+
CSCI441::Camera::rotate
virtual void rotate(GLfloat dTheta, GLfloat dPhi)
Definition: Camera.hpp:137
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_compute_shader_program_8hpp_source.html b/docs/_compute_shader_program_8hpp_source.html index c8a88cac..e4eb441a 100644 --- a/docs/_compute_shader_program_8hpp_source.html +++ b/docs/_compute_shader_program_8hpp_source.html @@ -182,7 +182,7 @@
CSCI441::ComputeShaderProgram::ComputeShaderProgram
ComputeShaderProgram(const char *computeShaderFilename)
Definition: ComputeShaderProgram.hpp:45
CSCI441::ComputeShaderProgram::dispatchWork
void dispatchWork(GLuint numGroupsX, GLuint numGroupsY, GLuint numGroupsZ)
Definition: ComputeShaderProgram.hpp:123
CSCI441::ShaderProgram
Definition: ShaderProgram.hpp:33
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_fixed_cam_8hpp_source.html b/docs/_fixed_cam_8hpp_source.html index 0ce305b7..dcf0a6b7 100644 --- a/docs/_fixed_cam_8hpp_source.html +++ b/docs/_fixed_cam_8hpp_source.html @@ -80,28 +80,28 @@
15#include <CSCI441/Camera.hpp>
16
17namespace CSCI441 {
-
22 class FixedCam : public CSCI441::Camera {
-
23 public:
+
21 class FixedCam : public CSCI441::Camera {
+
22 public:
24 void recomputeOrientation() final;
-
25 void moveForward(GLfloat unused) final;
-
26 void moveBackward(GLfloat unused) final;
-
27 };
-
28}
-
29
-
30inline void CSCI441::FixedCam::recomputeOrientation() {}
-
31
-
32inline void CSCI441::FixedCam::moveForward(GLfloat unused) {}
+
27 void moveForward(GLfloat unused) final;
+
30 void moveBackward(GLfloat unused) final;
+
31 };
+
32}
33
-
34inline void CSCI441::FixedCam::moveBackward(GLfloat unused) {}
+
34inline void CSCI441::FixedCam::recomputeOrientation() {}
35
-
36#endif // CSCI441_FIXED_CAMERA_HPP
+
36inline void CSCI441::FixedCam::moveForward(GLfloat unused) {}
+
37
+
38inline void CSCI441::FixedCam::moveBackward(GLfloat unused) {}
+
39
+
40#endif // CSCI441_FIXED_CAMERA_HPP
Camera.hpp
Abstract Camera class.
-
CSCI441::Camera
Definition: Camera.hpp:34
-
CSCI441::FixedCam
Definition: FixedCam.hpp:22
-
CSCI441::FixedCam::recomputeOrientation
void recomputeOrientation() final
Definition: FixedCam.hpp:30
-
CSCI441::FixedCam::moveBackward
void moveBackward(GLfloat unused) final
Definition: FixedCam.hpp:34
-
CSCI441::FixedCam::moveForward
void moveForward(GLfloat unused) final
Definition: FixedCam.hpp:32
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441::Camera
Definition: Camera.hpp:32
+
CSCI441::FixedCam
Definition: FixedCam.hpp:21
+
CSCI441::FixedCam::recomputeOrientation
void recomputeOrientation() final
does nothing
Definition: FixedCam.hpp:34
+
CSCI441::FixedCam::moveBackward
void moveBackward(GLfloat unused) final
Definition: FixedCam.hpp:38
+
CSCI441::FixedCam::moveForward
void moveForward(GLfloat unused) final
Definition: FixedCam.hpp:36
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_framebuffer_utils_8hpp_source.html b/docs/_framebuffer_utils_8hpp_source.html index bd7d8fa7..e7a6b06e 100644 --- a/docs/_framebuffer_utils_8hpp_source.html +++ b/docs/_framebuffer_utils_8hpp_source.html @@ -187,7 +187,7 @@
134#endif // CSCI441_FRAMEBUFFER_UTILS_HPP
CSCI441::FramebufferUtils::printFramebufferInfo
void printFramebufferInfo(GLenum target, GLuint fbo)
Definition: FramebufferUtils.hpp:49
CSCI441::FramebufferUtils::printFramebufferStatusMessage
void printFramebufferStatusMessage(GLenum target, GLuint fbo)
Definition: FramebufferUtils.hpp:72
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_free_cam_8hpp_source.html b/docs/_free_cam_8hpp_source.html index f66647ff..457d7c9a 100644 --- a/docs/_free_cam_8hpp_source.html +++ b/docs/_free_cam_8hpp_source.html @@ -79,58 +79,59 @@
14
15#include "Camera.hpp"
16
-
19namespace CSCI441 {
-
22 class FreeCam : public CSCI441::Camera {
-
23 public:
-
29 void recomputeOrientation() final;
-
30
-
35 void moveForward(GLfloat movementFactor) final;
-
36
-
41 void moveBackward(GLfloat movementFactor) final;
-
42
-
43 private:
-
45 void _updateFreeCameraViewMatrix();
-
46 };
-
47}
-
48
-
49inline void CSCI441::FreeCam::recomputeOrientation() {
-
50 // compute direction vector based on spherical to cartesian conversion
-
51 _direction.x = glm::sin( _theta )*glm::sin( _phi );
-
52 _direction.y = -glm::cos( _phi );
-
53 _direction.z = -glm::cos( _theta )*glm::sin( _phi );
-
54
-
55 // and normalize this directional vector!
-
56 _direction = glm::normalize( _direction );
-
57
-
58 _updateFreeCameraViewMatrix();
-
59}
-
60
-
61inline void CSCI441::FreeCam::moveForward(GLfloat movementFactor) {
-
62 _position += _direction * movementFactor;
-
63 _updateFreeCameraViewMatrix();
-
64}
-
65
-
66inline void CSCI441::FreeCam::moveBackward(GLfloat movementFactor) {
-
67 _position -= _direction * movementFactor;
-
68 _updateFreeCameraViewMatrix();
-
69}
-
70
-
71inline void CSCI441::FreeCam::_updateFreeCameraViewMatrix() {
-
72 setLookAtPoint( _position + _direction );
-
73 computeViewMatrix();
-
74}
-
75
-
76#endif // CSCI441_FREE_CAM_HPP
+
17namespace CSCI441 {
+
20 class FreeCam : public CSCI441::Camera {
+
21 public:
+
27 void recomputeOrientation() final;
+
28
+
33 void moveForward(GLfloat movementFactor) final;
+
34
+
39 void moveBackward(GLfloat movementFactor) final;
+
40
+
41 private:
+
42 // updates the look at point and recalculates the view matrix
+
43 void _updateFreeCameraViewMatrix();
+
44 };
+
45}
+
46
+
47inline void CSCI441::FreeCam::recomputeOrientation() {
+
48 // compute direction vector based on spherical to cartesian conversion
+
49 _direction.x = glm::sin( _theta )*glm::sin( _phi );
+
50 _direction.y = -glm::cos( _phi );
+
51 _direction.z = -glm::cos( _theta )*glm::sin( _phi );
+
52
+
53 // and normalize this directional vector!
+
54 _direction = glm::normalize( _direction );
+
55
+
56 _updateFreeCameraViewMatrix();
+
57}
+
58
+
59inline void CSCI441::FreeCam::moveForward(GLfloat movementFactor) {
+
60 _position += _direction * movementFactor;
+
61 _updateFreeCameraViewMatrix();
+
62}
+
63
+
64inline void CSCI441::FreeCam::moveBackward(GLfloat movementFactor) {
+
65 _position -= _direction * movementFactor;
+
66 _updateFreeCameraViewMatrix();
+
67}
+
68
+
69inline void CSCI441::FreeCam::_updateFreeCameraViewMatrix() {
+
70 setLookAtPoint( _position + _direction );
+
71 computeViewMatrix();
+
72}
+
73
+
74#endif // CSCI441_FREE_CAM_HPP
Camera.hpp
Abstract Camera class.
-
CSCI441::Camera
Definition: Camera.hpp:34
-
CSCI441::Camera::_phi
GLfloat _phi
\desc spherical angle for pitch direction in radians
Definition: Camera.hpp:118
-
CSCI441::Camera::_direction
glm::vec3 _direction
\desc the cartesian direction the camera is facing in world space
Definition: Camera.hpp:109
-
CSCI441::Camera::_theta
GLfloat _theta
\desc spherical angle for yaw direction in radians
Definition: Camera.hpp:116
-
CSCI441::FreeCam
Definition: FreeCam.hpp:22
-
CSCI441::FreeCam::moveForward
void moveForward(GLfloat movementFactor) final
Definition: FreeCam.hpp:61
-
CSCI441::FreeCam::moveBackward
void moveBackward(GLfloat movementFactor) final
Definition: FreeCam.hpp:66
-
CSCI441::FreeCam::recomputeOrientation
void recomputeOrientation() final
Definition: FreeCam.hpp:49
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441::Camera
Definition: Camera.hpp:32
+
CSCI441::Camera::_phi
GLfloat _phi
spherical angle for pitch direction in radians
Definition: Camera.hpp:116
+
CSCI441::Camera::_direction
glm::vec3 _direction
the cartesian direction the camera is facing in world space
Definition: Camera.hpp:107
+
CSCI441::Camera::_theta
GLfloat _theta
spherical angle for yaw direction in radians
Definition: Camera.hpp:114
+
CSCI441::FreeCam
Definition: FreeCam.hpp:20
+
CSCI441::FreeCam::moveForward
void moveForward(GLfloat movementFactor) final
Definition: FreeCam.hpp:59
+
CSCI441::FreeCam::moveBackward
void moveBackward(GLfloat movementFactor) final
Definition: FreeCam.hpp:64
+
CSCI441::FreeCam::recomputeOrientation
void recomputeOrientation() final
Definition: FreeCam.hpp:47
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_model_loader_8hpp_source.html b/docs/_model_loader_8hpp_source.html index ac97f840..0ea7c786 100644 --- a/docs/_model_loader_8hpp_source.html +++ b/docs/_model_loader_8hpp_source.html @@ -1955,7 +1955,7 @@
CSCI441::ModelLoader::~ModelLoader
~ModelLoader()
Definition: ModelLoader.hpp:198
CSCI441::ModelLoader::ModelLoader
ModelLoader()
Definition: ModelLoader.hpp:189
CSCI441_INTERNAL
Definition: ModelLoader.hpp:182
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
CSCI441_INTERNAL::ModelMaterial
Definition: modelMaterial.hpp:8
diff --git a/docs/_open_g_l3_d_engine_8hpp_source.html b/docs/_open_g_l3_d_engine_8hpp_source.html index 2bfe4c7f..6839f618 100644 --- a/docs/_open_g_l3_d_engine_8hpp_source.html +++ b/docs/_open_g_l3_d_engine_8hpp_source.html @@ -81,7 +81,7 @@
6#define CSCI441_OPENGL3D_ENGINE_HPP
7
8#include "OpenGLEngine.hpp"
-
9#include "ArcballCam.hpp"
+
9#include "ArcballCam.hpp"
10
11#include <glm/glm.hpp>
12
@@ -144,23 +144,24 @@
69}
70
71#endif // CSCI441_OPENGL3D_ENGINE_HPP
+
ArcballCam.hpp
Abstract Camera class.
OpenGLEngine.hpp
Abstract class.
-
CSCI441::ArcballCam
Definition: ArcballCam.hpp:22
-
CSCI441::ArcballCam::recomputeOrientation
void recomputeOrientation() final
Definition: ArcballCam.hpp:53
-
CSCI441::ArcballCam::moveBackward
void moveBackward(GLfloat movementFactor) final
Definition: ArcballCam.hpp:68
-
CSCI441::Camera::setTheta
void setTheta(GLfloat t)
Definition: Camera.hpp:92
-
CSCI441::Camera::getPhi
GLfloat getPhi() const
\desc returns the current phi value in radians
Definition: Camera.hpp:79
-
CSCI441::Camera::setPhi
void setPhi(GLfloat p)
Definition: Camera.hpp:95
-
CSCI441::Camera::setRadius
void setRadius(GLfloat r)
Definition: Camera.hpp:98
-
CSCI441::Camera::getPosition
glm::vec3 getPosition() const
\desc returns the current camera position in world space
Definition: Camera.hpp:71
-
CSCI441::Camera::setUpVector
void setUpVector(glm::vec3 up)
Definition: Camera.hpp:89
-
CSCI441::Camera::getUpVector
glm::vec3 getUpVector() const
\desc returns the current up vector in world space
Definition: Camera.hpp:75
-
CSCI441::Camera::setLookAtPoint
void setLookAtPoint(glm::vec3 lookAt)
Definition: Camera.hpp:86
-
CSCI441::Camera::getLookAtPoint
glm::vec3 getLookAtPoint() const
\desc returns the current lookAt point in world space
Definition: Camera.hpp:73
-
CSCI441::Camera::getTheta
GLfloat getTheta() const
\desc returns the current theta value in radians
Definition: Camera.hpp:77
+
CSCI441::ArcballCam
Definition: ArcballCam.hpp:20
+
CSCI441::ArcballCam::recomputeOrientation
void recomputeOrientation() final
Definition: ArcballCam.hpp:51
+
CSCI441::ArcballCam::moveBackward
void moveBackward(GLfloat movementFactor) final
Definition: ArcballCam.hpp:66
+
CSCI441::Camera::setTheta
void setTheta(GLfloat t)
Definition: Camera.hpp:90
+
CSCI441::Camera::getPhi
GLfloat getPhi() const
returns the current phi value in radians
Definition: Camera.hpp:77
+
CSCI441::Camera::setPhi
void setPhi(GLfloat p)
Definition: Camera.hpp:93
+
CSCI441::Camera::setRadius
void setRadius(GLfloat r)
Definition: Camera.hpp:96
+
CSCI441::Camera::getPosition
glm::vec3 getPosition() const
returns the current camera position in world space
Definition: Camera.hpp:69
+
CSCI441::Camera::setUpVector
void setUpVector(glm::vec3 up)
Definition: Camera.hpp:87
+
CSCI441::Camera::getUpVector
glm::vec3 getUpVector() const
returns the current up vector in world space
Definition: Camera.hpp:73
+
CSCI441::Camera::setLookAtPoint
void setLookAtPoint(glm::vec3 lookAt)
Definition: Camera.hpp:84
+
CSCI441::Camera::getLookAtPoint
glm::vec3 getLookAtPoint() const
returns the current lookAt point in world space
Definition: Camera.hpp:71
+
CSCI441::Camera::getTheta
GLfloat getTheta() const
returns the current theta value in radians
Definition: Camera.hpp:75
CSCI441::OpenGL3DEngine
Definition: OpenGL3DEngine.hpp:19
CSCI441::OpenGLEngine
Definition: OpenGLEngine.hpp:31
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_open_g_l_engine_8hpp_source.html b/docs/_open_g_l_engine_8hpp_source.html index aa6a40ab..d08ce797 100644 --- a/docs/_open_g_l_engine_8hpp_source.html +++ b/docs/_open_g_l_engine_8hpp_source.html @@ -294,7 +294,7 @@
CSCI441::OpenGLEngine::turnDebuggingOn
void turnDebuggingOn() noexcept
\desc Enable logging to command line
Definition: OpenGLEngine.hpp:49
CSCI441::OpenGLEngine::getWindowWidth
int getWindowWidth() const noexcept
\desc Return the width of the window
Definition: OpenGLEngine.hpp:65
CSCI441::OpenGLEngine::isDebuggingEnabled
bool isDebuggingEnabled() noexcept
\desc Returns if logging is enable
Definition: OpenGLEngine.hpp:53
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_open_g_l_utils_8hpp_source.html b/docs/_open_g_l_utils_8hpp_source.html index efbf9c40..c131e3bb 100644 --- a/docs/_open_g_l_utils_8hpp_source.html +++ b/docs/_open_g_l_utils_8hpp_source.html @@ -300,7 +300,7 @@
252#endif // CSCI441_OPENGL_UTILS_H
CSCI441::OpenGLUtils::printOpenGLInfo
void printOpenGLInfo()
\desc Prints information about our OpenGL context
Definition: OpenGLUtils.hpp:73
CSCI441_INTERNAL
Definition: ModelLoader.hpp:182
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_shader_program_8hpp_source.html b/docs/_shader_program_8hpp_source.html index 823e86ca..95629f0f 100644 --- a/docs/_shader_program_8hpp_source.html +++ b/docs/_shader_program_8hpp_source.html @@ -1409,7 +1409,7 @@
CSCI441::ShaderProgram::getNumUniformBlocks
GLuint getNumUniformBlocks() const
Definition: ShaderProgram.hpp:915
CSCI441::ShaderProgram::getAtomicCounterBufferOffset
GLint getAtomicCounterBufferOffset(const char *atomicName) const
Definition: ShaderProgram.hpp:880
CSCI441::ShaderProgram::getUniformLocation
GLint getUniformLocation(const char *uniformName) const
Definition: ShaderProgram.hpp:751
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_shader_program_pipeline_8hpp_source.html b/docs/_shader_program_pipeline_8hpp_source.html index 2507211f..352160b7 100644 --- a/docs/_shader_program_pipeline_8hpp_source.html +++ b/docs/_shader_program_pipeline_8hpp_source.html @@ -166,7 +166,7 @@
CSCI441::ShaderProgramPipeline
Definition: ShaderProgramPipeline.hpp:28
CSCI441::ShaderProgramPipeline::enableDebugMessages
static void enableDebugMessages()
Definition: ShaderProgramPipeline.hpp:61
CSCI441::ShaderProgramPipeline::disableDebugMessages
static void disableDebugMessages()
Definition: ShaderProgramPipeline.hpp:64
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_simple_shader_8hpp_source.html b/docs/_simple_shader_8hpp_source.html index 4c7644bc..bb736158 100644 --- a/docs/_simple_shader_8hpp_source.html +++ b/docs/_simple_shader_8hpp_source.html @@ -740,7 +740,7 @@
CSCI441::SimpleShader2::popTransformation
void popTransformation()
Definition: SimpleShader.hpp:336
CSCI441::SimpleShader2::registerVertexArray
GLuint registerVertexArray(const std::vector< glm::vec2 > &VERTEX_POINTS, const std::vector< glm::vec3 > &VERTEX_COLORS)
Definition: SimpleShader.hpp:312
CSCI441_INTERNAL
Definition: ModelLoader.hpp:182
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
CSCI441::setVertexAttributeLocations
void setVertexAttributeLocations(GLint positionLocation, GLint normalLocation=-1, GLint texCoordLocation=-1)
Sets the attribute locations for vertex positions, normals, and texture coordinates.
Definition: objects.hpp:482
SimpleShader2
CSCI441 Helper Functions for OpenGL Shaders.
objects.hpp
Helper functions to draw 3D OpenGL 3.0+ objects.
diff --git a/docs/_texture_utils_8hpp_source.html b/docs/_texture_utils_8hpp_source.html index e24451ca..607f7b21 100644 --- a/docs/_texture_utils_8hpp_source.html +++ b/docs/_texture_utils_8hpp_source.html @@ -206,7 +206,7 @@
CSCI441::TextureUtils::loadPPM
bool loadPPM(const char *filename, int &imageWidth, int &imageHeight, unsigned char *&imageData)
loads a PPM into memory \desc This function reads an ASCII PPM, returning true if the function succee...
Definition: TextureUtils.hpp:91
CSCI441::TextureUtils::loadCubeMapFaceTexture
void loadCubeMapFaceTexture(const GLint CUBE_MAP_FACE, const char *FILENAME)
Definition: TextureUtils.hpp:167
CSCI441::TextureUtils::loadAndRegister2DTexture
GLuint loadAndRegister2DTexture(const char *filename, GLint minFilter=GL_LINEAR, GLint magFilter=GL_LINEAR, GLint wrapS=GL_REPEAT, GLint wrapT=GL_REPEAT)
loads and registers a texture into memory returning a texture handle \desc This function loads a text...
Definition: TextureUtils.hpp:136
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/_uniform_buffer_object_8hpp_source.html b/docs/_uniform_buffer_object_8hpp_source.html index c78e735b..3326f8b7 100644 --- a/docs/_uniform_buffer_object_8hpp_source.html +++ b/docs/_uniform_buffer_object_8hpp_source.html @@ -185,7 +185,7 @@
CSCI441::UniformBufferObject::copyToOffset
void copyToOffset(unsigned int offset, void *addr, size_t len)
Definition: UniformBufferObject.hpp:94
CSCI441::UniformBufferObject::copyToBuffer
void copyToBuffer(const char *UNIFORM_NAME, void *addr, size_t len)
Definition: UniformBufferObject.hpp:108
CSCI441::UniformBufferObject::setupWithShaderProgram
void setupWithShaderProgram(ShaderProgram *shaderProgram, GLuint bindingPoint)
Definition: UniformBufferObject.hpp:72
-
CSCI441
CSCI441 Helper Functions for OpenGL.
+
CSCI441
CSCI441 Helper Functions for OpenGL.
Definition: ArcballCam.hpp:17
diff --git a/docs/class_c_s_c_i441_1_1_arcball_cam.html b/docs/class_c_s_c_i441_1_1_arcball_cam.html index fa415df7..e48d3f41 100644 --- a/docs/class_c_s_c_i441_1_1_arcball_cam.html +++ b/docs/class_c_s_c_i441_1_1_arcball_cam.html @@ -106,7 +106,7 @@ - Public Member Functions inherited from CSCI441::Camera virtual ~Camera ()=default - \desc properly destroy concrete children
+ properly destroy concrete children
  virtual void recomputeOrientation ()=0   @@ -118,31 +118,31 @@   void computeViewMatrix () - \desc creates the View Matrix based on the position, lookAt point, and up vector
+ creates the View Matrix based on the position, lookAt point, and up vector
  glm::mat4 getViewMatrix () - \desc returns the current view matrix
+ returns the current view matrix
  glm::vec3 getPosition () const - \desc returns the current camera position in world space
+ returns the current camera position in world space
  glm::vec3 getLookAtPoint () const - \desc returns the current lookAt point in world space
+ returns the current lookAt point in world space
  glm::vec3 getUpVector () const - \desc returns the current up vector in world space
+ returns the current up vector in world space
  GLfloat getTheta () const - \desc returns the current theta value in radians
+ returns the current theta value in radians
  GLfloat getPhi () const - \desc returns the current phi value in radians
+ returns the current phi value in radians
  void setPosition (glm::vec3 pos)   @@ -162,39 +162,39 @@ - Protected Attributes inherited from CSCI441::Camera glm::mat4 _viewMatrix - \desc stores the View Matrix corresponding to the inverse of the Camera's Matrix
+ stores the View Matrix corresponding to the inverse of the Camera's Matrix
  glm::vec3 _position - \desc the cartesian position in world space of the camera
+ the cartesian position in world space of the camera
  glm::vec3 _direction - \desc the cartesian direction the camera is facing in world space
+ the cartesian direction the camera is facing in world space
  glm::vec3 _lookAtPoint - \desc the world space point in front of the camera
+ the world space point in front of the camera
  glm::vec3 _upVector - \desc the up vector of the camera specified in world space
+ the up vector of the camera specified in world space
  GLfloat _theta - \desc spherical angle for yaw direction in radians
+ spherical angle for yaw direction in radians
  GLfloat _phi - \desc spherical angle for pitch direction in radians
+ spherical angle for pitch direction in radians
  GLfloat _radius - \desc spherical magnitude for direction in world space
+ spherical magnitude for direction in world space
 

Detailed Description

-

\desc concrete CSCI441::Camera implementation to implement an ArcBall camera model

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

A camera that implements an ArcBall camera model.

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

Member Function Documentation

◆ moveBackward()

@@ -219,7 +219,7 @@

-

\desc updates the camera's position by increasing the camera's radius

Parameters
+

updates the camera's position by increasing the camera's radius

Parameters
movementFactordistance factor to scale the movement step
@@ -254,7 +254,7 @@

-

\desc updates the camera's position by decreasing the camera's radius

Parameters
+

updates the camera's position by decreasing the camera's radius

Parameters
movementFactordistance factor to scale the movement step
@@ -288,7 +288,7 @@

-

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

Note
sets the camera's position to be on a sphere centered at the camera's look at position. internally sets the camera's view matrix
+

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

Note
sets the camera's position to be on a sphere centered at the camera's look at position. internally sets the camera's view matrix

Implements CSCI441::Camera.

diff --git a/docs/class_c_s_c_i441_1_1_camera.html b/docs/class_c_s_c_i441_1_1_camera.html index 908b4237..a946fb8a 100644 --- a/docs/class_c_s_c_i441_1_1_camera.html +++ b/docs/class_c_s_c_i441_1_1_camera.html @@ -99,7 +99,7 @@ Public Member Functions

virtual ~Camera ()=default - \desc properly destroy concrete children
+ properly destroy concrete children
  virtual void recomputeOrientation ()=0   @@ -111,31 +111,31 @@   void computeViewMatrix () - \desc creates the View Matrix based on the position, lookAt point, and up vector
+ creates the View Matrix based on the position, lookAt point, and up vector
  glm::mat4 getViewMatrix () - \desc returns the current view matrix
+ returns the current view matrix
  glm::vec3 getPosition () const - \desc returns the current camera position in world space
+ returns the current camera position in world space
  glm::vec3 getLookAtPoint () const - \desc returns the current lookAt point in world space
+ returns the current lookAt point in world space
  glm::vec3 getUpVector () const - \desc returns the current up vector in world space
+ returns the current up vector in world space
  GLfloat getTheta () const - \desc returns the current theta value in radians
+ returns the current theta value in radians
  GLfloat getPhi () const - \desc returns the current phi value in radians
+ returns the current phi value in radians
  void setPosition (glm::vec3 pos)   @@ -154,39 +154,39 @@ Protected Attributes

glm::mat4 _viewMatrix - \desc stores the View Matrix corresponding to the inverse of the Camera's Matrix
+ stores the View Matrix corresponding to the inverse of the Camera's Matrix
  glm::vec3 _position - \desc the cartesian position in world space of the camera
+ the cartesian position in world space of the camera
  glm::vec3 _direction - \desc the cartesian direction the camera is facing in world space
+ the cartesian direction the camera is facing in world space
  glm::vec3 _lookAtPoint - \desc the world space point in front of the camera
+ the world space point in front of the camera
  glm::vec3 _upVector - \desc the up vector of the camera specified in world space
+ the up vector of the camera specified in world space
  GLfloat _theta - \desc spherical angle for yaw direction in radians
+ spherical angle for yaw direction in radians
  GLfloat _phi - \desc spherical angle for pitch direction in radians
+ spherical angle for pitch direction in radians
  GLfloat _radius - \desc spherical magnitude for direction in world space
+ spherical magnitude for direction in world space
 

Detailed Description

-

\desc Abstract Class to represent a synthetic camera. The following methods must be overridden:
+

Abstract Class to represent a synthetic camera. The following methods must be overridden: