Merge #136

136: Implement multiple traits for all objects r=alteous a=vitvakatu

Author: bors[bot]

src/animation.rs

@@ -103,6 +103,7 @@
 use cgmath;
 use froggy;
 use mint;
+use std::hash::{Hash, Hasher};
 use std::sync::mpsc;
 
 use Object;
@@ -226,6 +227,7 @@ enum Operation {
 type Message = (froggy::WeakPointer<ActionData>, Operation);
 
 /// Controls the playback properties of an animation
+#[derive(Clone, Debug)]
 pub struct Action {
     /// Message channel to parent mixer.
     tx: mpsc::Sender<Message>,
@@ -234,6 +236,26 @@ pub struct Action {
     pointer: froggy::Pointer<ActionData>,
 }
 
+impl PartialEq for Action {
+    fn eq(
+        &self,
+        other: &Action,
+    ) -> bool {
+        self.pointer == other.pointer
+    }
+}
+
+impl Eq for Action {}
+
+impl Hash for Action {
+    fn hash<H: Hasher>(
+        &self,
+        state: &mut H,
+    ) {
+        self.pointer.hash(state);
+    }
+}
+
 /// Internal data for an animation action.
 struct ActionData {
     /// The animation data for this action.

src/audio.rs

@@ -110,6 +110,7 @@ impl AudioData {
 ///
 /// You must add it to the scene to play sounds.
 /// You may create several `Source`s to play sounds simultaneously.
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub struct Source {
     pub(crate) object: Object,
 }
@@ -125,27 +126,27 @@ impl Source {
         clip: &Clip,
     ) {
         let msg = HubOperation::SetAudio(Operation::Append(clip.clone()));
-        let _ = self.object.tx.send((self.as_ref().downgrade(), msg));
+        let _ = self.object.tx.send((self.object.node.downgrade(), msg));
     }
 
     /// Pause current sound.
     ///
     /// You can [`resume`](struct.Source.html#method.resume) playback.
     pub fn pause(&self) {
         let msg = HubOperation::SetAudio(Operation::Pause);
-        let _ = self.object.tx.send((self.as_ref().downgrade(), msg));
+        let _ = self.object.tx.send((self.object.node.downgrade(), msg));
     }
 
     /// Resume playback after [`pausing`](struct.Source.html#method.pause).
     pub fn resume(&self) {
         let msg = HubOperation::SetAudio(Operation::Resume);
-        let _ = self.object.tx.send((self.as_ref().downgrade(), msg));
+        let _ = self.object.tx.send((self.object.node.downgrade(), msg));
     }
 
     /// Stop the playback by emptying the queue.
     pub fn stop(&self) {
         let msg = HubOperation::SetAudio(Operation::Stop);
-        let _ = self.object.tx.send((self.as_ref().downgrade(), msg));
+        let _ = self.object.tx.send((self.object.node.downgrade(), msg));
     }
 
     /// Adjust playback volume.
@@ -156,7 +157,7 @@ impl Source {
         volume: f32,
     ) {
         let msg = HubOperation::SetAudio(Operation::SetVolume(volume));
-        let _ = self.object.tx.send((self.as_ref().downgrade(), msg));
+        let _ = self.object.tx.send((self.object.node.downgrade(), msg));
     }
 }
 

src/camera.rs

@@ -60,7 +60,6 @@ use cgmath;
 use mint;
 use std::ops;
 
-use node::NodePointer;
 use object::Object;
 
 /// The Z values of the near and far clipping planes of a camera's projection.
@@ -86,6 +85,7 @@ impl From<ops::RangeFrom<f32>> for ZRange {
 }
 
 /// A camera's projection.
+#[derive(Clone, Debug, PartialEq)]
 pub enum Projection {
     /// An orthographic projection.
     Orthographic(Orthographic),
@@ -96,6 +96,7 @@ pub enum Projection {
 /// Camera is used to render Scene with specific [`Projection`].
 ///
 /// [`Projection`]: enum.Projection.html
+#[derive(Clone, Debug, PartialEq)]
 pub struct Camera {
     pub(crate) object: Object,
 
@@ -157,24 +158,7 @@ impl Projection {
     }
 }
 
-impl AsRef<NodePointer> for Camera {
-    fn as_ref(&self) -> &NodePointer {
-        &self.object.node
-    }
-}
-
-impl ops::Deref for Camera {
-    type Target = Object;
-    fn deref(&self) -> &Object {
-        &self.object
-    }
-}
-
-impl ops::DerefMut for Camera {
-    fn deref_mut(&mut self) -> &mut Object {
-        &mut self.object
-    }
-}
+three_object_wrapper!(Camera);
 
 /// Orthographic projection parameters.
 #[derive(Clone, Debug, PartialEq)]

src/controls/first_person.rs

@@ -7,7 +7,7 @@ use input::{axis, Input, Key};
 use object::Object;
 use std::f32::consts::PI;
 
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq)]
 struct Axes {
     pub forward: Option<axis::Key>,
     pub strafing: Option<axis::Key>,
@@ -31,6 +31,7 @@ impl Default for Axes {
 }
 
 /// Controls for first person camera.
+#[derive(Clone, Debug, PartialEq)]
 pub struct FirstPerson {
     object: Object,
     position: mint::Point3<f32>,
@@ -45,6 +46,7 @@ pub struct FirstPerson {
 }
 
 /// Constructs custom [`FirstPerson`](struct.FirstPerson.html) controls.
+#[derive(Clone, Debug, PartialEq)]
 pub struct Builder {
     object: Object,
     position: mint::Point3<f32>,

src/controls/orbit.rs

@@ -11,6 +11,7 @@ use object::Object;
 /// Camera is rotating around the fixed point without any restrictions.
 /// By default, it uses left mouse button as control button (hold it to rotate) and mouse wheel
 /// to adjust distance to the central point.
+#[derive(Clone, Debug)]
 pub struct Orbit {
     object: Object,
     transform: TransformInternal,
@@ -20,6 +21,7 @@ pub struct Orbit {
 }
 
 /// Helper struct to construct [`Orbit`](struct.Orbit.html) with desired settings.
+#[derive(Clone, Debug)]
 pub struct Builder {
     object: Object,
     position: mint::Point3<f32>,

src/factory/mod.rs

@@ -8,8 +8,8 @@ use std::path::{Path, PathBuf};
 
 use animation;
 use camera;
-use color;
 use cgmath::Vector3;
+use color;
 use genmesh::{Polygon, Triangulate};
 use gfx;
 use gfx::format::I8Norm;
@@ -124,7 +124,11 @@ impl Factory {
         let object = self.hub.lock().unwrap().spawn_scene();
         let hub = self.hub.clone();
         let background = scene::Background::Color(color::BLACK);
-        Scene { object, hub, background }
+        Scene {
+            object,
+            hub,
+            background,
+        }
     }
 
     /// Create new [Orthographic] Camera.

src/hub.rs

@@ -132,7 +132,7 @@ impl Hub {
         let tx = self.message_tx.clone();
         let node = self.nodes.create(NodeInternal {
             scene_id: Some(uid),
-            .. SubNode::Scene.into()
+            ..SubNode::Scene.into()
         });
         Object { node, tx }
     }

src/input/axis.rs

@@ -3,7 +3,7 @@
 use glutin::VirtualKeyCode as KeyCode;
 
 /// Two buttons responsible for opposite directions along specific axis.
-#[derive(Clone, Copy, Debug, PartialEq)]
+#[derive(Clone, Copy, Debug, PartialEq, Hash)]
 pub struct Key {
     /// Key for "negative" direction
     pub neg: KeyCode,
@@ -19,7 +19,7 @@ pub struct Key {
 /// - `id = 2` for mouse wheel moves.
 ///
 /// However, these `id`s depend on hardware and may vary on different machines.
-#[derive(Clone, Copy, Debug, PartialEq)]
+#[derive(Clone, Copy, Debug, PartialEq, Hash)]
 pub struct Raw {
     /// Axis id.
     pub id: u8,

src/light.rs

@@ -10,13 +10,13 @@ use render::{BackendResources, ShadowFormat};
 
 /// `ShadowMap` is used to render shadows from [`PointLight`](struct.PointLight.html)
 /// and [`DirectionalLight`](struct.DirectionalLight.html).
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub struct ShadowMap {
     pub(crate) resource: gfx::handle::ShaderResourceView<BackendResources, f32>,
     pub(crate) target: gfx::handle::DepthStencilView<BackendResources, ShadowFormat>,
 }
 
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq)]
 pub(crate) enum ShadowProjection {
     Orthographic(Orthographic),
 }
@@ -33,6 +33,7 @@ impl ShadowMap {
 
 /// Omni-directional, fixed-intensity and fixed-color light source that affects
 /// all objects in the scene equally.
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub struct Ambient {
     pub(crate) object: Object,
 }
@@ -47,6 +48,7 @@ impl Ambient {
 /// The light source that illuminates all objects equally from a given direction,
 /// like an area light of infinite size and infinite distance from the scene;
 /// there is shading, but cannot be any distance falloff.
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub struct Directional {
     pub(crate) object: Object,
     pub(crate) shadow: Option<ShadowMap>,
@@ -93,6 +95,7 @@ impl Directional {
 /// takes color of the "ground". In other cases, color is determined as
 /// interpolation between colors of upper and lower hemispheres, depending on
 /// how much the normal is oriented to the upper and the lower hemisphere.
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub struct Hemisphere {
     pub(crate) object: Object,
 }
@@ -105,6 +108,7 @@ impl Hemisphere {
 }
 
 /// Light originates from a single point, and spreads outward in all directions.
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub struct Point {
     pub(crate) object: Object,
 }

src/macros.rs

@@ -43,6 +43,12 @@ macro_rules! three_object_wrapper {
     };
     ($($name:ident::$field:ident),*) => {
         $(
+            impl AsRef<$crate::Object> for $name {
+                fn as_ref(&self) -> &$crate::Object {
+                    &self.$field
+                }
+            }
+
             impl ::std::ops::Deref for $name {
                 type Target = $crate::Object;
                 fn deref(&self) -> &$crate::Object {