prisma 0.1.1

//! The scalar traits defining what primitives can be used in channels
//!
//! For an overview of scalars, look at the [`channel`](../index.html) module documentation.

use crate::color;
use angle;
use angle::*;
use num_traits::{cast, Float, NumCast, PrimInt, Zero};
use std::ops;

/// A scalar with no upper and/or lower bound
pub trait FreeChannelScalar: Clone + Float + Default {}

impl FreeChannelScalar for f32 {}
impl FreeChannelScalar for f64 {}

/// A scalar with an upper and lower bound
pub trait BoundedChannelScalar:
    Clone
    + PartialEq
    + PartialOrd
    + Default
    + ops::Add<Self, Output = Self>
    + ops::Sub<Self, Output = Self>
    + ops::Mul<Self, Output = Self>
{
}

impl BoundedChannelScalar for u8 {}
impl BoundedChannelScalar for u16 {}
impl BoundedChannelScalar for u32 {}
impl BoundedChannelScalar for f32 {}
impl BoundedChannelScalar for f64 {}

/// A scalar for periodic, angular channels
pub trait AngularChannelScalar:
    Clone
    + PartialEq
    + PartialOrd
    + Default
    + Zero
    + ops::Add<Self, Output = Self>
    + ops::Sub<Self, Output = Self>
    + angle::Angle
where
    Self::Scalar: Float,
{
    /// The minimum unique value
    fn min_bound() -> Self;
    /// The maximum unique value, equal to the period of the angular unit
    fn max_bound() -> Self;
    /// Returns if the angle is in the normal range
    fn is_normalized(&self) -> bool;
    /// Normalize the angle into its normal range
    fn normalize(self) -> Self;
}

macro_rules! impl_traits_for_angle {
    ($Struct: ident) => {
        impl<T> AngularChannelScalar for $Struct<T>
        where
            T: Float,
        {
            #[inline]
            fn min_bound() -> Self {
                $Struct(cast(0.0).unwrap())
            }
            #[inline]
            fn max_bound() -> Self {
                $Struct($Struct::period())
            }
            #[inline]
            fn is_normalized(&self) -> bool {
                <Self as Angle>::is_normalized(self)
            }
            #[inline]
            fn normalize(self) -> Self {
                <Self as Angle>::normalize(self)
            }
        }

        impl<T> color::Lerp for $Struct<T>
        where
            T: Float,
        {
            type Position = T;
            #[inline]
            fn lerp(&self, right: &Self, pos: Self::Position) -> Self {
                self.interpolate(right, pos)
            }
        }
    };
}

impl_traits_for_angle!(Deg);
impl_traits_for_angle!(Rad);
impl_traits_for_angle!(Turns);
impl_traits_for_angle!(ArcMinutes);
impl_traits_for_angle!(ArcSeconds);

/// A bounded scalar that only takes positive values
pub trait PosNormalChannelScalar: BoundedChannelScalar {
    /// The minimum "in-range" value
    fn min_bound() -> Self;
    /// The maximum "in-range" value
    fn max_bound() -> Self;
    /// Returns if the value is in the normal range
    fn is_normalized(&self) -> bool;
    /// Normalizes the value into the normal range
    fn normalize(self) -> Self;
}
/// A bounded scalar that has positive and negative values
pub trait NormalChannelScalar: BoundedChannelScalar {
    /// The minimum "in-range" value
    fn min_bound() -> Self;
    /// The maximum "in-range" value
    fn max_bound() -> Self;
    /// Returns if the value is in the normal range
    fn is_normalized(&self) -> bool;
    /// Normalizes the value into the normal range
    fn normalize(self) -> Self;
}

fn lerp_flat_int<T, P>(left: &T, right: &T, pos: P) -> T
where
    T: PrimInt + Clone + NumCast,
    P: Float + NumCast,
{
    let inv_pos = P::one() - pos;
    let val_p: P =
        cast::<_, P>(left.clone()).unwrap() * inv_pos + cast::<_, P>(right.clone()).unwrap() * pos;
    cast(val_p).unwrap()
}

fn lerp_flat<T>(left: &T, right: &T, pos: T) -> T
where
    T: Float,
{
    let inv_pos = T::one() - pos;

    *left * inv_pos + *right * pos
}

macro_rules! impl_bounded_channel_traits_int {
    ($name: ident) => {
        impl PosNormalChannelScalar for $name {
            #[inline]
            fn min_bound() -> Self {
                $name::min_value()
            }
            #[inline]
            fn max_bound() -> Self {
                $name::max_value()
            }
            #[inline]
            fn is_normalized(&self) -> bool {
                true
            }
            #[inline]
            fn normalize(self) -> Self {
                self
            }
        }
        impl color::Lerp for $name {
            type Position = f64;
            #[inline]
            fn lerp(&self, right: &Self, pos: Self::Position) -> Self {
                lerp_flat_int(self, right, pos)
            }
        }
    };
}

macro_rules! impl_bounded_channel_traits_float {
    ($name: ty) => {
        impl PosNormalChannelScalar for $name {
            #[inline]
            fn min_bound() -> Self {
                cast(0.0).unwrap()
            }
            #[inline]
            fn max_bound() -> Self {
                cast(1.0).unwrap()
            }
            #[inline]
            fn is_normalized(&self) -> bool {
                *self >= 0.0 && *self <= 1.0
            }
            #[inline]
            fn normalize(self) -> Self {
                if self > 1.0 {
                    1.0
                } else if self < 0.0 {
                    0.0
                } else {
                    self.clone()
                }
            }
        }
        impl color::Lerp for $name {
            type Position = $name;
            #[inline]
            fn lerp(&self, right: &Self, pos: Self::Position) -> Self {
                lerp_flat(self, right, pos)
            }
        }
    };
}

macro_rules! impl_normal_bounded_channel_traits_int {
    ($name: ident) => {
        impl NormalChannelScalar for $name {
            #[inline]
            fn min_bound() -> Self {
                $name::min_value()
            }
            #[inline]
            fn max_bound() -> Self {
                $name::max_value()
            }
            #[inline]
            fn is_normalized(&self) -> bool {
                true
            }
            #[inline]
            fn normalize(self) -> Self {
                self
            }
        }
    };
}

macro_rules! impl_normal_bounded_channel_traits_float {
    ($name: ty) => {
        impl NormalChannelScalar for $name {
            #[inline]
            fn min_bound() -> Self {
                cast(-1.0).unwrap()
            }
            #[inline]
            fn max_bound() -> Self {
                cast(1.0).unwrap()
            }
            #[inline]
            fn is_normalized(&self) -> bool {
                *self >= -1.0 && *self <= 1.0
            }
            #[inline]
            fn normalize(self) -> Self {
                if self > 1.0 {
                    1.0
                } else if self < -1.0 {
                    -1.0
                } else {
                    self.clone()
                }
            }
        }
    };
}

impl_bounded_channel_traits_int!(u8);
impl_bounded_channel_traits_int!(u16);
impl_bounded_channel_traits_int!(u32);
impl_bounded_channel_traits_float!(f32);
impl_bounded_channel_traits_float!(f64);

impl_normal_bounded_channel_traits_int!(u8);
impl_normal_bounded_channel_traits_int!(u16);
impl_normal_bounded_channel_traits_int!(u32);
impl_normal_bounded_channel_traits_float!(f32);
impl_normal_bounded_channel_traits_float!(f64);