oxygengine-ha-renderer 0.46.1

Hardware Accelerated renderer module for Oxygengine
Documentation
use crate::{components::transform::HaTransform, math::*};
use animation::phase::Phase;
use core::{
    assets::protocol::{AssetLoadResult, AssetProtocol},
    scripting::{intuicio::data::managed::DynamicManaged, ScriptingValue},
    Scalar,
};
use serde::{Deserialize, Serialize};
use std::{collections::HashMap, ops::Range, str::from_utf8};

fn default_speed() -> Scalar {
    1.0
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum RigAnimationCondition {
    Not(Box<Self>),
    And(Vec<Self>),
    Or(Vec<Self>),
    Bool(bool),
    IntegerEquals(i32),
    IntegerGreater(i32),
    IntegerLess(i32),
    /// (from inclusive, to inclusive)
    IntegerRange(i32, i32),
    /// (value, threshold)
    ScalarNearlyEquals(Scalar, Scalar),
    ScalarGreater(Scalar),
    ScalarLess(Scalar),
    /// (from inclusive, to inclusive)
    ScalarRange(Scalar, Scalar),
    StringEquals(String),
    StringContains(String),
    StringTagged {
        tag: String,
        separator: String,
    },
}

impl RigAnimationCondition {
    pub fn validate(&self, value: &DynamicManaged) -> bool {
        match self {
            RigAnimationCondition::Not(c) => {
                return !c.validate(value);
            }
            RigAnimationCondition::And(c) => {
                return c.iter().all(|c| c.validate(value));
            }
            RigAnimationCondition::Or(c) => {
                return c.iter().any(|c| c.validate(value));
            }
            RigAnimationCondition::Bool(c) => {
                if let Some(v) = value.read::<bool>() {
                    return *v == *c;
                }
            }
            RigAnimationCondition::IntegerEquals(c) => {
                if let Some(v) = value.read::<i32>() {
                    return *v == *c;
                }
            }
            RigAnimationCondition::IntegerGreater(c) => {
                if let Some(v) = value.read::<i32>() {
                    return *v > *c;
                }
            }
            RigAnimationCondition::IntegerLess(c) => {
                if let Some(v) = value.read::<i32>() {
                    return *v < *c;
                }
            }
            RigAnimationCondition::IntegerRange(a, b) => {
                if let Some(v) = value.read::<i32>() {
                    return *v >= *a && *v <= *b;
                }
            }
            RigAnimationCondition::ScalarNearlyEquals(c, t) => {
                if let Some(v) = value.read::<Scalar>() {
                    return (*c - *v).abs() < *t;
                }
            }
            RigAnimationCondition::ScalarGreater(c) => {
                if let Some(v) = value.read::<Scalar>() {
                    return *v > *c;
                }
            }
            RigAnimationCondition::ScalarLess(c) => {
                if let Some(v) = value.read::<Scalar>() {
                    return *v < *c;
                }
            }
            RigAnimationCondition::ScalarRange(a, b) => {
                if let Some(v) = value.read::<Scalar>() {
                    return *v >= *a && *v <= *b;
                }
            }
            RigAnimationCondition::StringEquals(c) => {
                if let Some(v) = value.read::<String>() {
                    return *v == *c;
                }
            }
            RigAnimationCondition::StringContains(c) => {
                if let Some(v) = value.read::<String>() {
                    return v.contains(c);
                }
            }
            RigAnimationCondition::StringTagged { tag, separator } => {
                if let Some(v) = value.read::<String>() {
                    return v.split(separator).any(|part| part == tag);
                }
            }
        }
        false
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RigAnimationBlendState {
    pub target_state: String,
    pub axis_values: Vec<Scalar>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum RigAnimationRule {
    Single {
        target_state: String,
        #[serde(default)]
        conditions: HashMap<String, RigAnimationCondition>,
        #[serde(default)]
        change_time: Scalar,
    },
    BlendSpace {
        axis_scalars: Vec<String>,
        blend_states: Vec<RigAnimationBlendState>,
        #[serde(default)]
        conditions: HashMap<String, RigAnimationCondition>,
        #[serde(default)]
        change_time: Scalar,
    },
}

#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct RigAnimationSignal {
    pub time: Scalar,
    pub id: String,
    #[serde(default)]
    pub params: HashMap<String, ScriptingValue>,
}

#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct RigAnimationSequenceBoneSheet {
    #[serde(default)]
    pub translation_x: Option<Phase>,
    #[serde(default)]
    pub translation_y: Option<Phase>,
    #[serde(default)]
    pub translation_z: Option<Phase>,
    #[serde(default)]
    pub rotation_yaw: Option<Phase>,
    #[serde(default)]
    pub rotation_pitch: Option<Phase>,
    #[serde(default)]
    pub rotation_roll: Option<Phase>,
    #[serde(default)]
    pub scale_x: Option<Phase>,
    #[serde(default)]
    pub scale_y: Option<Phase>,
    #[serde(default)]
    pub scale_z: Option<Phase>,
}

impl RigAnimationSequenceBoneSheet {
    pub fn time_frame(&self) -> Option<Range<Scalar>> {
        let mut result = None;
        Self::accumulate_time_frame(&self.translation_x, &mut result);
        Self::accumulate_time_frame(&self.translation_y, &mut result);
        Self::accumulate_time_frame(&self.translation_z, &mut result);
        Self::accumulate_time_frame(&self.rotation_yaw, &mut result);
        Self::accumulate_time_frame(&self.rotation_pitch, &mut result);
        Self::accumulate_time_frame(&self.rotation_roll, &mut result);
        Self::accumulate_time_frame(&self.scale_x, &mut result);
        Self::accumulate_time_frame(&self.scale_y, &mut result);
        Self::accumulate_time_frame(&self.scale_z, &mut result);
        result
    }

    pub fn sample(&self, time: Scalar, fallback: &HaTransform) -> HaTransform {
        HaTransform::new(
            vec3(
                self.translation_x
                    .as_ref()
                    .map(|phase| phase.sample(time))
                    .unwrap_or_else(|| fallback.get_translation().x),
                self.translation_y
                    .as_ref()
                    .map(|phase| phase.sample(time))
                    .unwrap_or_else(|| fallback.get_translation().y),
                self.translation_z
                    .as_ref()
                    .map(|phase| phase.sample(time))
                    .unwrap_or_else(|| fallback.get_translation().z),
            ),
            Eulers {
                yaw: self
                    .rotation_yaw
                    .as_ref()
                    .map(|phase| phase.sample(time))
                    .unwrap_or_else(|| fallback.get_rotation().eulers().yaw),
                pitch: self
                    .rotation_pitch
                    .as_ref()
                    .map(|phase| phase.sample(time))
                    .unwrap_or_else(|| fallback.get_rotation().eulers().pitch),
                roll: self
                    .rotation_roll
                    .as_ref()
                    .map(|phase| phase.sample(time))
                    .unwrap_or_else(|| fallback.get_rotation().eulers().roll),
            },
            vec3(
                self.scale_x
                    .as_ref()
                    .map(|phase| phase.sample(time))
                    .unwrap_or_else(|| fallback.get_scale().x),
                self.scale_y
                    .as_ref()
                    .map(|phase| phase.sample(time))
                    .unwrap_or_else(|| fallback.get_scale().y),
                self.scale_z
                    .as_ref()
                    .map(|phase| phase.sample(time))
                    .unwrap_or_else(|| fallback.get_scale().z),
            ),
        )
    }

    fn accumulate_time_frame(input: &Option<Phase>, output: &mut Option<Range<Scalar>>) {
        if let Some(phase) = input {
            let time_frame = phase.time_frame();
            if let Some(output) = output.as_mut() {
                output.start = output.start.min(time_frame.start);
                output.end = output.end.min(time_frame.end);
            } else {
                *output = Some(time_frame);
            }
        }
    }
}

#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct RigAnimationSequence {
    #[serde(default = "default_speed")]
    pub speed: Scalar,
    #[serde(default)]
    pub looping: bool,
    #[serde(default)]
    pub bounce: bool,
    #[serde(default)]
    pub bone_sheets: HashMap<String, RigAnimationSequenceBoneSheet>,
    #[serde(default)]
    pub signals: Vec<RigAnimationSignal>,
}

impl RigAnimationSequence {
    pub fn time_frame(&self) -> Option<Range<Scalar>> {
        self.bone_sheets
            .values()
            .fold(None, |a, v| match (a, v.time_frame()) {
                (None, None) => None,
                (Some(a), None) => Some(a),
                (Some(a), Some(v)) => Some(a.start.min(v.start)..a.end.max(v.end)),
                (None, Some(v)) => Some(v),
            })
    }

    pub fn sample_bone(&self, name: &str, time: Scalar, fallback: &HaTransform) -> HaTransform {
        self.bone_sheets
            .get(name)
            .map(|sheet| sheet.sample(time, fallback))
            .unwrap_or_else(|| fallback.to_owned())
    }
}

#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct RigAnimationBlendSpace {
    pub sequence: String,
    pub axis_values: Vec<Scalar>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum RigAnimationStateSequences {
    Single(String),
    BlendSpace {
        axis_scalars: Vec<String>,
        sequences: Vec<RigAnimationBlendSpace>,
    },
}

impl Default for RigAnimationStateSequences {
    fn default() -> Self {
        Self::Single(Default::default())
    }
}

#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct RigAnimationState {
    pub sequences: RigAnimationStateSequences,
    #[serde(default)]
    pub rules: Vec<RigAnimationRule>,
}

#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct RigAnimationAsset {
    #[serde(default)]
    pub default_state: Option<String>,
    #[serde(default = "default_speed")]
    pub speed: Scalar,
    #[serde(default)]
    pub sequences: HashMap<String, RigAnimationSequence>,
    #[serde(default)]
    pub states: HashMap<String, RigAnimationState>,
    #[serde(default)]
    pub rules: Vec<RigAnimationRule>,
}

pub struct RigAnimationAssetProtocol;

impl AssetProtocol for RigAnimationAssetProtocol {
    fn name(&self) -> &str {
        "riganim"
    }

    fn on_load_with_path(&mut self, path: &str, data: Vec<u8>) -> AssetLoadResult {
        let data = if path.ends_with(".json") {
            let data = from_utf8(&data).unwrap();
            serde_json::from_str::<RigAnimationAsset>(data).unwrap()
        } else {
            bincode::deserialize::<RigAnimationAsset>(&data).unwrap()
        };
        AssetLoadResult::Data(Box::new(data))
    }

    // on_load_with_path() handles loading so this is not needed, so we just make it unreachable.
    fn on_load(&mut self, _data: Vec<u8>) -> AssetLoadResult {
        unreachable!()
    }
}