Struct ColorMap 

pub struct ColorMap {
    pub name: String,
    pub stops: Vec<ColorStop>,
}

A colormap with multiple color stops and smooth interpolation

Fields

name: String

Name of the colormap

stops: Vec<ColorStop>

Ordered list of color stops

Implementations

impl ColorMap

pub fn new(name: impl Into<String>) -> Self

Create a new colormap with a given name

Examples found in repository

examples/basic_usage.rs (line 21)

fn main() {
    // Load built-in colormap
    println!("Loading Fire colormap...");
    let fire = scala_chromatica::io::load_builtin_colormap("Fire")
        .expect("Failed to load Fire colormap");

    // Sample colors at different positions
    println!("\nFire gradient samples:");
    for i in 0..=10 {
        let position = i as f64 / 10.0;
        let color = fire.get_color(position);
        println!("  {:.1}: RGB({}, {}, {})", position, color.r, color.g, color.b);
    }

    // Create custom gradient
    println!("\nCreating custom gradient...");
    let mut custom = ColorMap::new("RedBlue");
    custom.add_stop(ColorStop::new(0.0, Color::new(255, 0, 0)));
    custom.add_stop(ColorStop::new(0.5, Color::new(255, 255, 255)));
    custom.add_stop(ColorStop::new(1.0, Color::new(0, 0, 255)));

    println!("\nCustom gradient samples:");
    for i in 0..=10 {
        let position = i as f64 / 10.0;
        let color = custom.get_color(position);
        println!("  {:.1}: RGB({}, {}, {})", position, color.r, color.g, color.b);
    }

    // List all available colormaps
    println!("\nListing all available colormaps...");
    match scala_chromatica::io::list_available_colormaps() {
        Ok(colormaps) => {
            println!("Found {} colormap(s):", colormaps.len());
            for info in colormaps {
                let type_str = if info.is_builtin {
                    "built-in"
                } else {
                    "custom"
                };
                println!("  - {} ({})", info.name, type_str);
            }
        }
        Err(e) => eprintln!("Error listing colormaps: {}", e),
    }

    // Demonstrate HSV color creation
    println!("\nHSV color examples:");
    let red = Color::from_hsv(0.0, 1.0, 1.0);
    println!("  Red (H=0):   RGB({}, {}, {})", red.r, red.g, red.b);

    let green = Color::from_hsv(120.0, 1.0, 1.0);
    println!("  Green (H=120): RGB({}, {}, {})", green.r, green.g, green.b);

    let blue = Color::from_hsv(240.0, 1.0, 1.0);
    println!("  Blue (H=240): RGB({}, {}, {})", blue.r, blue.g, blue.b);
}

pub fn with_stops(name: impl Into<String>, stops: Vec<ColorStop>) -> Self

Create a colormap with initial stops

pub fn add_stop(&mut self, stop: ColorStop)

Add a color stop to the gradient

Examples found in repository

examples/basic_usage.rs (line 22)

fn main() {
    // Load built-in colormap
    println!("Loading Fire colormap...");
    let fire = scala_chromatica::io::load_builtin_colormap("Fire")
        .expect("Failed to load Fire colormap");

    // Sample colors at different positions
    println!("\nFire gradient samples:");
    for i in 0..=10 {
        let position = i as f64 / 10.0;
        let color = fire.get_color(position);
        println!("  {:.1}: RGB({}, {}, {})", position, color.r, color.g, color.b);
    }

    // Create custom gradient
    println!("\nCreating custom gradient...");
    let mut custom = ColorMap::new("RedBlue");
    custom.add_stop(ColorStop::new(0.0, Color::new(255, 0, 0)));
    custom.add_stop(ColorStop::new(0.5, Color::new(255, 255, 255)));
    custom.add_stop(ColorStop::new(1.0, Color::new(0, 0, 255)));

    println!("\nCustom gradient samples:");
    for i in 0..=10 {
        let position = i as f64 / 10.0;
        let color = custom.get_color(position);
        println!("  {:.1}: RGB({}, {}, {})", position, color.r, color.g, color.b);
    }

    // List all available colormaps
    println!("\nListing all available colormaps...");
    match scala_chromatica::io::list_available_colormaps() {
        Ok(colormaps) => {
            println!("Found {} colormap(s):", colormaps.len());
            for info in colormaps {
                let type_str = if info.is_builtin {
                    "built-in"
                } else {
                    "custom"
                };
                println!("  - {} ({})", info.name, type_str);
            }
        }
        Err(e) => eprintln!("Error listing colormaps: {}", e),
    }

    // Demonstrate HSV color creation
    println!("\nHSV color examples:");
    let red = Color::from_hsv(0.0, 1.0, 1.0);
    println!("  Red (H=0):   RGB({}, {}, {})", red.r, red.g, red.b);

    let green = Color::from_hsv(120.0, 1.0, 1.0);
    println!("  Green (H=120): RGB({}, {}, {})", green.r, green.g, green.b);

    let blue = Color::from_hsv(240.0, 1.0, 1.0);
    println!("  Blue (H=240): RGB({}, {}, {})", blue.r, blue.g, blue.b);
}

pub fn remove_stop(&mut self, index: usize)

Remove a color stop by index (minimum 2 stops required)

pub fn get_color(&self, position: f64) -> Color

Get color at a specific position (0.0 to 1.0) by interpolating between stops

Examples found in repository

examples/basic_usage.rs (line 15)

fn main() {
    // Load built-in colormap
    println!("Loading Fire colormap...");
    let fire = scala_chromatica::io::load_builtin_colormap("Fire")
        .expect("Failed to load Fire colormap");

    // Sample colors at different positions
    println!("\nFire gradient samples:");
    for i in 0..=10 {
        let position = i as f64 / 10.0;
        let color = fire.get_color(position);
        println!("  {:.1}: RGB({}, {}, {})", position, color.r, color.g, color.b);
    }

    // Create custom gradient
    println!("\nCreating custom gradient...");
    let mut custom = ColorMap::new("RedBlue");
    custom.add_stop(ColorStop::new(0.0, Color::new(255, 0, 0)));
    custom.add_stop(ColorStop::new(0.5, Color::new(255, 255, 255)));
    custom.add_stop(ColorStop::new(1.0, Color::new(0, 0, 255)));

    println!("\nCustom gradient samples:");
    for i in 0..=10 {
        let position = i as f64 / 10.0;
        let color = custom.get_color(position);
        println!("  {:.1}: RGB({}, {}, {})", position, color.r, color.g, color.b);
    }

    // List all available colormaps
    println!("\nListing all available colormaps...");
    match scala_chromatica::io::list_available_colormaps() {
        Ok(colormaps) => {
            println!("Found {} colormap(s):", colormaps.len());
            for info in colormaps {
                let type_str = if info.is_builtin {
                    "built-in"
                } else {
                    "custom"
                };
                println!("  - {} ({})", info.name, type_str);
            }
        }
        Err(e) => eprintln!("Error listing colormaps: {}", e),
    }

    // Demonstrate HSV color creation
    println!("\nHSV color examples:");
    let red = Color::from_hsv(0.0, 1.0, 1.0);
    println!("  Red (H=0):   RGB({}, {}, {})", red.r, red.g, red.b);

    let green = Color::from_hsv(120.0, 1.0, 1.0);
    println!("  Green (H=120): RGB({}, {}, {})", green.r, green.g, green.b);

    let blue = Color::from_hsv(240.0, 1.0, 1.0);
    println!("  Blue (H=240): RGB({}, {}, {})", blue.r, blue.g, blue.b);
}

pub fn default_scheme() -> Self

Default HSV-based color scheme (smooth rainbow)

pub fn fire_scheme() -> Self

Fire color scheme (black -> red -> orange -> yellow -> white)

pub fn ocean_scheme() -> Self

Ocean color scheme (black -> deep blue -> cyan -> white)

pub fn grayscale_scheme() -> Self

Grayscale color scheme (black -> gray -> white)

pub fn rainbow_scheme() -> Self

Rainbow color scheme (full spectrum)

Trait Implementations

impl Clone for ColorMap

fn clone(&self) -> ColorMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColorMap

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColorMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ColorMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.