Cleanup

JakeJMattson · JakeJMattson · commit 21f71af4f446 · 2018-06-23T15:55:27.000-05:00
Prepare for release.
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/demo/TouchController.java b/TouchControl/src/io/github/mattson543/touchcontrol/demo/TouchController.java
@@ -44,10 +44,10 @@ private void start()
 			displayFatalError("Failed to load OpenCV!");
 
 		//Force exit
-		System.out.print("Program terminated.");
 		System.exit(0);
 	}
 
+	@SuppressWarnings("unused")
 	private void capture(boolean debugMode)
 	{
 		//Start camera
@@ -61,8 +61,7 @@ private void capture(boolean debugMode)
 		}
 
 		//Get camera properties
-		double cameraWidth = camera.getWidth();
-		double cameraHeight = camera.getHeight();
+		double cameraWidth = camera.getWidth(), cameraHeight = camera.getHeight();
 
 		//Create display
 		ImageFrame rawDisplay = new ImageFrame("Touch Control");
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/display/ImageFrame.java b/TouchControl/src/io/github/mattson543/touchcontrol/display/ImageFrame.java
@@ -6,7 +6,7 @@
 import javax.swing.JFrame;
 
 /**
- * Frame - GUI container for components (holds ImagePanel)
+ * Frame - GUI container for components (holds ImagePanel).
  *
  * @author mattson543
  */
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/display/ImagePanel.java b/TouchControl/src/io/github/mattson543/touchcontrol/display/ImagePanel.java
@@ -6,7 +6,7 @@
 import javax.swing.JPanel;
 
 /**
- * Panel - holds image to display in GUI
+ * Panel - holds image to display in GUI.
  *
  * @author mattson543
  */
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/touchables/Button.java b/TouchControl/src/io/github/mattson543/touchcontrol/touchables/Button.java
@@ -3,7 +3,7 @@
 import org.opencv.core.*;
 
 /**
- * Abstract Button - contains general (clickable) button behavior
+ * Abstract Button - contains general (clickable) button behavior.
  *
  * @author mattson543
  */
@@ -22,8 +22,8 @@ protected Button(Rect dimensions, Scalar color)
 
 	/*
 	 * (non-Javadoc)
-	 * @see io.github.mattson543.touchcontrol.touchables.Touchable#
-	 * updateDetectionPoint(org.opencv.core.Mat)
+	 * @see io.github.mattson543.touchcontrol.touchables.Touchable
+	 * #updateDetectionPoint(org.opencv.core.Mat)
 	 */
 	@Override
 	public Point updateDetectionPoint(Mat filteredImage)
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/touchables/MousePad.java b/TouchControl/src/io/github/mattson543/touchcontrol/touchables/MousePad.java
@@ -6,8 +6,8 @@
 import org.opencv.core.Point;
 
 /**
- * Demo Pad - Example application of abstract pad
- * Controls mouse pointer position
+ * Demo Pad - Example application of abstract pad.
+ * Controls mouse pointer position.
  *
  * @author mattson543
  */
@@ -28,7 +28,7 @@ public MousePad(Rect dimensions, Scalar color)
 	}
 
 	/**
-	 * Initialize fields
+	 * Initialize fields.
 	 */
 	private void init()
 	{
@@ -62,7 +62,7 @@ public void performAction()
 
 	/**
 	 * Convert the internal detection point from a point on the Touchable to a
-	 * point on the screen so the mouse can be moved anywhere on the display
+	 * point on the screen so the mouse can be moved anywhere on the display.
 	 *
 	 * @return Adjusted point
 	 */
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/touchables/Pad.java b/TouchControl/src/io/github/mattson543/touchcontrol/touchables/Pad.java
@@ -3,7 +3,7 @@
 import org.opencv.core.*;
 
 /**
- * Abstract Pad - contains general pad behavior
+ * Abstract Pad - contains general pad behavior.
  *
  * @author mattson543
  */
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/touchables/PianoKey.java b/TouchControl/src/io/github/mattson543/touchcontrol/touchables/PianoKey.java
@@ -5,8 +5,8 @@
 import org.opencv.core.*;
 
 /**
- * Demo Button - Example application of abstract button
- * Plays note when touched
+ * Demo Button - Example application of abstract button.
+ * Plays note when touched.
  *
  * @author mattson543
  */
@@ -32,7 +32,7 @@ public PianoKey(Rect dimensions, Scalar color, char note)
 	}
 
 	/**
-	 * Initialize fields
+	 * Initialize fields.
 	 *
 	 * @param note
 	 *            Character representation of the note
@@ -47,7 +47,7 @@ private void init(char note)
 	}
 
 	/**
-	 * Determine the key of the note based on the character input
+	 * Determine the key of the note based on the character input.
 	 *
 	 * @param note
 	 *            Character representation of the note
@@ -65,7 +65,7 @@ private int determineKey(char note)
 	}
 
 	/**
-	 * Create the audio player
+	 * Create the audio player.
 	 */
 	private void setupMidi()
 	{
@@ -99,7 +99,6 @@ public void performAction()
 			if (!hasPlayed)
 			{
 				playNote(1000);
-
 				hasPlayed = true;
 			}
 		}
@@ -108,7 +107,7 @@ public void performAction()
 	}
 
 	/**
-	 * Play the note that was assigned to the key
+	 * Play the note that was assigned to the key.
 	 *
 	 * @param duration
 	 *            The amount of ms that the note should be held for
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/touchables/Slider.java b/TouchControl/src/io/github/mattson543/touchcontrol/touchables/Slider.java
@@ -4,7 +4,7 @@
 import org.opencv.imgproc.Imgproc;
 
 /**
- * Abstract Slider - contains general slider behavior
+ * Abstract Slider - contains general slider behavior.
  *
  * @author mattson543
  */
@@ -27,8 +27,8 @@ public abstract class Slider extends Touchable
 	 */
 	private boolean shouldLabel;
 
-	private static int DEFAULT_DIVISIONS = 100;
-	private static boolean DEFAULT_VISIBILITY = true;
+	private static final int DEFAULT_DIVISIONS = 100;
+	private static final boolean DEFAULT_VISIBILITY = true;
 
 	protected Slider(Rect dimensions, Scalar color)
 	{
@@ -63,7 +63,7 @@ protected boolean isLabeled()
 	}
 
 	/**
-	 * Determine the size of each division sector
+	 * Determine the size of each division sector.
 	 */
 	private void calculateDivisionSize()
 	{
@@ -72,7 +72,7 @@ private void calculateDivisionSize()
 	}
 
 	/**
-	 * Confine number of divisions to range
+	 * Confine number of divisions to range.
 	 *
 	 * @param divisions
 	 *            Attempted value
@@ -90,8 +90,8 @@ else if (divisions > 100)
 
 	/*
 	 * (non-Javadoc)
-	 * @see io.github.mattson543.touchcontrol.touchables.Touchable#
-	 * updateDetectionPoint(org.opencv.core.Mat)
+	 * @see io.github.mattson543.touchcontrol.touchables.Touchable
+	 * #updateDetectionPoint(org.opencv.core.Mat)
 	 */
 	@Override
 	public Point updateDetectionPoint(Mat filteredImage)
@@ -107,8 +107,8 @@ public Point updateDetectionPoint(Mat filteredImage)
 
 	/*
 	 * (non-Javadoc)
-	 * @see io.github.mattson543.touchcontrol.touchables.Touchable#drawOnto(org.
-	 * opencv.core.Mat)
+	 * @see io.github.mattson543.touchcontrol.touchables.Touchable
+	 * #drawOnto(org.opencv.core.Mat)
 	 */
 	@Override
 	public void drawOnto(Mat image)
@@ -119,7 +119,7 @@ public void drawOnto(Mat image)
 	}
 
 	/**
-	 * Draw status line and label
+	 * Draw status line and label.
 	 *
 	 * @param image
 	 *            Matrix
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/touchables/ToggleButton.java b/TouchControl/src/io/github/mattson543/touchcontrol/touchables/ToggleButton.java
@@ -3,7 +3,7 @@
 import org.opencv.core.*;
 
 /**
- * Abstract Button - contains general (toggle) button behavior
+ * Abstract Button - contains general (toggle) button behavior.
  *
  * @author mattson543
  */
@@ -28,8 +28,8 @@ protected ToggleButton(Rect dimensions, Scalar color)
 	/*
 	 * (non-Javadoc)
 	 * @see
-	 * io.github.mattson543.touchcontrol.touchables.Button#updateDetectionPoint(
-	 * org.opencv.core.Mat)
+	 * io.github.mattson543.touchcontrol.touchables.Button
+	 * #updateDetectionPoint(org.opencv.core.Mat)
 	 */
 	@Override
 	public Point updateDetectionPoint(Mat filteredImage)
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/touchables/Touchable.java b/TouchControl/src/io/github/mattson543/touchcontrol/touchables/Touchable.java
@@ -4,7 +4,7 @@
 import org.opencv.imgproc.Imgproc;
 
 /**
- * Contains fundamental functions for a Touchable object of any kind
+ * Contains fundamental functions for a Touchable object of any kind.
  *
  * @author mattson543
  */
@@ -52,7 +52,7 @@ public Scalar getColor()
 
 	/**
 	 * Search through the range of the Touchable and find the first occurrence
-	 * of a non-background pixel
+	 * of a non-background pixel.
 	 *
 	 * @param filteredImage
 	 *            Binary image
@@ -95,7 +95,7 @@ public Point updateDetectionPoint(Mat filteredImage)
 	}
 
 	/**
-	 * Determine whether or not the current detection point is null
+	 * Determine whether or not the current detection point is null.
 	 *
 	 * @return Detection status
 	 */
@@ -105,7 +105,7 @@ protected boolean hasDetection()
 	}
 
 	/**
-	 * Draw Touchable onto image
+	 * Draw Touchable onto image.
 	 *
 	 * @param image
 	 *            Matrix to draw the Touchable object onto
@@ -124,12 +124,12 @@ public void drawOnto(Mat image)
 	}
 
 	/**
-	 * Enforce method requirement on subclasses
+	 * Abstract action that each Touchable subclass will perform.
 	 */
 	public abstract void performAction();
 
 	/**
-	 * Formatter to create a uniform toString() for all Touchable objects
+	 * Formatter to create a uniform toString() for all Touchable objects.
 	 *
 	 * @param name
 	 *            Name of field being formatted
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/touchables/VolumeSlider.java b/TouchControl/src/io/github/mattson543/touchcontrol/touchables/VolumeSlider.java
@@ -5,8 +5,8 @@
 import org.opencv.core.*;
 
 /**
- * Demo Slider - Example application of abstract slider
- * Controls system volume
+ * Demo Slider - Example application of abstract slider.
+ * Controls system volume.
  *
  * @author mattson543
  */
@@ -42,16 +42,15 @@ public void performAction()
 	}
 
 	/**
-	 * Set system volume
+	 * Set system volume.
 	 *
 	 * @param volume
 	 *            New target system volume
 	 */
 	private void setVolume(int volume)
 	{
 		//Nircmd allows volume changing
-		File nircmd = new File("./nircmd/nircmd.exe");
-		String nircmdPath = nircmd.getAbsolutePath();
+		String nircmdPath = new File("nircmd/nircmd.exe").getAbsolutePath();
 
 		//Convert volume to nircmd standard
 		double nircmdVolume = 655.35 * volume;
@@ -68,7 +67,7 @@ private void setVolume(int volume)
 	}
 
 	/**
-	 * Execute a system command (Calls nircmd from command line)
+	 * Execute a system command (Call nircmd from command line).
 	 *
 	 * @param command
 	 *            System command
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/utils/Camera.java b/TouchControl/src/io/github/mattson543/touchcontrol/utils/Camera.java
@@ -11,17 +11,17 @@
 public class Camera
 {
 	/**
-	 * OpenCV VideoCapture to access physical camera.
+	 * OpenCV VideoCapture to access physical camera
 	 */
 	private final VideoCapture camera;
 	/**
-	 * How each frame will be flipped upon reading.
+	 * How each frame will be flipped upon reading
 	 */
 	private final Integer rotation;
 
 	/**
 	 * When no index is specified, '0' can be used to request
-	 * the default camera available to the operating system.
+	 * the default camera available to the operating system
 	 */
 	private static final int DEFAULT_CAMERA = 0;
 
@@ -81,7 +81,6 @@ public Mat getFrame()
 
 	/**
 	 * Whether or not the camera was successfully initialized.
-	 * Returns false if no camera is plugged in.
 	 *
 	 * @return Open status
 	 */
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/utils/ImageHandler.java b/TouchControl/src/io/github/mattson543/touchcontrol/utils/ImageHandler.java
@@ -81,19 +81,12 @@ public Mat filterImage(Mat image)
 	public BufferedImage convertMatToImage(Mat matrix)
 	{
 		//Get image dimensions
-		int width = matrix.width();
-		int height = matrix.height();
+		int width = matrix.width(), height = matrix.height();
 
-		//Determine image type
-		int type;
+		int type = matrix.channels() != 1 ? BufferedImage.TYPE_3BYTE_BGR : BufferedImage.TYPE_BYTE_GRAY;
 
-		if (matrix.channels() != 1)
-		{
-			type = BufferedImage.TYPE_3BYTE_BGR;
+		if (type == BufferedImage.TYPE_3BYTE_BGR)
 			Imgproc.cvtColor(matrix, matrix, Imgproc.COLOR_BGR2RGB);
-		}
-		else
-			type = BufferedImage.TYPE_BYTE_GRAY;
 
 		//Get matrix data
 		byte[] data = new byte[width * height * (int) matrix.elemSize()];
diff --git a/TouchControl/src/io/github/mattson543/touchcontrol/utils/LibraryLoader.java b/TouchControl/src/io/github/mattson543/touchcontrol/utils/LibraryLoader.java

Original file line number	Diff line number	Diff line change
`@@ -44,10 +44,10 @@ private void start()`
`44`	`44`	`displayFatalError("Failed to load OpenCV!");`
`45`	`45`
`46`	`46`	`//Force exit`
`47`		`- System.out.print("Program terminated.");`
`48`	`47`	`System.exit(0);`
`49`	`48`	`}`
`50`	`49`
	`50`	`+ @SuppressWarnings("unused")`
`51`	`51`	`private void capture(boolean debugMode)`
`52`	`52`	`{`
`53`	`53`	`//Start camera`
`@@ -61,8 +61,7 @@ private void capture(boolean debugMode)`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`//Get camera properties`
`64`		`- double cameraWidth = camera.getWidth();`
`65`		`- double cameraHeight = camera.getHeight();`
	`64`	`+ double cameraWidth = camera.getWidth(), cameraHeight = camera.getHeight();`
`66`	`65`
`67`	`66`	`//Create display`
`68`	`67`	`ImageFrame rawDisplay = new ImageFrame("Touch Control");`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`import javax.swing.JFrame;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * Frame - GUI container for components (holds ImagePanel)`
	`9`	`+ * Frame - GUI container for components (holds ImagePanel).`
`10`	`10`	`*`
`11`	`11`	`* @author mattson543`
`12`	`12`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`import javax.swing.JPanel;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * Panel - holds image to display in GUI`
	`9`	`+ * Panel - holds image to display in GUI.`
`10`	`10`	`*`
`11`	`11`	`* @author mattson543`
`12`	`12`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@`
`6`	`6`	`import org.opencv.core.Point;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * Demo Pad - Example application of abstract pad`
`10`		`- * Controls mouse pointer position`
	`9`	`+ * Demo Pad - Example application of abstract pad.`
	`10`	`+ * Controls mouse pointer position.`
`11`	`11`	`*`
`12`	`12`	`* @author mattson543`
`13`	`13`	`*/`
`@@ -28,7 +28,7 @@ public MousePad(Rect dimensions, Scalar color)`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`/**`
`31`		`- * Initialize fields`
	`31`	`+ * Initialize fields.`
`32`	`32`	`*/`
`33`	`33`	`private void init()`
`34`	`34`	`{`
`@@ -62,7 +62,7 @@ public void performAction()`
`62`	`62`
`63`	`63`	`/**`
`64`	`64`	`* Convert the internal detection point from a point on the Touchable to a`
`65`		`- * point on the screen so the mouse can be moved anywhere on the display`
	`65`	`+ * point on the screen so the mouse can be moved anywhere on the display.`
`66`	`66`	`*`
`67`	`67`	`* @return Adjusted point`
`68`	`68`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`import org.opencv.core.*;`
`4`	`4`
`5`	`5`	`/**`
`6`		`- * Abstract Pad - contains general pad behavior`
	`6`	`+ * Abstract Pad - contains general pad behavior.`
`7`	`7`	`*`
`8`	`8`	`* @author mattson543`
`9`	`9`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,8 @@`
`5`	`5`	`import org.opencv.core.*;`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * Demo Button - Example application of abstract button`
`9`		`- * Plays note when touched`
	`8`	`+ * Demo Button - Example application of abstract button.`
	`9`	`+ * Plays note when touched.`
`10`	`10`	`*`
`11`	`11`	`* @author mattson543`
`12`	`12`	`*/`
`@@ -32,7 +32,7 @@ public PianoKey(Rect dimensions, Scalar color, char note)`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/**`
`35`		`- * Initialize fields`
	`35`	`+ * Initialize fields.`
`36`	`36`	`*`
`37`	`37`	`* @param note`
`38`	`38`	`* Character representation of the note`
`@@ -47,7 +47,7 @@ private void init(char note)`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`/**`
`50`		`- * Determine the key of the note based on the character input`
	`50`	`+ * Determine the key of the note based on the character input.`
`51`	`51`	`*`
`52`	`52`	`* @param note`
`53`	`53`	`* Character representation of the note`
`@@ -65,7 +65,7 @@ private int determineKey(char note)`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`/**`
`68`		`- * Create the audio player`
	`68`	`+ * Create the audio player.`
`69`	`69`	`*/`
`70`	`70`	`private void setupMidi()`
`71`	`71`	`{`
`@@ -99,7 +99,6 @@ public void performAction()`
`99`	`99`	`if (!hasPlayed)`
`100`	`100`	`{`
`101`	`101`	`playNote(1000);`
`102`		`-`
`103`	`102`	`hasPlayed = true;`
`104`	`103`	`}`
`105`	`104`	`}`
`@@ -108,7 +107,7 @@ public void performAction()`
`108`	`107`	`}`
`109`	`108`
`110`	`109`	`/**`
`111`		`- * Play the note that was assigned to the key`
	`110`	`+ * Play the note that was assigned to the key.`
`112`	`111`	`*`
`113`	`112`	`* @param duration`
`114`	`113`	`* The amount of ms that the note should be held for`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`import org.opencv.imgproc.Imgproc;`
`5`	`5`
`6`	`6`	`/**`
`7`		`- * Contains fundamental functions for a Touchable object of any kind`
	`7`	`+ * Contains fundamental functions for a Touchable object of any kind.`
`8`	`8`	`*`
`9`	`9`	`* @author mattson543`
`10`	`10`	`*/`
`@@ -52,7 +52,7 @@ public Scalar getColor()`
`52`	`52`
`53`	`53`	`/**`
`54`	`54`	`* Search through the range of the Touchable and find the first occurrence`
`55`		`- * of a non-background pixel`
	`55`	`+ * of a non-background pixel.`
`56`	`56`	`*`
`57`	`57`	`* @param filteredImage`
`58`	`58`	`* Binary image`
`@@ -95,7 +95,7 @@ public Point updateDetectionPoint(Mat filteredImage)`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/**`
`98`		`- * Determine whether or not the current detection point is null`
	`98`	`+ * Determine whether or not the current detection point is null.`
`99`	`99`	`*`
`100`	`100`	`* @return Detection status`
`101`	`101`	`*/`
`@@ -105,7 +105,7 @@ protected boolean hasDetection()`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`/**`
`108`		`- * Draw Touchable onto image`
	`108`	`+ * Draw Touchable onto image.`
`109`	`109`	`*`
`110`	`110`	`* @param image`
`111`	`111`	`* Matrix to draw the Touchable object onto`
`@@ -124,12 +124,12 @@ public void drawOnto(Mat image)`
`124`	`124`	`}`
`125`	`125`
`126`	`126`	`/**`
`127`		`- * Enforce method requirement on subclasses`
	`127`	`+ * Abstract action that each Touchable subclass will perform.`
`128`	`128`	`*/`
`129`	`129`	`public abstract void performAction();`
`130`	`130`
`131`	`131`	`/**`
`132`		`- * Formatter to create a uniform toString() for all Touchable objects`
	`132`	`+ * Formatter to create a uniform toString() for all Touchable objects.`
`133`	`133`	`*`
`134`	`134`	`* @param name`
`135`	`135`	`* Name of field being formatted`