Move scatter styling to a 'Point' trait

Author: milliams

examples/scatter_svg.rs

@@ -1,5 +1,7 @@
 extern crate plotlib;
 
+use plotlib::style::Point;
+
 fn main() {
     let data = [
         (-3.0, 2.3),
@@ -11,7 +13,7 @@ fn main() {
     ];
     let s1 = plotlib::scatter::Scatter::from_vec(&data).style(
         plotlib::scatter::Style::new()
-            .marker(plotlib::scatter::Marker::Square)
+            .marker(plotlib::style::Marker::Square)
             .colour("#DD3355"),
     );
     let s2 = plotlib::scatter::Scatter::from_vec(&[(-1.4, 2.5), (7.2, -0.3)])

examples/scatter_text.rs

@@ -1,5 +1,7 @@
 extern crate plotlib;
 
+use plotlib::style::Point;
+
 fn main() {
     let data = [
         (-3.0, 2.3),
@@ -11,7 +13,7 @@ fn main() {
     ];
     let s1 = plotlib::scatter::Scatter::from_vec(&data);
     let s2 = plotlib::scatter::Scatter::from_vec(&[(-1.4, 2.5), (7.2, -0.3)])
-        .style(plotlib::scatter::Style::new().marker(plotlib::scatter::Marker::Square));
+        .style(plotlib::scatter::Style::new().marker(plotlib::style::Marker::Square));
     let v = plotlib::view::View::new()
         .add(&s1)
         .add(&s2)

src/scatter.rs

@@ -6,16 +6,7 @@ use axis;
 use svg_render;
 use text_render;
 use representation::Representation;
-
-/**
-The marker that should be used for the points of the scatter plot
-*/
-#[derive(Debug, Clone)]
-pub enum Marker {
-    Circle,
-    Square,
-    Cross,
-}
+use style;
 
 /// `Style` follows the 'optional builder' pattern
 /// Each field is a `Option` which start as `None`
@@ -24,7 +15,7 @@ pub enum Marker {
 /// Settings will be cloned in and out of it.
 #[derive(Debug, Default)]
 pub struct Style {
-    marker: Option<Marker>,
+    marker: Option<style::Marker>,
     colour: Option<String>,
 }
 
@@ -36,45 +27,41 @@ impl Style {
         }
     }
 
-    pub fn overlay(&mut self, other: Self) {
+    pub fn overlay(&mut self, other: &Self) {
         match other.marker {
-            Some(v) => self.marker = Some(v),
+            Some(ref v) => self.marker = Some(v.clone()),
             None => {}
         }
         match other.colour {
-            Some(v) => self.colour = Some(v),
+            Some(ref v) => self.colour = Some(v.clone()),
             None => {}
         }
     }
+}
 
-    pub fn marker<T>(mut self, value: T) -> Self
+impl style::Point for Style {
+    fn marker<T>(&mut self, value: T) -> &mut Self
     where
-        T: Into<Marker>,
+        T: Into<style::Marker>,
     {
         self.marker = Some(value.into());
         self
     }
 
-    pub fn get_marker(&self) -> Marker {
-        match self.marker.clone() {
-            Some(v) => v,
-            None => Marker::Circle,
-        }
+    fn get_marker(&self) -> &Option<style::Marker> {
+        &self.marker
     }
 
-    pub fn colour<T>(mut self, value: T) -> Self
+    fn colour<T>(&mut self, value: T) -> &mut Self
     where
         T: Into<String>,
     {
         self.colour = Some(value.into());
         self
     }
 
-    pub fn get_colour(&self) -> String {
-        match self.colour.clone() {
-            Some(v) => v,
-            None => "".into(),
-        }
+    fn get_colour(&self) -> &Option<String> {
+        &self.colour
     }
 }
 
@@ -99,8 +86,8 @@ impl Scatter {
         }
     }
 
-    pub fn style(mut self, style: Style) -> Self {
-        self.style.overlay(style);
+    pub fn style(mut self, style: &Style) -> Self {
+        self.style.overlay(&style);
         self
     }
 

src/style.rs

@@ -11,3 +11,27 @@ pub trait Line {
 
     fn get_colour(&self) -> &Option<String>;
 }
+
+/**
+The marker that should be used for the points of the scatter plot
+*/
+#[derive(Debug, Clone)]
+pub enum Marker {
+    Circle,
+    Square,
+    Cross,
+}
+
+pub trait Point {
+    fn marker<T>(&mut self, value: T) -> &mut Self
+    where
+        T: Into<Marker>;
+
+    fn get_marker(&self) -> &Option<Marker>;
+
+    fn colour<T>(&mut self, value: T) -> &mut Self
+    where
+        T: Into<String>;
+
+    fn get_colour(&self) -> &Option<String>;
+}

src/svg_render.rs

@@ -110,41 +110,44 @@ pub fn draw_y_axis(a: &axis::Axis, face_height: f64) -> node::element::Group {
         .add(label)
 }
 
-pub fn draw_face_points(
+pub fn draw_face_points<S>(
     s: &scatter::Scatter,
     x_axis: &axis::Axis,
     y_axis: &axis::Axis,
     face_width: f64,
     face_height: f64,
-    style: &scatter::Style,
-) -> node::element::Group {
+    style: &S,
+) -> node::element::Group
+where
+    S: style::Point,
+{
     let mut group = node::element::Group::new();
 
     for &(x, y) in &s.data {
         let x_pos = value_to_face_offset(x, x_axis, face_width);
         let y_pos = -value_to_face_offset(y, y_axis, face_height);
         let radius = 5.;
-        match style.get_marker() {
-            scatter::Marker::Circle => {
+        match style.get_marker().clone().unwrap_or(style::Marker::Circle) {
+            style::Marker::Circle => {
                 group.append(
                     node::element::Circle::new()
                         .set("cx", x_pos)
                         .set("cy", y_pos)
                         .set("r", radius)
-                        .set("fill", style.get_colour()),
+                        .set("fill", style.get_colour().clone().unwrap_or("".into())),
                 );
             }
-            scatter::Marker::Square => {
+            style::Marker::Square => {
                 group.append(
                     node::element::Rectangle::new()
                         .set("x", x_pos - radius)
                         .set("y", y_pos - radius)
                         .set("width", 2. * radius)
                         .set("height", 2. * radius)
-                        .set("fill", style.get_colour()),
+                        .set("fill", style.get_colour().clone().unwrap_or("".into())),
                 );
             }
-            scatter::Marker::Cross => {
+            style::Marker::Cross => {
                 let path = node::element::path::Data::new()
                     .move_to((x_pos - radius, y_pos - radius))
                     .line_by((radius * 2., radius * 2.))
@@ -154,7 +157,7 @@ pub fn draw_face_points(
                 group.append(
                     node::element::Path::new()
                         .set("fill", "none")
-                        .set("stroke", style.get_colour())
+                        .set("stroke", style.get_colour().clone().unwrap_or("".into()))
                         .set("stroke-width", 2)
                         .set("d", path),
                 );

src/text_render.rs

@@ -7,6 +7,7 @@ use histogram;
 use scatter;
 use axis;
 use utils::PairWise;
+use style;
 
 // Given a value like a tick label or a bin count,
 // calculate how far from the x-axis it should be plotted
@@ -350,14 +351,17 @@ pub fn render_face_bars(
 /// the x ands y-axes
 /// and the face height and width,
 /// create the strings to be drawn as the face
-pub fn render_face_points(
+pub fn render_face_points<S>(
     s: &scatter::Scatter,
     x_axis: &axis::Axis,
     y_axis: &axis::Axis,
     face_width: u32,
     face_height: u32,
-    style: &scatter::Style,
-) -> String {
+    style: &S,
+) -> String
+where
+    S: style::Point,
+{
     let points: Vec<_> = s.data
         .iter()
         .map(|&(x, y)| {
@@ -368,10 +372,10 @@ pub fn render_face_points(
         })
         .collect();
 
-    let marker = match style.get_marker() {
-        scatter::Marker::Circle => '●',
-        scatter::Marker::Square => '■',
-        scatter::Marker::Cross => '×',
+    let marker = match style.get_marker().clone().unwrap_or(style::Marker::Circle) {
+        style::Marker::Circle => '●',
+        style::Marker::Square => '■',
+        style::Marker::Cross => '×',
     };
 
     let mut face_strings: Vec<String> = vec![];