Update to v1.4.0-beta.4

### Added
* Info tool
* Ability to pause simulation.

### Fixed
* Bug with selecting balls
* Doxygen todo list not generating

Author: GamerMan7799

README.md

@@ -108,13 +108,15 @@ R = All motion will be stopped.
 Q / ESC = Program will exit.
 F = Every so often a randomly generated cannonball will be created
 T = Toggle toolbox on/off
+P = Toggle pause for the simulation
 Right Arrow = Select next tool
 Left Arrow = Select previous tool
 1 = Select Fire tool
 2 = Select Drop tool
 3 = Select Rope tool
 4 = Select Delete tool
 5 = Select Drag tool
+6 = Select Info tool
 ```
 
 ## Tools
@@ -140,3 +142,7 @@ Clicking on a ball will delete it.
 ### Drag tool - WIP
 
 Clicking and dragging on a ball will allow you to move a ball where the mouse is. When released the ball will still have its inital velocity.
+
+### Info Tool - WIP
+
+Clicking on a ball will write infomation about it to the console

docs/ChangesLog.md

@@ -3,14 +3,15 @@
 All notable changes to this project will be documented here.
 This project adheres to [Semantic Versioning](http://semver.org/)
 
-## [1.4.0-beta.3] - WIP
+## [1.4.0-beta.4] - WIP
 ### Added
-* Toolbar with different tools including: drag, fire, drop, rope, and delete. Not all are fully working at the moment. 
-* Currently finished tools: fire, drop, delete
+* Toolbar with different tools including: drag, fire, drop, rope, delete, and info. Not all are fully working at the moment. 
+* Currently finished tools: fire, drop, delete, info
 * SDL Licenses.
 * Credits to Docs.
 * More Doxygen stuff.
 * Debug message that prints ball mass. 
+* Ability to pause the simulation.
 
 ### Changed
 * Moved Docs to Doc folder.

src/cannonball.cpp

@@ -151,78 +151,77 @@ void clsCannonball::update(double newdeltat) {
   ///
   /////////////////////////////////////////////////
 
-  blncheckphysics_ = true; // enable on update
-  deltat_ = newdeltat;
-
-  // reset the forces so strange things don't happen
-  forces_ = {0.0, props_.mass * global::physics::kGravity};
-
-  if (blndragenabled_) {
-    doMagnusEffect();
-    dragUpdateAcc();
-  }
-  doFriction();
-
-  acc_.x = forces_.x / props_.mass;
-  acc_.y = forces_.y / props_.mass;
-
-	vel_.x = (vel_.x + acc_.x * deltat_);
-	vel_.y = (vel_.y + acc_.y * deltat_);
-
-	// get new velocities if collision with edges
-
-	double coefres = (global::config.values.uchrCollisionMethod == CollideInelastic) ?
-                   global::physics::kCoefficientRestitution : 1.0;
-
-
-	/* TODO (GamerMan7799#2#): Make this stuff simpler */
-  if (collisionbox_.left < screen_place_.w / 2) {
-    vel_.x *= -1 * coefres;
-    vel_.y *= coefres;
-    dblLOC_.x = screen_place_.w;
-  }
-
-  if (collisionbox_.right > (screen::screenatt.width)) {
-    vel_.x *= -1 * coefres;
-    vel_.y *= coefres;
-    dblLOC_.x = screen::screenatt.width - screen_place_.w / 2;
-  }
-
-  if (collisionbox_.bottom > (screen::screenatt.height)) {
-    vel_.x *= coefres;
-    vel_.y *= -1 * coefres;
-    dblLOC_.y = screen_place_.h / 2;
-  }
-
-  if (collisionbox_.top < 0 ) {
-    vel_.x *= coefres;
-    vel_.y *= -1 * coefres;
-    dblLOC_.y = (screen::screenatt.height) - screen_place_.h / 2;
-  }
-
-  dblLOC_.x = dblLOC_.x + vel_.x * deltat_ /*+ 0.5 * acc_.x * pow(deltat_,2)*/;
-  dblLOC_.y = dblLOC_.y + vel_.y * deltat_ /*+ 0.5 * acc_.y * pow(deltat_,2)*/;
-
-  // update place and collision box again in case something changed
-  place_.x = round(dblLOC_.x);
-  place_.y = round(dblLOC_.y);
-  updateCollisionBox();
-
-	if (global::config.values.blnLogging) {
-    FILE* logfile = fopen("logfile.log","a");
-    fprintf(logfile,"Ball %3u \t (%.3f, %.3f)\n",ballID_, dblLOC_.x,dblLOC_.y);
-    fclose(logfile);
-	}
-
-  double total_v;
-  total_v = sqrt( pow(vel_.x,2) + pow(vel_.y,2) );
-  if (total_v < global::physics::kMinVelocity || isnan(total_v) ) {
-    blnstarted_ = false;
-    if (global::blnDebugMode) {
-      if ( isnan(total_v) ) { printf("Ball velocity is NaN; killing it.\n"); }
-      else { printf("Ball moving too slow; killing it.\n"); }
-    } //end if debug mode
-  } //end if should kill
+  if (!paused_) {
+    blncheckphysics_ = true; // enable on update
+    deltat_ = newdeltat;
+
+    // reset the forces so strange things don't happen
+    forces_ = {0.0, props_.mass * global::physics::kGravity};
+
+    if (blndragenabled_) {
+      doMagnusEffect();
+      dragUpdateAcc();
+    }
+    doFriction();
+
+    acc_.x = forces_.x / props_.mass;
+    acc_.y = forces_.y / props_.mass;
+
+    vel_.x = (vel_.x + acc_.x * deltat_);
+    vel_.y = (vel_.y + acc_.y * deltat_);
+
+    // get new velocities if collision with edges
+    double coefres = (global::config.values.uchrCollisionMethod == CollideInelastic) ?
+                     global::physics::kCoefficientRestitution : 1.0;
+
+    if (collisionbox_.left < screen_place_.w / 2) {
+      vel_.x *= -1 * coefres;
+      vel_.y *= coefres;
+      dblLOC_.x = screen_place_.w;
+    }
+
+    if (collisionbox_.right > (screen::screenatt.width)) {
+      vel_.x *= -1 * coefres;
+      vel_.y *= coefres;
+      dblLOC_.x = screen::screenatt.width - screen_place_.w / 2;
+    }
+
+    if (collisionbox_.bottom > (screen::screenatt.height)) {
+      vel_.x *= coefres;
+      vel_.y *= -1 * coefres;
+      dblLOC_.y = screen_place_.h / 2;
+    }
+
+    if (collisionbox_.top < 0 ) {
+      vel_.x *= coefres;
+      vel_.y *= -1 * coefres;
+      dblLOC_.y = (screen::screenatt.height) - screen_place_.h / 2;
+    }
+
+    dblLOC_.x = dblLOC_.x + vel_.x * deltat_ /*+ 0.5 * acc_.x * pow(deltat_,2)*/;
+    dblLOC_.y = dblLOC_.y + vel_.y * deltat_ /*+ 0.5 * acc_.y * pow(deltat_,2)*/;
+
+    // update place and collision box again in case something changed
+    place_.x = round(dblLOC_.x);
+    place_.y = round(dblLOC_.y);
+    updateCollisionBox();
+
+    if (global::config.values.blnLogging) {
+      FILE* logfile = fopen("logfile.log","a");
+      fprintf(logfile,"Ball %3u \t (%.3f, %.3f)\n",ballID_, dblLOC_.x,dblLOC_.y);
+      fclose(logfile);
+    }
+
+    double total_v;
+    total_v = sqrt( pow(vel_.x,2) + pow(vel_.y,2) );
+    if (total_v < global::physics::kMinVelocity || isnan(total_v) ) {
+      blnstarted_ = false;
+      if (global::blnDebugMode) {
+        if ( isnan(total_v) ) { printf("Ball velocity is NaN; killing it.\n"); }
+        else { printf("Ball moving too slow; killing it.\n"); }
+      } //end if debug mode
+    } //end if should kill
+  } // end if not paused
 	show(); //show the ball on the screen
 }
 /*****************************************************************************/
@@ -278,6 +277,7 @@ void clsCannonball::setValues(double r, LOC init_place,
   /////////////////////////////////////////////////
 
   ballID_ = newID;
+  paused_ = false;
 
   props_.radius = r; //in meters
 
@@ -417,8 +417,8 @@ void clsCannonball::doFriction() {
                     normal_force;
   updateCollisionBox();
   //Update acc for Friction values
-  if ( collisionbox_.bottom < screen_place_.h ||
-       collisionbox_.top > screen::screenatt.height ) {
+  if ( collisionbox_.bottom <= screen_place_.h ||
+       collisionbox_.top >= screen::screenatt.height ) {
     //Ball is in contact with floor or ceiling update x acc
     forces_.x += friction * (vel_.x < 0.0 ? -1.0 : 1.0);
   } // end if touching top/bottom
@@ -469,3 +469,27 @@ void clsCannonball::setSpin(double newspin) {
   spin_ = newspin;
 }
 /*****************************************************************************/
+void clsCannonball::writeInfo() {
+  /////////////////////////////////////////////////
+  /// @brief Writes information bout the ball to the console
+  /////////////////////////////////////////////////
+
+  printf("\n\n");
+  printf("Information about Ball: %i\n",ballID_);
+  printf("Color: \t \t \t (%i, %i, %i)\n",color_.Red, color_.Green, color_.Blue);
+  printf("Location: \t \t (%5.5f, %5.5f)\n",dblLOC_.x,dblLOC_.y);
+  printf("Velocity: \t \t (%5.5f, %5.5f)\n",vel_.x,vel_.y);
+  printf("Acceleration: \t \t (%5.5f, %5.5f)\n",acc_.x,acc_.y);
+  printf("Forces: \t \t (%5.5f, %5.5f)\n", forces_.x, forces_.y);
+  printf("Spin: \t \t \t (%5.5f)\n\n\n", spin_);
+
+}
+/*****************************************************************************/
+void clsCannonball::togglePause() {
+  /////////////////////////////////////////////////
+  /// @brief Enable/disable pause
+  /////////////////////////////////////////////////
+
+  paused_ = !(paused_);
+}
+/*****************************************************************************/

src/cannonball.h

@@ -62,7 +62,7 @@ typedef struct stcDoubleValues dblXY;
 typedef struct stcPhysicalProperties PP;
 typedef struct stcBox BOX;
 typedef struct stcColor clr;
-typedef struct stcXYZVector XYZ;
+//typedef struct stcXYZVector XYZ;
 
 typedef std::vector<LOC> VPath;
 /// @}
@@ -75,17 +75,15 @@ class clsCannonball {
     LOC getplace(void);
     void setplace(LOC);
     void setSpin(double);
-
     void update(double);
-    //void setSDLScreen(SDL_Texture*, SDL_Texture*, WINATT, uint);
     dblXY getVelocity(void);
     void setVelocity(dblXY);
     PP getPhysicalProps(void);
     void setPhysicalProps(PP);
     BOX getBOX(void);
     double getSpin(void);
-
-
+    void writeInfo(void);
+    void togglePause(void);
     bool blnstarted_; /**< Whether or not the ball is "started" if it is, the program will update
         it and won't let a new ball replace it in its array spot. */
 
@@ -114,6 +112,7 @@ class clsCannonball {
 
     dblXY forces_; /**< Forces on the ball in x and y */
     double spin_; /**< The angular velocity of the ball (in rad/s) for the Magnus Effect  */
+    bool paused_; /**< If the simulation is paused or not.  */
 
     void show(void);
     void drawPath(LOC);

src/core.cpp

@@ -359,6 +359,9 @@ char core::handleEvent(SDL_Event* e ) {
     // there is a mouse-based event, so now we have to check what tool we are using.
     if (global::blnDebugMode) { printf("Mouse event found.\n"); }
     switch ( toolbar.getTool() ) {
+    /** @todo (GamerMan7799#9#) Simplify the cases, merge similar tool functions
+              such as ToolFire, and ToolDrop, and ToolRope, ToolDele, ToolDrag, and ToolInfo.
+              I want to get them all working on their own first before I try to merge them. */
     case ToolFire:
     default: // make tool fire the default
       if(global::blnDebugMode) { printf("Tool Fire event\n"); }
@@ -399,6 +402,18 @@ char core::handleEvent(SDL_Event* e ) {
       return 0;
     case ToolDrag:
       if(global::blnDebugMode) { printf("Tool Drag event\n"); }
+      SDL_GetMouseState(&currentmouse.x, &currentmouse.y);
+      ball_num = findSelectedBall(currentmouse);
+      if (ball_num == -1) {return 0;}
+      return 0;
+    case ToolInfo:
+      if(global::blnDebugMode) { printf("Tool Info event\n"); }
+      if ( e->type == SDL_MOUSEBUTTONDOWN ) {
+        SDL_GetMouseState(&currentmouse.x, &currentmouse.y);
+        ball_num = findSelectedBall(currentmouse);
+        if (ball_num == -1) {return 0;}
+        cannonballs::balls[ball_num].writeInfo();
+      }
       return 0;
     } // end switch tool type
   } else if ( e->type == SDL_KEYDOWN ) {
@@ -416,6 +431,14 @@ char core::handleEvent(SDL_Event* e ) {
       for (int i = 0; i < cannonballs::balls.size(); ++i)
         { cannonballs::balls[i].setVelocity({0.0,0.0}); }
       return 0;
+    case SDLK_p:
+      //"pauses" the simulation by preventing ball from updating
+      /** @bug (GamerMan7799#1#): If you create a ball while the simulation is paused,
+               the newly created ball won't be paused. And it will be inverse the rest
+               of the simulation. */
+      for (int i = 0; i < cannonballs::balls.size(); ++i)
+        { cannonballs::balls[i].togglePause(); }
+      return 0;
     case SDLK_f:
       if(global::blnDebugMode) { printf("Random fire triggered\n"); }
       return 'f';
@@ -444,6 +467,9 @@ char core::handleEvent(SDL_Event* e ) {
     case SDLK_5:
       core::toolbar.setTool(ToolDrag);
       return 0;
+    case SDLK_6:
+      core::toolbar.setTool(ToolInfo);
+      return 0;
     default:
       return 0;
     } //end switch key
@@ -465,7 +491,8 @@ int core::findSelectedBall(LOC mouseplace) {
     ball_box = cannonballs::balls[i].getBOX();
 
     if ( mouseplace.x >= ball_box.left && mouseplace.x <= ball_box.right) {
-      if ( mouseplace.y >= ball_box.top && mouseplace.y >= ball_box.bottom) {
+      // SDL y coordinates are measured from top of screen
+      if ( mouseplace.y >= ball_box.top && mouseplace.y <= ball_box.bottom) {
         return i;
       }
     }

src/global.h

@@ -85,8 +85,9 @@ enum Tools {
   ToolFire = 0, /**< The basic firing tool. */
   ToolDrop,     /**< Drops a ball without velocity. */
   ToolRope,     /**< Tool to add a rope between balls, or pin ball to wall. */
-  ToolDele,   /**< Tool to delete selected ball. */
+  ToolDele,     /**< Tool to delete selected ball. */
   ToolDrag,     /**< Tool that allows ball to be dragged around. */
+  ToolInfo     /**< Tool that writes information about the selected ball to screen */
 };
 /*****************************************************************************/
 #endif // __GLOBAL_H_INCLUDED__

src/image_tools.xpm

@@ -1,6 +1,6 @@
 /* XPM */
 static char * image_tools_xpm[] = {
-"24 120 2 1",
+"24 144 2 1",
 " 	c None",
 ".	c #FFFFFF",
 "                        ",
@@ -122,4 +122,28 @@ static char * image_tools_xpm[] = {
 "      .............     ",
 "       ...........      ",
 "        .........       ",
-"                        "};
+"                        ",
+"                        ",
+"                        ",
+"        .........       ",
+"      ............      ",
+"    ................    ",
+"    .................   ",
+"   .........  .......   ",
+"  .........    .......  ",
+"  ..........  ........  ",
+" ...................... ",
+" .......... ........... ",
+" .........   .......... ",
+" ..........   ......... ",
+" ..........  .......... ",
+" .........   .......... ",
+" .........   .......... ",
+"  ........   .........  ",
+"  ........   .........  ",
+"   .......    .......   ",
+"   ..................   ",
+"    ................    ",
+"      .............     ",
+"       ..........       ",
+"          ....          "};