abrasion/engine/render/light.rs

// Copyright 2020 Sergiusz 'q3k' Bazanski <q3k@q3k.org>
//
// This file is part of Abrasion.
//
// Abrasion is free software: you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free
// Software Foundation, version 3.
//
// Abrasion is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License along with
// Abrasion.  If not, see <https://www.gnu.org/licenses/>.

use std::time;

use cgmath as cgm;

use crate::physics::color;
use crate::render::vulkan::data;

/// An Omni point light, with position in 3d space, and 'color' defined in lumens per CIE XYZ
/// color channel.
#[derive(Debug)]
pub struct Omni {
    /// Luminour power/flux defined as lumens per XYZ color channel.
    pub color: color::XYZ,
}


impl Omni {
    /// Make a test light. This has... a color. It's kinda yellow. And something close to 650
    /// lumens of luminous power. 
    // TODO(q3k): implement [Kry85] (eq. 68) somewhere in //engine/physics for generation
    // of nice lights colours from color temperature.
    //
    // [Kry85]
    // M. Krystek. 1985. "An algorithm to calculate correlated color temperature"
    // Color Research & Application, 10 (1), 38–40.
    pub fn test() -> Self {
        Self::with_color(color::XYZ::new(234.7*200.0, 214.1*200.0, 207.9*200.0))
    }

    pub fn with_color(color: color::XYZ) -> Self{
        Self {
            color,
        }
    }

    pub fn vulkan_uniform(&self, pos: &cgm::Vector4<f32>) -> data::OmniLight {
        // TODO: cache this?
        data::OmniLight {
            pos: [pos.x, pos.y, pos.z, pos.w],
            color: [self.color.x, self.color.y, self.color.z, 0.0],
        }
    }
}

#[derive(Debug)]
pub enum Light {
    Omni(Omni),
}

impl Light {
    pub fn omni_test() -> Light {
        Light::Omni(Omni::test())
    }
    pub fn omni_with_color(color: color::XYZ) -> Light {
        Light::Omni(Omni::with_color(color))
    }
}