Struct Lighting

pub struct Lighting { /* private fields */ }

A structure describing the lighting model.

Example

use ndarray::Array;
use plotlars::{ColorBar, Lighting, Palette, Plot, SurfacePlot, Text};
use polars::prelude::*;
use std::iter;

let n: usize = 100;
let x_base: Vec<f64> = Array::linspace(-10.0, 10.0, n).into_raw_vec();
let y_base: Vec<f64> = Array::linspace(-10.0, 10.0, n).into_raw_vec();

let x = x_base
    .iter()
    .flat_map(|&xi| iter::repeat(xi).take(n))
    .collect::<Vec<_>>();

let y = y_base
    .iter()
    .cycle()
    .take(n * n)
    .cloned()
    .collect::<Vec<_>>();

let z = x_base
    .iter()
    .map(|i| {
        y_base
            .iter()
            .map(|j| 1.0 / (j * j + 5.0) * j.sin() + 1.0 / (i * i + 5.0) * i.cos())
            .collect::<Vec<_>>()
    })
    .flatten()
    .collect::<Vec<_>>();

let dataset = df![
        "x" => &x,
        "y" => &y,
        "z" => &z,
    ]
    .unwrap();

SurfacePlot::builder()
    .data(&dataset)
    .x("x")
    .y("y")
    .z("z")
    .plot_title(
        Text::from("Surface Plot")
            .font("Arial")
            .size(18),
    )
    .color_bar(
        &ColorBar::new()
            .border_width(1),
    )
    .color_scale(Palette::Cividis)
    .reverse_scale(true)
    .lighting(
        &Lighting::new()
            .position(1, 0, 0)
            .ambient(1.0)
            .diffuse(1.0)
            .fresnel(1.0)
            .roughness(1.0)
            .specular(1.0),
    )
    .opacity(0.5)
    .build()
    .plot();

Implementations

impl Lighting

pub fn new() -> Self

Creates a new Lighting instance with default values.

pub fn position(self, x: i32, y: i32, z: i32) -> Self

Sets the position of the virtual light source.

Arguments

• x – An i32 value representing the x‑coordinate of the light.
• y – An i32 value representing the y‑coordinate of the light.
• z – An i32 value representing the z‑coordinate of the light (positive z points toward the viewer).

pub fn ambient(self, value: f64) -> Self

Sets the ambient light component.

Arguments

• value – A f64 value in the range 0.0 – 1.0 specifying the uniform tint strength.

pub fn diffuse(self, value: f64) -> Self

Sets the diffuse light component.

Arguments

• value – A f64 value in the range 0.0 – 1.0 specifying the Lambertian reflection strength.

pub fn fresnel(self, value: f64) -> Self

Sets the Fresnel (edge brightness) component.

Arguments

• value – A f64 value in the range 0.0 – 1.0 specifying the rim‑light intensity.

pub fn roughness(self, value: f64) -> Self

Sets the roughness of the material.

Arguments

• value – A f64 value in the range 0.0 – 1.0 that controls highlight width (0.0 = glossy, 1.0 = matte).

pub fn specular(self, value: f64) -> Self

Sets the specular highlight intensity.

Arguments

• value – A f64 value in the range 0.0 – 1.0 specifying the mirror‑like highlight strength.

Trait Implementations

impl Clone for Lighting

fn clone(&self) -> Lighting

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Lighting

fn default() -> Lighting

Returns the “default value” for a type.