Struct cube_helix::CubeHelix

pub struct CubeHelix {
    pub gamma: f64,
    pub start: f64,
    pub rotations: f64,
    pub saturation: f64,
    pub min: f64,
    pub max: f64,
}

Examples

Using default values:

use cube_helix::CubeHelix;
// Get default values
let ch: CubeHelix = Default::default();
// Returns color white: (255,255,255)
let color = ch.get_color(1.0);
assert_eq!(color.0, 255);
assert_eq!(color.1, 255);
assert_eq!(color.2, 255);

Using defaults partially:

use cube_helix::CubeHelix;
// Override 'start' and 'rotation' values
let ch = CubeHelix { start: 0.2, rotations: 1.5, ..Default::default() };
// Returns color black: (0,0,0)
let color = ch.get_color(0.0);
assert_eq!(color.0, 0);
assert_eq!(color.1, 0);
assert_eq!(color.2, 0);

Fields

gamma: f64

Gamma factor.

start: f64

Starting angle: 0.5 -> purple

rotations: f64

Rotations (1.5 : R -> G -> B -> R).
Negative value will 'spin' in opposite direction.

saturation: f64

Value from 0..1 to control saturation. Zero value is completelly grayscale.

min: f64

Lowest value in value range. This value represents black.

max: f64

Highest value in value range. This value represents white.

Methods

impl CubeHelix

Adds color calculation to CubeHelix struct

pub fn get_color(&self, value: f64) -> (u8, u8, u8)

Calculates CubeHelix color for given value.
Value must be in the min..max range. Returns a tuple with three values: (red: u8, green: u8, blue: u8).

Examples

use cube_helix::CubeHelix;
// Use range 0..100 - defalts otherwise
let ch = CubeHelix { min: 0.0, max: 100.0, ..Default::default() };
// Get color in the middle. Returns color: (174,97,158)
let color = ch.get_color(50.0);
assert_eq!(color.0, 174);
assert_eq!(color.1, 97);
assert_eq!(color.2, 158);

Trait Implementations

impl Default for CubeHelix

Default values to produce the same gradient as D.A Green's paper in Figure 1.
gamma: 1.0
start: 0.5
rotations: -1.5
saturation: 1.0
min: 0.0
max: 1.0

fn default() -> CubeHelix

Returns the "default value" for a type.

impl Debug for CubeHelix

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.