Update to v1.0.0-RC

## [1.0.0-RC] - 2015-11-21
### Added
* Movement Equation Image
* Collision method set in config

### Notes
* Moved to RC as I've done almost everything I can think of to do. All
that really needs to be figured out is why the balls sometimes stick
together.
Which I believe is because of the Tick system and cannot be easily
fixed.

Author: Patrick Rye

ChangesLog.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented here.
 This project adheres to [Semantic Versioning](http://semver.org/)
 
+## [1.0.0-RC] - 2015-11-21
+### Added
+* Movement Equation Image
+* Collision method set in config
+
+### Notes
+* Moved to RC as I've done almost everything I can think of to do. All that really needs to be figured out is why the balls sometimes stick together.
+	Which I believe is because of the Tick system and cannot be easily fixed.
+
 ## [1.2.7-Beta] - 2015-11-18
 ### Fixed
 * Copy Paste Error that caused the pixel texture to remain in memory

README.md

@@ -52,6 +52,7 @@ Screen Height: 480
 Log Ball's path: 0
 Enable Drag Mode (experimental): 0
 Draw Ball path on screen: 0
+Collision Method: 1
 ```
 
 You can use this to change things like the screen height and width, and other stuff.
@@ -63,6 +64,16 @@ online and I cannot verify how accurate it is.
 
 "Draw Ball path on Screen" (if enabled with a 1 instead of 0), will cause small pixels to trail after each ball.
 
+"Collision Method" you can change how the balls will interact with each other when they collide based on the number in the table below.
+
+| Name                    | Number | Explanation                                                                                                |
+|-------------------------|--------|------------------------------------------------------------------------------------------------------------|
+| CollideElastic          | 0      | This is normal collision in a perfect world without  friction, they hit and bounce off, no energy is lost. |
+| CollideInelastic        | 1      | This is the real life situation. Balls collide and,  bounce off of each other losing some energy.          |
+| CollidePerfectInelastic | 2      | In this method the balls collide and then stick together.                                                  |
+| CollideNone             | 3      | The balls do not collide and pass through each other.                                                      |
+
+
 Once you start the program you will be greeted with a beautiful black screen. To create a new cannonball you click (and hold down the button) 
 you can now move your move around to change the angle that the new cannonball will be fired at; as well as the longer the line the faster it will go. 
 When you are happy with the angle and speed simply release the mouse button and it will be created at the point where you clicked the mouse button down.

project/Equations.PNG

@@ -38,7 +38,7 @@ PROJECT_NAME           = Cannon-Simulation
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v1.2.7-Beta
+PROJECT_NUMBER         = v1.0.0-RC
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -861,7 +861,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             = 
+IMAGE_PATH             = ../Equations.PNG
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

project/doxygen/Doxyfile

@@ -0,0 +1,43 @@
+\documentclass[10pt,a4paper,landscape]{article}
+\usepackage[latin1]{inputenc}
+\usepackage{amsmath}
+\usepackage{amsfonts}
+\usepackage{amssymb}
+\usepackage{graphicx}
+\author{Patrick Rye}
+\begin{document}
+	\begin{equation*}
+		\begin{matrix}\mathit{Defs}\hfill\null &\left\{\begin{matrix}\hfill
+				v_{1x}&=\hfill\null &v_{1}\times \cos (\theta _{1})\\\hfill
+				v_{2x}&=\hfill\null &v_{2}\times \cos (\theta _{2})\\\hfill \phi
+				&=\hfill\null &|\theta _{1}-\theta _{2}|\\\hfill v_{1}&=\hfill\null
+				&\sqrt{v_{1x}^{2}+v_{1y}^{2}}\\\hfill v_{2}&=\hfill\null
+				&\sqrt{v_{2x}^{2}+v_{2y}^{2}}\end{matrix}\right\}\hfill\null
+			\\\mathit{Givens}\hfill\null &\left\{\begin{matrix}v_{1x}\hfill\null
+				&v_{1y}\hfill\null \\v_{2x}\hfill\null &v_{2y}\hfill\null \\\theta
+				_{1}\hfill\null &\theta _{2}\hfill\null \end{matrix}\right\}\hfill\null
+			\\\mathit{Object}1\hfill\null &\left\{\begin{matrix}\hfill
+				v_{1x}^{'}&=\hfill\null &\frac{v_{1}\times \cos (\theta _{1}-\phi
+					)\times (m_{1}-m_{2})+2\ast m_{2}\times v_{2}\times \cos (\theta
+					_{2}-\phi )}{m_{1}+m_{2}}\times \cos (\phi )+v_{1}\times \sin (\theta
+				_{1}-\phi )\times \cos (\phi +\frac{\pi }{2})\\\hfill
+				v_{1y}^{'}&=\hfill\null &\frac{v_{1}\times \cos (\theta _{1}-\phi
+					)\times (m_{1}-m_{2})+2\ast m_{2}\times v_{2}\times \cos (\theta
+					_{2}-\phi )}{m_{1}+m_{2}}\times \sin (\phi )+v_{1}\times \sin (\theta
+				_{1}-\phi )\times \sin (\phi +\frac{\pi
+				}{2})\end{matrix}\right\}\hfill\null \\\mathit{Object}2\hfill\null
+			&\left\{\begin{matrix}\hfill v_{2x}^{'}&=\hfill\null &\frac{v_{2}\times
+					\cos (\theta _{2}-\phi )\times (m_{2}-m_{1})+2\ast m_{1}\times
+					v_{1}\times \cos (\theta _{1}-\phi )}{m_{1}+m_{2}}\times \cos (\phi
+				)+v_{2}\times \sin (\theta _{2}-\phi )\times \cos (\phi +\frac{\pi
+				}{2})\\\hfill v_{2y}^{'}&=\hfill\null &\frac{v_{2}\times \cos (\theta
+				_{2}-\phi )\times (m_{2}-m_{1})+2\ast m_{1}\times v_{1}\times \cos
+				(\theta _{1}-\phi )}{m_{1}+m_{2}}\times \sin (\phi )+v_{2}\times \sin
+			(\theta _{2}-\phi )\times \sin (\phi +\frac{\pi
+			}{2})\end{matrix}\right\}\hfill\null
+		\\\mathit{Coefficient}\mathit{of}\mathit{restitution}\hfill\null
+		&\left\{\begin{matrix}C_{R}\hfill\null &=\hfill\null
+			&\frac{v_{1}^{'}-v_{2}^{'}}{v_{2}-v_{1}}\hfill\null
+		\end{matrix}\right\}\hfill\null \end{matrix}\hfill
+\end{equation*}
+\end{document}

project/doxygen/document.tex

@@ -15,6 +15,7 @@ clsConfig::clsConfig() {
     ///        * values.blnDrawPathOnScreen = false;
     ///        * values.uintScreenWidth = 640;
     ///        * values.uintScreenHeight = 480;
+    ///        * values.uchrCollisionMethod = CollideInelastic;
     ///        It will also set the OS based on values that are defined
     ///
     /////////////////////////////////////////////////
@@ -25,6 +26,7 @@ clsConfig::clsConfig() {
     values.blnDrawPathOnScreen = false;
     values.uintScreenWidth = 640;
     values.uintScreenHeight = 480;
+    values.uchrCollisionMethod = CollideInelastic;
 #if defined(_AIX)
     values.OperatingSystem = "AIX";
 #elif defined(__unix__)
@@ -82,6 +84,7 @@ void clsConfig::make(void) {
                         (values.blnDragMode ? 1 : 0) );
     fprintf(configFile,"Draw Ball path on screen: %u\n",
                         (values.blnDrawPathOnScreen ? 1 : 0) );
+    fprintf(configFile,"Collision Method: %u\n", values.uchrCollisionMethod);
 	fclose(configFile);
 }
 /*****************************************************************************/
@@ -126,6 +129,12 @@ void clsConfig::load(void) {
 	if(Global::blnDebugMode) {printf("Enable Screen Path \t %d\n",intTempBool);}
 	values.blnDrawPathOnScreen = (intTempBool == 1);
 
+    fgets(chrTempString,50,configFile);
+    intValuesScanned = sscanf(chrTempString, "%*s %*s %d", &values.uchrCollisionMethod);
+    if (intValuesScanned < 1) {printf("ERROR!"); values.uchrCollisionMethod = CollideInelastic;}
+    if (values.uchrCollisionMethod > CollideNone) {printf("ERROR!"); values.uchrCollisionMethod = CollideNone;}
+    if(Global::blnDebugMode) {printf("Collision Method: \t %d\n",values.uchrCollisionMethod);}
+
 	fclose(configFile);
 	printf("\n\n");
 }

src/config.cpp

@@ -20,6 +20,7 @@ struct ConfigValues {
 	bool blnLogging; /**< If logging of balls' path to a file is enabled */
 	bool blnDragMode; /**< Whether Drag is enabled or not */
 	bool blnDrawPathOnScreen; /**< Whether to draw the balls' past path on the screen */
+	uchar uchrCollisionMethod; /**< The Method of Collision see Collisions */
 	char* OperatingSystem; /**< The OS that the program is running on, doesn't do anything */
 };
 

src/config.h

@@ -29,7 +29,7 @@ namespace Global {
         extern const float fRecoil;
         extern const float fMinVelocity;
         extern const float fCoefficientRestitution;
-        extern const uchar CollisionMethod;
+        extern uchar CollisionMethod;
     }
 
     namespace Equations {
@@ -41,4 +41,15 @@ namespace Global {
     }
 }
 /*****************************************************************************/
+/** The method of the collision (I just wanted to play around with some options.) */
+enum Collisions {
+    CollideElastic = 0, /**< This is normal collision in a perfect world without
+                             friction, they hit and bounce off, no energy is lost. */
+    CollideInelastic, /**< This is the normal way things collide, Balls collide and
+                           bounce off of each other losing some energy. */
+    CollidePerfectInelastic, /**< In this method the balls collide and then
+                                  stick together. */
+    CollideNone /**< No collisions, balls pass through each other. */
+};
+/*****************************************************************************/
 #endif // __GLOBAL_H_INCLUDED__

src/global.h

@@ -1,7 +1,6 @@
 /*****************************************************************************/
 //General Todos
 /* FIXME (GamerMan7799#1#): The balls will become stuck together for seemingly random reasons */
-/* TODO (GamerMan7799#5#): Collision Method can be set in Config */
 /* TODO (GamerMan7799#9#): Allow setting of some Physics Values in Config */
 /*****************************************************************************/
 #include "version.h"
@@ -29,17 +28,6 @@ namespace Cannonballs {
     clsCannonball Balls[DEFINED_CANNONBALL_LIMIT]; /**< The is the array that holds all of the cannonballs. */
 }
 /*****************************************************************************/
-/** The method of the collision (I just wanted to play around with some options.) */
-enum Collisions {
-    CollideElastic = 0, /**< This is normal collision in a perfect world without
-                             friction, they hit and bounce off, no energy is lost. */
-    CollideInelastic, /**< This is the normal way things collide, Balls collide and
-                           bounce off of each other losing some energy. */
-    CollidePerfectInelastic, /**< In this method the balls collide and then
-                                  stick together. */
-    CollideNone /**< No collisions, balls pass through each other. */
-};
-/*****************************************************************************/
 namespace Global {
     /** Holds if build is in debug mode, this can happen if
         DEFINED_BUILD_MODE_PRIVATE is defined in the complier */
@@ -67,7 +55,7 @@ namespace Global {
         const float fMinVelocity = 0.0; /**< If a ball has less velocity than the it will "die" */
         const float fCoefficientRestitution = 0.76; /**< How much total energy remains after a collision,
                                                         (see https://en.wikipedia.org/wiki/Coefficient_of_restitution for more info) */
-        const uchar CollisionMethod = CollideInelastic; /**< The collision method to use (see Collisions Enum) */
+        uchar CollisionMethod = CollideInelastic; /**< The collision method to use (see Collisions Enum) */
     } //end Namespace Physics
 
     /** Holds Values for different equations that are not physics related */
@@ -275,6 +263,7 @@ void Cannonballs::doCollide(uint numA, uint numB) {
     /////////////////////////////////////////////////
     /// @brief Will calculate the new velocities of two balls that are colliding
     ///
+    /// @image html Equations.PNG "The equations used to get the resulting velocities."
     /// @param numA = the number in the array ball A is
     /// @param numB = the number in the array ball B is
     /// @return void (everything is handled inside the function)

src/main.cpp

@@ -2,7 +2,7 @@
 #define __VERSION_HEADER__
 /*****************************************************************************/
 	//Date Version Types
-	#define DEFINED_VER_DATE "18"
+	#define DEFINED_VER_DATE "21"
 	/**< Day of the last build */
 
 	#define DEFINED_VER_MONTH "11"
@@ -16,7 +16,7 @@
 
 
 	//Software Status
-	#define DEFINED_VER_STATUS  "Beta"
+	#define DEFINED_VER_STATUS  "Release Candidate"
     /**<
     Software Status can be the following:
     | Status | Short | Description |
@@ -27,27 +27,27 @@
     | Alpha | a | This version does not work at all; it usually won't compile at all or crashes more times than it works; best not to use versions in this state. |
     */
 
-	#define DEFINED_VER_STATUS_SHORT  "b"
+	#define DEFINED_VER_STATUS_SHORT  "rc"
 	/**< See table for DEFINED_VER_STATUS */
 
 	//Standard Version Type
 	#define DEFINED_VER_MAJOR  1
 	/**< The major version number */
 
-	#define DEFINED_VER_MINOR  2
+	#define DEFINED_VER_MINOR  0
 	/**< The minor version number */
 
-	#define DEFINED_VER_BUILD  7
+	#define DEFINED_VER_BUILD  0
 	/**< The patch version number */
 
-	#define DEFINED_VER_RC_FILEVERSION 1,2,7,0
+	#define DEFINED_VER_RC_FILEVERSION 1,0,0,4
 	/**< The number used in the boilerplate.rc file
         Follows MAJOR,MINOR,PATCH,BUILD where build is the number of times this version has been built*/
 
-	#define DEFINED_VER_RC_FILEVERSION_STRING "1, 2, 7, 0\0"
+	#define DEFINED_VER_RC_FILEVERSION_STRING "1, 0, 0, 4\0"
 	/**< Is the same as DEFINED_VER_RC_FILEVERSION but is a null terminated string */
 
-	#define DEFINED_VER_FULLVERSION_STRING  "1.2.7-Beta"
+	#define DEFINED_VER_FULLVERSION_STRING  "1.0.0-RC"
 	/**< The full string of the version number */
 
 /*****************************************************************************/