refractoring and better documentation

Author: ElvinC

main.py

@@ -10,5 +10,4 @@ def index():
 
 
 if __name__ == "__main__":
-	app.run(host="0.0.0.0", port=5000, debug=True)
-
+	app.run(host="0.0.0.0", port=5000, debug=True)

static/js/game.js

@@ -1,39 +1,40 @@
 import Scene from './scene/Scene.js'
 import CustomPlane from './plane/Plane.js';
-import { mixColor } from './scene/Color.js';
-
+import {mixColor} from './scene/Color.js';
 
+// global variables
 var scene;
-
 var instruments;
 
-
+// start when loaded
 $(document).ready(() => {
     scene = new Scene();
     setup()
 })
 
-
 let last_time = 0;
 
+/**
+ * Set up game
+ */
 function setup() {
     // Flight instruments setup
     var options = {
         width: "18%",
         height: 200,
-        size : 200,				// Sets the size in pixels of the indicator (square)
-        roll : 0,				// Roll angle in degrees for an attitude indicator
-        pitch : 400,				// Pitch angle in degrees for an attitude indicator
-        heading: 0,				// Heading angle in degrees for an heading indicator
-        vario: 0,				// Variometer in 1000 feets/min for the variometer indicator
-        airspeed: 0,			// Air speed in knots for an air speed indicator
-        altitude: 0,			// Altitude in feets for an altimeter indicator
-        pressure: 1000,			// Pressure in hPa for an altimeter indicator
-        showBox : false,			// Sets if the outer squared box is visible or not (true or false)
-        img_directory : '../static/assets/instruments/'	// The directory where the images are saved to
+        size : 200,
+        roll : 0,
+        pitch : 400,
+        heading: 0,
+        vario: 0,
+        airspeed: 0,
+        altitude: 0,
+        pressure: 1000,
+        showBox : false,
+        img_directory : '../static/assets/instruments/'
     }
 
-    // dict of instruments
+    // "dict" of instruments
     instruments = {
         attitude: $.flightIndicator('#attitude', 'attitude', options),
         heading: $.flightIndicator('#heading', 'heading', options),
@@ -249,10 +250,12 @@ function setup() {
     last_time = performance.now()
     render()
 }
-let counterthing = 1
 
+let counterthing = 1
 
-// render loop
+/**
+ * Render loop
+ */
 function render() {
     // calculate time difference
     let now = performance.now()

static/js/physics/atmosphere.js

@@ -1,8 +1,9 @@
-
+// useful constants
 const STANDARD_GRAVITY = 9.80665
 const RSpecificAir = 287.058;
 const heatCapacityRatio = 1.4;
 
+// Layer data
 // https://en.wikipedia.org/wiki/International_Standard_Atmosphere
 const layers = [
     {
@@ -87,10 +88,19 @@ const layers = [
     },
 ];
 
+/**
+ * Convert Celsius to Kelvin
+ * @param {Number} temperature Temperature in celsius
+ */
 function celsiusToKelvin(temperature) {
     return temperature + 273.15;
 }
 
+/**
+ * Calculate temperature given atmospheric layer and altitude
+ * @param {Object} layer Atmospheric layer data
+ * @param {Number} height Altitude
+ */
 function getTemperature(layer, height) {
     const bT = celsiusToKelvin(layer.baseTemperature);
     const a = layer.lapse / 1000;
@@ -100,6 +110,11 @@ function getTemperature(layer, height) {
     return temperature;
 }
 
+/**
+ * Calculate pressure of layer with no lapse rate
+ * @param {Object} layer Atmospheric layer data
+ * @param {Number} height Altitude
+ */
 function getPressureNoLapse(layer, height) {
     // https://en.wikipedia.org/wiki/Barometric_formula
     const l = layer;
@@ -109,6 +124,11 @@ function getPressureNoLapse(layer, height) {
     return pressure;
 }
 
+/**
+ * Calculate pressure
+ * @param {Object} layer Atmospheric layer data
+ * @param {Number} temperature temperature in celsius
+ */
 function getPressure(layer, temperature) {
     const l = layer;
     const lapse = l.lapse / 1000;
@@ -122,6 +142,10 @@ function getPressure(layer, temperature) {
     return pressure;
 }
 
+/**
+ * Get atmospheric layer data
+ * @param {Number} height Altitude (m)
+ */
 function getLayer(height) {
     // find atmospheric layer
     for (let i = 1; i < layers.length; i++) {
@@ -132,10 +156,18 @@ function getLayer(height) {
     return null;
 }
 
+/**
+ * Calculate speed of sound in air
+ * @param {Number} temperature Temperature in Kelvin
+ */
 function speedOfSound(temperature) {
     return Math.sqrt(heatCapacityRatio * RSpecificAir * temperature);
 }
 
+/**
+ * Get the atmospheric data for a given altitude using ISA
+ * @param {Number} altitude altitude (m)
+ */
 export function ISA(altitude) {
     if (altitude > 86000 || altitude < -611) {
         return {

static/js/plane/Plane.js

@@ -2,8 +2,16 @@ import { Vec2, Vector } from "./Vec2.js";
 import GraphicsVector from "../scene/GraphicsVector.js";
 import { ISA } from "../physics/atmosphere.js";
 
-
+/**
+ * A physical object with position, mass, and rotation.
+ */
 class physicalObject {
+    /**
+     * 
+     * @param {Number} x The x value (m)
+     * @param {Number} y The y value (m)
+     * @param {Number} mass The mass (kg)
+     */
     constructor(x, y, mass) {
         this.pos = new Vec2(x, y);
         this.mass = mass;
@@ -19,20 +27,33 @@ class physicalObject {
         this.momentOfInertia = 100;
     }
 
+    /**
+     * Add a force for next update
+     * @param {Number} force The force to add in Newton
+     */
     addForce(force) {
         this.force.addInPlace(force);
     }
 
+    /**
+     * Add a torque for next update
+     * @param {Number} torque The torque in Nm
+     */
     addTorque(torque) {
         this.torque += torque
     }
 
+    /**
+     * Update next timestep
+     * @param {Number} dt Timestep
+     */
     update(dt) {
         // velocity verlet
         const newAcc = this.force.divide(this.mass);
+        this.pos.addInPlace( Vector.add(this.vel.multiply(dt), this.acc.multiply(0.5 * Math.pow(dt,2))) )
+        this.vel.addInPlace(Vector.add(this.acc, newAcc).multiply(0.5 * dt));
+        
         this.acc = newAcc;
-        this.pos.addInPlace( Vector.add(this.vel.multiply(dt), newAcc.multiply(0.5 * Math.pow(dt,2))) )
-        this.vel.addInPlace(newAcc.multiply(dt));
 
         // reset force
         this.force.x = 0;
@@ -50,7 +71,17 @@ class physicalObject {
 
 }
 
+/**
+ * An interactive plane with custom parameters
+ */
 export default class CustomPlane {
+    /**
+     * 
+     * @param {Number} x The x value (m)
+     * @param {Number} y The y value (m)
+     * @param {Object} keys An updating object with the currently pressed keys keys. (key=keycode, val=bool)
+     * @param {Object} instruments An object containing the flightIndicator instruments.
+     */
     constructor(x, y, keys, instruments) {
         // var texture = PIXI.Texture.fromImage('static/assets/sprites/A220.png');
         var texture = PIXI.Texture.fromImage('../static/assets/sprites/A220.png')
@@ -113,10 +144,18 @@ export default class CustomPlane {
         }
     }
 
+    /**
+     * Get the thrust fraction (thrust/max thrust)
+     * @returns {Number}
+     */
     getThrustFraction() {
         return this.thrust / this.maxThrust
     }
 
+    /**
+     * Update physical parameters after timestep
+     * @param {Number} dt The timestep
+     */
     update(dt) {
         if (this.keys[38]) {
             this.thrust += this.maxThrust / 100;
@@ -271,6 +310,10 @@ export default class CustomPlane {
 
     }
 
+    /**
+     * Show or hide the force/velocity vectors
+     * @param {Boolean} setting Show the vector
+     */
     showVector(setting) {
         for (var i = 0; i < this.vectorList.length; i++) {
             this.vectorList[i].setVisibility(setting)

static/js/scene/Camera.js

@@ -1,3 +1,6 @@
+/**
+ * Class representing a camera with pan and zoom
+ */
 export default class Camera extends PIXI.Container {
     constructor(renderer, x = 0, y = 0, zoom = 1) {
         super();
@@ -8,18 +11,30 @@ export default class Camera extends PIXI.Container {
         this.update();
     }
 
+    /**
+     * Set camera position
+     * @param {Number} x The x position
+     * @param {*} y The y position
+     */
     setPos(x, y) {
         this.posx = x;
         this.posy = y;
         this.update();
     }
 
+    /**
+     * Set camera zoom
+     * @param {Number} zoom Zoom amount
+     */
     setZoom(zoom) {
         this.zoom = zoom;
         cam.scale.x = cam.scale.y = zoom;
         this.update()
     }
 
+    /**
+     * Update camera position
+     */
     update() {
         this.x = this.zoom * this.posx + this.renderer.view.width / 2;
         this.y = this.zoom * this.posy + this.renderer.view.height / 2;

static/js/scene/Color.js

@@ -1,4 +1,10 @@
-
+/**
+ * Blend together two colors
+ * @param {Number[]} A First color represented by an array with three values (0-255)
+ * @param {Number[]} B Second color represented by an array with three values (0-255)
+ * @param {Number} amount Blend ratio 0-1
+ * @returns {Number[]} New blended color represented by array with three values (0-1)
+ */
 export function mixColor(A, B, amount) {
     var newColor = []
     for (var i = 0; i < 3; i++) {

static/js/scene/GraphicsVector.js

@@ -1,3 +1,6 @@
+/**
+ * A class representing a graphical vector arrow
+ */
 export default class GraphicsVector extends PIXI.Graphics {
     constructor(vec, scaling = 1, color=0xff0000) {
         super();
@@ -11,18 +14,32 @@ export default class GraphicsVector extends PIXI.Graphics {
         this.lineTo(vec.x * this.scaling, vec.y * this.scaling)
     }
 
+    /**
+     * Show the vector
+     */
     show() {
         this.show = true;
     }
 
+    /**
+     * Hide the vector
+     */
     hide() {
         this.show = false;
     }
 
+    /**
+     * Show/hide the vector
+     * @param {Boolean} setting Show vector
+     */
     setVisibility(setting) {
         this.show = setting
     }
 
+    /**
+     * Update vector values
+     * @param {Vec2} vec 2d Vector
+     */
     update(vec) {
         this.clear()