Merge pull request #29 from phaazon/release/2.0.0

2.0.0.

.github/workflows/ci.yaml

@@ -8,12 +8,11 @@ jobs:
       - uses: actions/checkout@v1
       - name: Build
         run: |
-          cargo build --verbose
+          cargo build --verbose --all-features
-          cargo build --verbose --features bezier
       - name: Test
         run: |
-          cargo test --verbose
+          cargo test --verbose --all-features
-          cargo test --verbose --features bezier
+
 
   build-windows:
     runs-on: windows-latest
@@ -21,12 +20,10 @@ jobs:
       - uses: actions/checkout@v1
       - name: Build
         run: |
-          cargo build --verbose
+          cargo build --verbose --all-features
-          cargo build --verbose --features bezier
       - name: Test
         run: |
-          cargo test --verbose
+          cargo test --verbose --all-features
-          cargo test --verbose --features bezier
 
   build-macosx:
     runs-on: macosx-latest
@@ -34,12 +31,10 @@ jobs:
       - uses: actions/checkout@v1
       - name: Build
         run: |
-          cargo build --verbose
+          cargo build --verbose --all-features
-          cargo build --verbose --features bezier
       - name: Test
         run: |
-          cargo test --verbose
+          cargo test --verbose --all-features
-          cargo test --verbose --features bezier
 
   check-readme:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -1,6 +1,20 @@
+# 2.0.0
+
+> Mon Sep 24th 2019
+
+## Major changes
+
+- Add support for [Bézier curves](https://en.wikipedia.org/wiki/B%C3%A9zier_curve).
+- Because of Bézier curves, the `Interpolation` type now has one more type variable to know how we
+  should interpolate with Bézier.
+
+## Minor changes
+
+- Add `Spline::get`, `Spline::get_mut` and `Spline::replace`.
+
 # 1.0
 
-> Sun Sep 22th 2019
+> Sun Sep 22nd 2019
 
 ## Major changes
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "splines"
-version = "1.1.0"
+version = "2.0.0"
 license = "BSD-3-Clause"
 authors = ["Dimitri Sabadie <dimitri.sabadie@gmail.com>"]
 description = "Spline interpolation made easy"
@@ -21,7 +21,6 @@ maintenance = { status = "actively-developed" }
 
 [features]
 default = ["std"]
-bezier = []
 impl-cgmath = ["cgmath"]
 impl-nalgebra = ["alga", "nalgebra", "num-traits"]
 serialization = ["serde", "serde_derive"]

README.md

@@ -98,12 +98,6 @@ So here’s a list of currently supported features and how to enable them:
     - Compiling with the standard library is enabled by default.
     - Use `default-features = []` in your `Cargo.toml` to disable.
     - Enable explicitly with the `"std"` feature.
-  - **Extra interpolation modes.**
-    - In order not to introduce breaking changes, some feature-gates are added to augment the
-      [`Interpolation`] enum.
-    - Those feature-gates will disappear on the next major release of the crate.
-    - The following lists all currently available:
-      - `"bezier"`: [Bézier curves](https://en.wikipedia.org/wiki/B%C3%A9zier_curve).
 
 [`Interpolation`]: crate::interpolation::Interpolation
 

src/cgmath.rs

@@ -2,7 +2,9 @@ use cgmath::{
   BaseFloat, BaseNum, InnerSpace, Quaternion, Vector1, Vector2, Vector3, Vector4, VectorSpace
 };
 
-use crate::interpolate::{Additive, Interpolate, Linear, One, cubic_hermite_def};
+use crate::interpolate::{
+  Additive, Interpolate, Linear, One, cubic_bezier_def, cubic_hermite_def, quadratic_bezier_def
+};
 
 macro_rules! impl_interpolate_vec {
   ($($t:tt)*) => {
@@ -29,6 +31,16 @@ macro_rules! impl_interpolate_vec {
       fn cubic_hermite(x: (Self, T), a: (Self, T), b: (Self, T), y: (Self, T), t: T) -> Self {
         cubic_hermite_def(x, a, b, y, t)
       }
+
+      #[inline(always)]
+      fn quadratic_bezier(a: Self, u: Self, b: Self, t: T) -> Self {
+        quadratic_bezier_def(a, u, b, t)
+      }
+
+      #[inline(always)]
+      fn cubic_bezier(a: Self, u: Self, v: Self, b: Self, t: T) -> Self {
+        cubic_bezier_def(a, u, v, b, t)
+      }
     }
   }
 }
@@ -61,4 +73,14 @@ where Self: InnerSpace<Scalar = T>, T: Additive + BaseFloat + One {
   fn cubic_hermite(x: (Self, T), a: (Self, T), b: (Self, T), y: (Self, T), t: T) -> Self {
     cubic_hermite_def(x, a, b, y, t)
   }
+
+  #[inline(always)]
+  fn quadratic_bezier(a: Self, u: Self, b: Self, t: T) -> Self {
+    quadratic_bezier_def(a, u, b, t)
+  }
+
+  #[inline(always)]
+  fn cubic_bezier(a: Self, u: Self, v: Self, b: Self, t: T) -> Self {
+    cubic_bezier_def(a, u, v, b, t)
+  }
 }

src/interpolate.rs

@@ -268,27 +268,27 @@ macro_rules! impl_interpolate_simple {
 impl_interpolate_simple!(f32);
 impl_interpolate_simple!(f64);
 
-//macro_rules! impl_interpolate_via {
+macro_rules! impl_interpolate_via {
-//  ($t:ty, $v:ty) => {
+  ($t:ty, $v:ty) => {
-//    impl Interpolate<$t> for $v {
+    impl Interpolate<$t> for $v {
-//      fn lerp(a: Self, b: Self, t: $t) -> Self {
+      fn lerp(a: Self, b: Self, t: $t) -> Self {
-//        a * (1. - t as $v) + b * t as $v
+        a * (1. - t as $v) + b * t as $v
-//      }
+      }
-//
+
-//      fn cubic_hermite((x, xt): (Self, $t), (a, at): (Self, $t), (b, bt): (Self, $t), (y, yt): (Self, $t), t: $t) -> Self {
+      fn cubic_hermite((x, xt): (Self, $t), (a, at): (Self, $t), (b, bt): (Self, $t), (y, yt): (Self, $t), t: $t) -> Self {
-//        cubic_hermite_def((x, xt as $v), (a, at as $v), (b, bt as $v), (y, yt as $v), t as $v)
+        cubic_hermite_def((x, xt as $v), (a, at as $v), (b, bt as $v), (y, yt as $v), t as $v)
-//      }
+      }
-//
+
-//      fn quadratic_bezier(a: Self, u: Self, b: Self, t: $t) -> Self {
+      fn quadratic_bezier(a: Self, u: Self, b: Self, t: $t) -> Self {
-//        $t::quadratic_bezier(a as $t, u as $t, b as $t, t)
+        quadratic_bezier_def(a, u, b, t as $v)
-//      }
+      }
-//
+
-//      fn cubic_bezier(a: Self, u: Self, v: Self, b: Self, t: $t) -> Self {
+      fn cubic_bezier(a: Self, u: Self, v: Self, b: Self, t: $t) -> Self {
-//        $t::cubic_bezier(a as $t, u as $t, v as $t, b as $t, t)
+        cubic_bezier_def(a, u, v, b, t as $v)
-//      }
+      }
-//    }
+    }
-//  }
+  }
-//}
+}
-//
+
-//impl_interpolate_via!(f32, f64);
+impl_interpolate_via!(f32, f64);
-//impl_interpolate_via!(f64, f32);
+impl_interpolate_via!(f64, f32);

src/interpolation.rs

@@ -9,7 +9,7 @@
 #[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
 #[cfg_attr(feature = "serialization", serde(rename_all = "snake_case"))]
 pub enum Interpolation<T, V> {
-  /// Hold a [`Key<T, _>`] until the sampling value passes the normalized step threshold, in which
+  /// Hold a [`Key`] until the sampling value passes the normalized step threshold, in which
   /// case the next key is used.
   ///
   /// > Note: if you set the threshold to `0.5`, the first key will be used until half the time
@@ -17,7 +17,7 @@ pub enum Interpolation<T, V> {
   /// > first key will be kept until the next key. Set it to `0.` and the first key will never be
   /// > used.
   ///
-  /// [`Key<T, _>`]: crate::key::Key
+  /// [`Key`]: crate::key::Key
   Step(T),
   /// Linear interpolation between a key and the next one.
   Linear,
@@ -39,11 +39,9 @@ pub enum Interpolation<T, V> {
   ///   tangent used for the next control point is defined as the segment connecting that control
   ///   point and the current control point’s associated point. This is called _quadratic Bézer
   ///   interpolation_ and it kicks ass too, but a bit less than cubic.
-  #[cfg(feature = "bezier")]
   Bezier(V),
-  #[cfg(not(any(feature = "bezier")))]
   #[doc(hidden)]
-  _V(std::marker::PhantomData<V>),
+  __NonExhaustive
 }
 
 impl<T, V> Default for Interpolation<T, V> {
@@ -52,4 +50,3 @@ impl<T, V> Default for Interpolation<T, V> {
     Interpolation::Linear
   }
 }
-

src/lib.rs

@@ -99,12 +99,6 @@
 //!     - Compiling with the standard library is enabled by default.
 //!     - Use `default-features = []` in your `Cargo.toml` to disable.
 //!     - Enable explicitly with the `"std"` feature.
-//!   - **Extra interpolation modes.**
-//!     - In order not to introduce breaking changes, some feature-gates are added to augment the
-//!       [`Interpolation`] enum.
-//!     - Those feature-gates will disappear on the next major release of the crate.
-//!     - The following lists all currently available:
-//!       - `"bezier"`: [Bézier curves](https://en.wikipedia.org/wiki/B%C3%A9zier_curve).
 //!
 //! [`Interpolation`]: crate::interpolation::Interpolation
 

src/nalgebra.rs

@@ -3,7 +3,9 @@ use nalgebra::{Scalar, Vector, Vector1, Vector2, Vector3, Vector4, Vector5, Vect
 use num_traits as nt;
 use std::ops::Mul;
 
-use crate::interpolate::{Interpolate, Linear, Additive, One, cubic_hermite_def};
+use crate::interpolate::{
+  Interpolate, Linear, Additive, One, cubic_bezier_def, cubic_hermite_def, quadratic_bezier_def
+};
 
 macro_rules! impl_interpolate_vector {
   ($($t:tt)*) => {
@@ -40,6 +42,16 @@ macro_rules! impl_interpolate_vector {
       fn cubic_hermite(x: (Self, T), a: (Self, T), b: (Self, T), y: (Self, T), t: T) -> Self {
         cubic_hermite_def(x, a, b, y, t)
       }
+
+      #[inline(always)]
+      fn quadratic_bezier(a: Self, u: Self, b: Self, t: T) -> Self {
+        quadratic_bezier_def(a, u, b, t)
+      }
+
+      #[inline(always)]
+      fn cubic_bezier(a: Self, u: Self, v: Self, b: Self, t: T) -> Self {
+        cubic_bezier_def(a, u, v, b, t)
+      }
     }
   }
 }

src/spline.rs

@@ -129,7 +129,6 @@ impl<T, V> Spline<T, V> {
         }
       }
 
-      #[cfg(feature = "bezier")]
       Interpolation::Bezier(u) => {
         // We need to check the next control point to see whether we want quadratic or cubic Bezier.
         let cp1 = &keys[i + 1];
@@ -147,8 +146,7 @@ impl<T, V> Spline<T, V> {
         }
       }
 
-      #[cfg(not(any(feature = "bezier")))]
+      Interpolation::__NonExhaustive => unreachable!(),
-      Interpolation::_V(_) => unreachable!()
     }
   }
 
@@ -199,6 +197,54 @@ impl<T, V> Spline<T, V> {
       Some(self.0.remove(index))
     }
   }
+
+  /// Update a key and return the key already present.
+  ///
+  /// The key is updated — if present — with the provided function.
+  ///
+  /// # Notes
+  ///
+  /// That function makes sense only if you want to change the interpolator (i.e. [`Key::t`]) of
+  /// your key. If you just want to change the interpolation mode or the carried value, consider
+  /// using the [`Spline::get_mut`] method instead as it will be way faster.
+  pub fn replace<F>(
+    &mut self,
+    index: usize,
+    f: F
+  ) -> Option<Key<T, V>>
+  where
+    F: FnOnce(&Key<T, V>) -> Key<T, V>,
+    T: PartialOrd
+  {
+    let key = self.remove(index)?;
+    self.add(f(&key));
+    Some(key)
+  }
+
+  /// Get a key at a given index.
+  pub fn get(&self, index: usize) -> Option<&Key<T, V>> {
+    self.0.get(index)
+  }
+
+  /// Mutably get a key at a given index.
+  pub fn get_mut(&mut self, index: usize) -> Option<KeyMut<T, V>> {
+    self.0.get_mut(index).map(|key| KeyMut {
+      value: &mut key.value,
+      interpolation: &mut key.interpolation
+    })
+  }
+}
+
+/// A mutable [`Key`].
+///
+/// Mutable keys allow to edit the carried values and the interpolation mode but not the actual
+/// interpolator value as it would invalidate the internal structure of the [`Spline`]. If you
+/// want to achieve this, you’re advised to use [`Spline::replace`].
+pub struct KeyMut<'a, T, V> {
+  /// Carried value.
+  pub value: &'a mut V,
+  /// Interpolation mode to use for that key.
+  pub interpolation: &'a mut Interpolation<T, V>,
 }
 
 // Normalize a time ([0;1]) given two control points.