Merge pull request #7 from bvssvni/master

Published 0.1.0

Author: bvssvni

.gitignore

@@ -9,3 +9,5 @@
 
 # Generated by Cargo
 /target/
+
+Cargo.lock

Cargo.lock

@@ -4,12 +4,15 @@ version = "0.1.0"
 authors = [
     "Sean Hagar <rcix2010@gmail.com>"
 ]
-keywords = ["key", "button", "controller", "mouse", "press"]
-description = "A Rust library for tracking key/mouse press events from windows for use in update loops"
+keywords = ["key", "button", "tracker", "mouse", "piston"]
+description = "A Piston library for tracking key/mouse press events from windows for use in update loops"
+license = "MIT"
+repository = "https://github.com/PistonDevelopers/button_tracker.git"
+homepage = "https://github.com/PistonDevelopers/button_tracker"
 
 [lib]
 name = "button_tracker"
 path = "src/lib.rs"
 
 [dependencies.pistoncore-input]
-version = "*"
+version = "0.17.0"

Cargo.toml

@@ -1,2 +1,2 @@
 # button_tracker
-A Rust library for tracking key/mouse press events from windows for use in update loops
+A Piston library for tracking key/mouse press events from windows for use in update loops

README.md

@@ -1,23 +1,24 @@
 #![deny(missing_docs)]
 
-
-//! A Rust library for tracking key/mouse press events from windows for use in update loops
+//! A Piston library for tracking key/mouse press events
+//! from windows for use in update loops
 
 extern crate input;
 
 use input::Button;
 use std::collections::HashMap;
 
-
-/// Master struct for the button controller. Consumes button data from any source (though most commonly window event loop generated press events) and tracks them in an update loop friendly form.
+/// Master struct for the button controller.
+/// Consumes button data from any source
+/// (though most commonly window event loop generated press events)
+/// and tracks them in an update loop friendly form.
 #[derive(Clone)]
 pub struct ButtonController {
     current_buttons: HashMap<Button, bool>,
     last_buttons: HashMap<Button, bool>,
 }
 
 impl ButtonController {
-
     /// Creates a new ButtonController.
     pub fn new() -> ButtonController {
         ButtonController {
@@ -26,24 +27,31 @@ impl ButtonController {
         }
     }
 
-    /// Copies the current input state into the last known button state. Call this in your update loop logic, once per update.
+    /// Copies the current input state into the last known button state.
+    /// Call this in your update loop logic, once per update.
     pub fn update(&mut self) {
         for (button, state) in &self.current_buttons {
             self.last_buttons.insert(*button, *state);
         }
     }
 
-    /// Tracks that a button is currently pressed. The most common way to do so is passing in Button contents from PressEvents generated from your relevant window class.
+    /// Tracks that a button is currently pressed.
+    /// The most common way to do so is passing in Button contents
+    /// from PressEvents generated from your relevant window class.
     pub fn register_press(&mut self, button: &Button) {
         self.current_buttons.insert(*button, true);
     }
 
-    /// Tracks that a button is currently un-pressed (or notes that a previously pressed button is now not pressed). The most common way to do so is passing in Button contents from ReleaseEvents generated from your relevant window class.
+    /// Tracks that a button is currently un-pressed
+    /// (or notes that a previously pressed button is now not pressed).
+    /// The most common way to do so is passing in Button contents
+    /// from ReleaseEvents generated from your relevant window class.
     pub fn register_release(&mut self, button: &Button) {
         self.current_buttons.insert(*button, false);
     }
 
-    /// Checks if a button is pressed as of the current update. Will return false if a button has never been registered as pressed.
+    /// Checks if a button is pressed as of the current update.
+    /// Will return false if a button has never been registered as pressed.
     pub fn current_pressed(&mut self, button: &Button) -> bool {
         if let Some(state) = self.current_buttons.get(button) {
             *state
@@ -52,7 +60,8 @@ impl ButtonController {
         }
     }
 
-    /// Checks if a button is pressed as of the last update. Will return false if a button has never been registered as pressed.
+    /// Checks if a button is pressed as of the last update.
+    /// Will return false if a button has never been registered as pressed.
     pub fn last_pressed(&mut self, button: &Button) -> bool {
         if let Some(state) = self.last_buttons.get(button) {
             *state
@@ -61,9 +70,15 @@ impl ButtonController {
         }
     }
 
-    /// Checks for a combination of a button press/release across the current and last update. Most useful for determining whether a button was just pressed or released.
-    pub fn pressed_state(&mut self, button: &Button, last_state: bool, current_state: bool) -> bool {
+    /// Checks for a combination of a button press/release across
+    /// the current and last update.
+    /// Most useful for determining whether a button was just pressed
+    /// or released.
+    pub fn pressed_state(&mut self,
+                         button: &Button,
+                         last_state: bool,
+                         current_state: bool)
+                         -> bool {
         self.last_pressed(button) == last_state && self.current_pressed(button) == current_state
     }
-
 }