Mmulli/dev

.gitignore

@@ -1 +1,2 @@
 /target
+/*.svg

CHANGELOG.md

@@ -5,6 +5,21 @@ Please track all notable changes in this file. This format is based on
 
 ## [Unreleased]
 
+## [0.0.4]
+
+### Added
+
+- Added short circle example directly to the README as well as to a new examples folder
+
+### Changed
+
+- Bumped rust edition to 2021
+- Upgraded the Nalbegra dependency to 0.29
+- Implemented VectorT for OVector instead of VectorN as VectorN is now deprecated.
+- Moved main.rs to the examples folder
+- Moved the svg and approx to dev-dependencies as these are used in examples / testing only.
+- Edited .gitignore to ignore root level .svg artifacts generated from the example
+
 ## [0.0.3]
 
 ### Added

Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 name = "capstan"
-version = "0.0.3"
+version = "0.0.4"
 authors = ["Jonathan Merritt <j.s.merritt@gmail.com>"]
-edition = "2018"
+edition = "2021"
 license = "MIT"
 description = "NURBS library with a CAD focus"
 homepage = "https://github.com/lancelet/capstan/"
@@ -14,11 +14,11 @@ readme = "README.md"
 
 [dependencies]
 alga = "0.9"
-approx = "0.3"
-nalgebra = "0.22"
+nalgebra = "0.29"
 num-traits = "0.2"
-svg = "0.8"
 thiserror = "1.0"
 
 [dev-dependencies]
+approx = "0.5"
+svg = "0.8"
 proptest = "0.10"

README.md

@@ -36,4 +36,52 @@ NURBS curve:
 ## NURBS Curve Representation
 
 The library uses the "Rhino" form of NURBS curves, where there are two fewer
-knots than in "traditional" NURBS.
+knots than in "traditional" NURBS.
+
+## Usage
+
+A simple circle example demonstrating how to obtain an interpolated value at an arbitrary location on a curve.
+
+```rust
+use nalgebra::Vector2;
+use capstan::{knotvec::KnotVec};
+type Curve = capstan::curve::Curve<f32, Vector2<f32>>;
+
+fn main() {
+
+    let r = f32::sqrt(2.0) / 2.0;
+    let degree = 2;
+    let control_points = vec![
+        Vector2::new(1.0, 0.0),
+        Vector2::new(1.0, 1.0),
+        Vector2::new(0.0, 1.0),
+        Vector2::new(-1.0, 1.0),
+        Vector2::new(-1.0, 0.0),
+        Vector2::new(-1.0, -1.0),
+        Vector2::new(0.0, -1.0),
+        Vector2::new(1.0, -1.0),
+        Vector2::new(1.0, 0.0),
+    ];
+    let weights = vec![1.0, r, 1.0, r, 1.0, r, 1.0, r, 1.0];
+    let knots = KnotVec::new(vec![
+        0.0, 0.0, 0.0, 0.25, 0.25, 0.5, 0.5, 0.75, 0.75, 1.0, 1.0, 1.0,
+    ])
+    .unwrap();
+
+    let circle = Curve::new(degree, control_points, weights, knots).unwrap();
+
+    let u = 0.5_f32;
+
+    // The de_boor method is used to obtainin an interpolated point
+    println!("interpolation paramater value {}:{}", u, circle.de_boor(u))
+}
+```
+
+## Examples
+
+The examples folder includes the above as well as the more comprehensive svg_example.rs example that outputs a number of svg files. The svg crate is used for this but is only required for demonstration purposes.
+
+To run the svg_example:
+$ cargo run --example svg_example
+
+This will output a number of .svg files into the working directory

examples/circle_example.rs

@@ -0,0 +1,33 @@
+//! A simple circle example demonstrating how to obtain an 
+//! interpolated value at an arbitrary location on a curve.
+
+use nalgebra::Vector2;
+use capstan::{knotvec::KnotVec};
+type Curve = capstan::curve::Curve<f32, Vector2<f32>>;
+
+fn main() {
+
+    let r = f32::sqrt(2.0) / 2.0;
+    let degree = 2;
+    let control_points = vec![
+        Vector2::new(1.0, 0.0),
+        Vector2::new(1.0, 1.0),
+        Vector2::new(0.0, 1.0),
+        Vector2::new(-1.0, 1.0),
+        Vector2::new(-1.0, 0.0),
+        Vector2::new(-1.0, -1.0),
+        Vector2::new(0.0, -1.0),
+        Vector2::new(1.0, -1.0),
+        Vector2::new(1.0, 0.0),
+    ];
+    let weights = vec![1.0, r, 1.0, r, 1.0, r, 1.0, r, 1.0];
+    let knots = KnotVec::new(vec![
+        0.0, 0.0, 0.0, 0.25, 0.25, 0.5, 0.5, 0.75, 0.75, 1.0, 1.0, 1.0,
+    ])
+    .unwrap();
+
+    let circle = Curve::new(degree, control_points, weights, knots).unwrap();
+
+    let u = 0.5_f32;
+    println!("interpolation paramater value {}:{}", u, circle.de_boor(u))
+}