bonsai-bt 0.11.0

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// Update arguments, such as delta time in seconds.
/// To move the behavior tree forward in time it must be ticked on each iteration of the
/// game/application loop.
///
/// dt: states how much forward in time we should move the behavior tree
#[derive(Copy, Clone, PartialEq, PartialOrd, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct UpdateArgs {
    /// Delta time in seconds.
    pub dt: Float,
}

impl UpdateArgs {
    /// Creates [UpdateArgs] with `0.0` delta time.
    pub fn zero_dt() -> UpdateArgs {
        Self { dt: 0.0 }
    }
}

/// Models loop events.
#[derive(Copy, Clone, Debug, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Loop {
    /// Update the state of the application.
    Update(UpdateArgs),
}

impl From<UpdateArgs> for Event {
    fn from(args: UpdateArgs) -> Self {
        Event::Loop(Loop::Update(args))
    }
}

/// Models all events.
#[derive(Clone)]
pub enum Event {
    /// Input events.
    ///
    /// Events that commonly used by event loops.
    Loop(Loop),
}
impl Event {
    /// Creates [Event] from [UpdateArgs] with `0.0` delta time.
    pub fn zero_dt_args() -> Self {
        UpdateArgs::zero_dt().into()
    }
}

/// When the application state should be updated.
pub trait UpdateEvent: Sized {
    /// Creates an update event.
    fn from_update_args(args: &UpdateArgs, old_event: &Self) -> Option<Self>;
    /// Creates an update event with delta time.
    fn from_dt(dt: Float, old_event: &Self) -> Option<Self> {
        UpdateEvent::from_update_args(&UpdateArgs { dt }, old_event)
    }
    /// Calls closure if this is an update event.
    fn update<U, F>(&self, f: F) -> Option<U>
    where
        F: FnMut(&UpdateArgs) -> U;
    /// Returns update arguments.
    fn update_args(&self) -> Option<UpdateArgs> {
        self.update(|args| *args)
    }
}

impl UpdateEvent for Event {
    fn from_update_args(args: &UpdateArgs, _old_event: &Self) -> Option<Self> {
        Some(Event::Loop(Loop::Update(*args)))
    }

    fn update<U, F>(&self, mut f: F) -> Option<U>
    where
        F: FnMut(&UpdateArgs) -> U,
    {
        match *self {
            Event::Loop(Loop::Update(ref args)) => Some(f(args)),
        }
    }
}

use std::time::Instant;

use crate::Float;

/// A monotonic clock/timer that can be used to keep track
/// of the time increments (delta time) between tick/tree traversals
/// and the total duration since the behavior tree was first invoked/traversed
#[derive(Debug, Clone)]
pub struct Timer {
    start: Instant,
    now: Instant,
}

impl Timer {
    /// Initialize monotonic clock
    pub fn init_time() -> Timer {
        let init = Instant::now();
        Timer { start: init, now: init }
    }

    /// Compute duration since timer started
    pub fn duration_since_start(&self) -> Float {
        let new_now: Instant = Instant::now();
        let duration = new_now.duration_since(self.start);
        #[cfg(feature = "f32")]
        return duration.as_secs_f32();
        #[cfg(not(feature = "f32"))]
        return duration.as_secs_f64();
    }

    /// Compute time difference last invocation of `get_dt()` function
    pub fn get_dt(&mut self) -> Float {
        let new_now: Instant = Instant::now();
        let duration = new_now.duration_since(self.now);
        self.now = new_now;
        #[cfg(feature = "f32")]
        return duration.as_secs_f32();
        #[cfg(not(feature = "f32"))]
        return duration.as_secs_f64();
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::thread::sleep;
    use std::time::Duration;

    #[test]
    fn test_update_args() {
        use Event;
        use UpdateArgs;

        let e: Event = UpdateArgs { dt: 0.0 }.into();
        let _: Option<Event> = UpdateEvent::from_update_args(&UpdateArgs { dt: 1.0 }, &e);
    }

    #[test]
    fn test_timer() {
        let mut timer = Timer::init_time();
        sleep(Duration::new(0, 0.1e+9 as u32));
        let duration = timer.duration_since_start();
        let dt = timer.get_dt();

        assert!(duration < 1.0);
        assert!(dt < 0.2);
        assert!(dt >= 0.1);

        sleep(Duration::new(0, 0.3e+9 as u32));
        let duration = timer.duration_since_start();
        let dt = timer.get_dt();

        assert!(duration < 1.0);
        assert!(duration > 0.3);
        assert!(dt > 0.2);
        assert!(dt < 0.4);
    }
}