Struct cubic_spline::SplineOpts

pub struct SplineOpts { /* fields omitted */ }

A list of options indicating how the spline should be calculated

use cubic_spline::SplineOpts;

let o1 = SplineOpts::default();

let o2 = SplineOpts::new();

let o3 = SplineOpts::new()
  .tension(0.5)
  .num_of_segments(16);

Options list:

• tension - Sets the bending strength of the curve. The usual value ranges from 0.0 (straight) to 1.0 (very rounded). If not specified DEFAULT_TENSION will be used.

• num_of_segments - The number of points to be calculated between each two known points. If not specified DEFAULT_SEGMENTS will be used.

• hidden_point_at_start - A point that will not be drawn, but the beginning of the graph will bend as if it is there.

• hidden_point_at_end - Same as previous, but affects the end of the graph.

Implementations

impl SplineOpts

pub fn new() -> Self

Creates new one with defaults.

pub fn tension(self, val: f64) -> Self

Sets tension.

pub fn num_of_segments(self, val: u32) -> Self

Sets num_of_segments.

pub fn hidden_point_at_start<T: Into<Point>>(self, val: T) -> Self

Sets hidden_point_at_start.

pub fn hidden_point_at_end<T: Into<Point>>(self, val: T) -> Self

Sets hidden_point_at_end.

pub fn get_tension(&self) -> f64

pub fn get_num_of_segments(&self) -> u32

pub fn get_hidden_point_at_start(&self) -> Option<&Point>

pub fn get_hidden_point_at_end(&self) -> Option<&Point>

Trait Implementations

impl Clone for SplineOpts

pub fn clone(&self) -> SplineOpts

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SplineOpts

pub fn default() -> Self

Example

use cubic_spline::{SplineOpts};
let opts = SplineOpts::default();

assert_eq!(opts.get_num_of_segments(), cubic_spline::DEFAULT_SEGMENTS);
assert!((opts.get_tension() - cubic_spline::DEFAULT_TENSION).abs() < 1e-9);
assert!(opts.get_hidden_point_at_end().is_none());