tidied up code and added sample images

Author: rosswarren

Building.cpp

@@ -31,8 +31,8 @@ void Building::Init(void) {
 }
 
 void Building::Display(void) {
-	//glPushMatrix();
+	glPushMatrix();
 	glBindTexture(GL_TEXTURE_2D, texture); // bind the texture
 	glCallList(displayList);
-	//glPopMatrix();
+	glPopMatrix();
 }

Lava.cpp

@@ -10,10 +10,7 @@ Lava::Lava(void) {
 Lava::~Lava(void) {
 }
 
-
-/**
-* Initialise by loading textures etc.
-*/
+// Initialise by loading textures etc.
 void Lava::Init(void) {
 	//load textures
 	RawLoader rawLoader;
@@ -43,11 +40,27 @@ void Lava::Init(void) {
 	glEndList();
 }
 
+// display the lava
 void Lava::Display(void) {
 	glDepthMask(GL_FALSE);
 	glPushMatrix();
 	glTranslatef(512.0f, height, 512.0f);
 	glCallList(displayList);
 	glPopMatrix();
 	glDepthMask(GL_TRUE);
+}
+
+/** return the lava height */
+GLfloat Lava::getHeight(void) {
+	return height;
+}
+
+/** increase the lava height */
+void Lava::increaseHeight(void) {
+	height += 1.0f;
+}
+
+/** decrease the lava height */
+void Lava::decreaseHeight(void) {
+	height -= 1.0f;
 }

Lava.h

@@ -5,13 +5,15 @@ class Lava {
 private:
 	GLuint lavaTexture;
 	GLuint displayList;
+	GLfloat height;
 public:
 	Lava(void);
 	~Lava(void);
 
 	void Init();
 	void Display();
-
-	GLfloat height;
+	GLfloat getHeight(void);
+	void increaseHeight();
+	void decreaseHeight();
 };
 

Main.cpp

@@ -19,14 +19,15 @@
 
 float xpos = 512.0f, ypos = 512.0f, zpos = 512.0f, xrot = 758.0f, yrot = 238.0f, angle = 0.0f;
 float lastx, lasty;
-float bounce;
-float cScale = 1.0;
+
+// for fps
 int time;
 int frame = 0;
 int timebase = 0;
-int fps = 0;
-bool wireframe = false;
-bool refinerydisplay = false;
+int fps = 0; 
+
+bool wireframe = false; // show wireframe?
+bool refinerydisplay = false; // display the refinery?
 
 SkyBox skyBox;
 Lava lava;
@@ -44,7 +45,7 @@ void camera (void) {
 
 	if (xrot < -90) xrot = -90;
 
-	ypos = lava.height + 65.0f; // fix to the height of boating on lava viewpoint
+	ypos = lava.getHeight() + 65.0f; // fix to the height of boating on lava viewpoint
 
 	// rotate to the rotation variables
 	glRotatef(xrot, 1.0f, 0.0f, 0.0f);
@@ -99,7 +100,7 @@ void drawText(void) {
 	strings[0] = "Ross Warren's OpenGL Assignement";
 	strings[1] = "Controls:";
 	strings[2] = "Movement: WASD, Decrease tree complexity: Z, Increase tree complexity: X, Recalculate trees: C, Relocate trees: T, Raise lava: E, Lower lava: F";
-	strings[3] = "Increase terrain complexity: M, Decrease terrain complexity: N, Toggle wireframe: V";
+	strings[3] = "Decrease terrain complexity: N, Increase terrain complexity: M, Toggle wireframe: V";
 
 	float complexity = (float)terrain.GetComplexity();
 	complexity = complexity / 32.0f * 100.0f;
@@ -125,6 +126,7 @@ void drawText(void) {
 	glMatrixMode(GL_MODELVIEW);
 }
 
+/** opengl display method, draws everything */
 void display (void) {
 	glClearColor(0.0, 0.0, 0.0, 1);
     glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
@@ -160,13 +162,15 @@ void display (void) {
 	glutSwapBuffers();
 }
 
+/** Initialise OpenGL extensions for vertex buffer objects */
 void initExtensions(void){
 	glGenBuffersARB = (PFNGLGENBUFFERSARBPROC) wglGetProcAddress("glGenBuffersARB");
 	glBindBufferARB = (PFNGLBINDBUFFERARBPROC) wglGetProcAddress("glBindBufferARB");
 	glBufferDataARB = (PFNGLBUFFERDATAARBPROC) wglGetProcAddress("glBufferDataARB");
 	glDeleteBuffersARB = (PFNGLDELETEBUFFERSARBPROC) wglGetProcAddress("glDeleteBuffersARB");
 }
 
+/** Initialisation method. Sets up OpenGL and calls initialisations of all the components */
 void Init(void) {
 	initExtensions();
 	GLfloat pos[3] = {1024.0f, 800.0f, 0.0f};
@@ -198,11 +202,12 @@ void Init(void) {
 	lava.Init();
 	building.Init();
 	refinery.Init();
-	trees.SetUpHeights(terrain, lava.height);
+	trees.SetUpHeights(terrain, lava.getHeight());
 	trees.Init();
 	printf("Welcome to Ross's OpenGL Assigment \n");
 }
 
+/** mouse movement to look around */
 void mouseMovement(int x, int y) {
 	float diffx = x-lastx; 
 	float diffy = y-lasty; 
@@ -212,77 +217,94 @@ void mouseMovement(int x, int y) {
 	yrot += diffx;
 }
 
+/** toggle wireframe mode */
 void switchWireframe() {
 	glPolygonMode(GL_FRONT_AND_BACK, wireframe ? GL_FILL : GL_LINE);
 	wireframe = !wireframe;
 }
 
+/** keyboard controlled */
 void keyboard(unsigned char key, int x, int y) {
 	float xrotrad, yrotrad;
 
 	switch(key) {
+	// move forwards
 	case 'w':
 		yrotrad = (yrot / 180.0f * M_PI);
 		xrotrad = (xrot / 180.0f * M_PI); 
-		xpos += float(sin(yrotrad)) * cScale;
-		zpos -= float(cos(yrotrad)) * cScale;
-		ypos -= float(sin(xrotrad)) ;
-		bounce += 0.04f;
+		xpos += sin(yrotrad);
+		zpos -= cos(yrotrad);
+		ypos -= sin(xrotrad);
 		break;
+	// strafe left
 	case 'a':
 		yrotrad = (yrot / 180.0f * M_PI);
-		xpos -= float(cos(yrotrad)) * cScale;
-		zpos -= float(sin(yrotrad)) * cScale;
+		xpos -= cos(yrotrad);
+		zpos -= sin(yrotrad);
 		break;
+	// move backwards
 	case 's':
 		yrotrad = (yrot / 180.0f * M_PI);
 		xrotrad = (xrot / 180.0f * M_PI); 
-		xpos -= float(sin(yrotrad)) * cScale;
-		zpos += float(cos(yrotrad)) * cScale;
-		ypos += float(sin(xrotrad));
-		bounce += 0.04f;
+		xpos -= sin(yrotrad);
+		zpos += cos(yrotrad);
+		ypos += sin(xrotrad);
 		break;
+	// move right
 	case 'd':
 		yrotrad = (yrot / 180.0f * M_PI);
-		xpos += float(cos(yrotrad)) * cScale;
-		zpos += float(sin(yrotrad)) * cScale;
+		xpos += cos(yrotrad);
+		zpos += sin(yrotrad);
 		break;
+	// increase lava height
 	case 'e':
-		lava.height += 1.0f;
+		lava.increaseHeight();
 		break;
+	// decrease lava height
 	case 'f':
-		lava.height -= 1.0f;
+		lava.decreaseHeight();
 		break;
+	// decrease tree complexity
 	case 'z':
 		printf("Decreasing tree complexity \n");
 		trees.DecreaseComplexity();
 		break;
+	// increase tree complexity
 	case 'x':
 		printf("Increasing tree complexity \n");
 		trees.IncreaseComplexity();
 		break;
+	// regenerate trees
 	case 'c':
 		printf("Regenerating trees \n");
 		trees.Regen();
 		break;
+	// decrease terrain complexity
 	case 'n':
+		printf("Decreasing terrain complexity \n");
 		terrain.DecreaseComplexity();
 		break;
+	// increase terrain complexity
 	case 'm':
+		printf("Increasing terrain complexity \n");
 		terrain.IncreaseComplexity();
 		break;
+	// toggle wireframe mode
 	case 'v':
 		switchWireframe();
 		break;
+	// toggle displaying of refinery
 	case 'r':
 		refinerydisplay = !refinerydisplay;
 		break;
+	// set up tree heights
 	case 't':
-		trees.SetUpHeights(terrain, lava.height);
+		trees.SetUpHeights(terrain, lava.getHeight());
 		break;
 	}
 }
 
+/** reshape called when the window is resized */
 void reshape(int w, int h) {
 	glViewport(0, 0, (GLsizei)w, (GLsizei)h);
 	glMatrixMode(GL_PROJECTION);
@@ -294,13 +316,13 @@ void reshape(int w, int h) {
 int main (int argc, char **argv) {
     glutInit(&argc, argv);
 	glutInitDisplayMode(GLUT_DOUBLE | GLUT_DEPTH | GLUT_RGBA | GLUT_MULTISAMPLE);
-	glutInitWindowSize(500, 500);
-	glutInitWindowPosition(100, 100);
+	glutInitWindowSize(800, 640);
+	glutInitWindowPosition(400, 100);
 	puts("Show the refinery? This will not run on slower computers. (Y or N).");
 	char answer;
 	std::cin >> answer;
-	refinerydisplay = (answer == 'y') ? true : false; 
-    glutCreateWindow("Ross Warren's OpenGL Assignment");
+	refinerydisplay = (answer == 'y') ? true : false;
+	glutCreateWindow("Ross Warren's OpenGL Assignment");
 	Init();
     glutDisplayFunc(display);
 	glutIdleFunc(display);

RawLoader.cpp

@@ -2,15 +2,14 @@
 #include "RawLoader.h"
 
 
-RawLoader::RawLoader(void)
-{
+RawLoader::RawLoader(void) {
 }
 
 
-RawLoader::~RawLoader(void)
-{
+RawLoader::~RawLoader(void) {
 }
 
+// load a texture and return its OpengGL mapped integer
 GLuint RawLoader::LoadTextureRAW(char * filename, int wrap, int width, int height) {
     GLuint texture;
     GLubyte * data;
@@ -63,11 +62,7 @@ GLuint RawLoader::LoadTextureRAW(char * filename, int wrap, int width, int heigh
     // free buffer
     free(data);
 
-	std::stringstream ss;
-	std::string str;
-	ss << filename << " loaded \n";
-	str = ss.str();
-	std::cout << str;
+	std::cout << filename << " loaded \n";
 
     return texture;
 }

Shapes.cpp

@@ -6,15 +6,14 @@
 #endif
 
 
-Shapes::Shapes(void)
-{
+Shapes::Shapes(void) {
 }
 
 
-Shapes::~Shapes(void)
-{
+Shapes::~Shapes(void) {
 }
 
+// draw a cube with normals and texture coordinates
 void Shapes::cube(void) {
 	glBegin(GL_QUADS);
     // Front Face
@@ -58,14 +57,17 @@ void Shapes::cube(void) {
 	glEnd();
 }
 
+// draws a cuboid, which is just a cube scaled
 void Shapes::cuboid(GLfloat width, GLfloat height, GLfloat depth) {
 	glPushMatrix();
 	glScalef(width / 2 , height / 2, depth / 2);
 	cube();
 	glPopMatrix();
 }
 
-/** draw a gear */
+/** draw a gear 
+* Adapted from here http://www.opengl.org/resources/code/samples/glut_examples/mesademos/mesademos.html
+*/
 void Shapes::gear(GLfloat innerRadius, GLfloat outerRadius, GLfloat width, GLint teeth, GLfloat tooth_depth) {
 	GLint i; //general purpose incrementer for loops
 	GLfloat r0, r1, r2, u, v, len, da;
@@ -212,6 +214,7 @@ void Shapes::cylinder(double height, double radiusBase, double radiusTop, int sl
 	glPopMatrix();
 }
 
+/** draw whisk with spindle, part of the refinery */
 void Shapes::drawWhisk(int direction, double angle, int smallgear, int whisk, GLUquadricObj* quadric) {
 	GLdouble whiskangle = direction == 0 ? angle : -angle; // reverse the angle if direction is 0