Struct crystalorb::timestamp::FloatTimestamp

pub struct FloatTimestamp(_);

Representation of time in the same units as Timestamp, but whereas Timestamp identifies which whole number of frames only, FloatTimestamp can represent any time in the continuous region between two adjacent frames.

Implementations

impl FloatTimestamp

pub fn from_seconds(seconds: f64, timestep_seconds: f64) -> Self

Convert the time from seconds into Timestamp units (1 per frame, i.e. 1 per timestep), and fit it into the Timestamp space.

pub fn from_unwrapped(frames: f64) -> Self

Fit the time in Timestamp units into the Timestamp space by wrapping.

pub fn as_seconds(self, timestep_seconds: f64) -> f64

Find the corresponding time in seconds for this float timestamp. Since timestamps repeat over time, this function returns the time closest to zero. This makes it useful to find the number of seconds between two float timestamps.

Example

use crystalorb::timestamp::FloatTimestamp;
use float_cmp::approx_eq;
const TIMESTEP: f64 = 1.0 / 60.0;

// Given two float timestamps.
let t1 = FloatTimestamp::from_unwrapped(123.2);
let t2 = FloatTimestamp::from_unwrapped(123.7);

// We can get the seconds between these two float timestamps.
let seconds_difference = (t2 - t1).as_seconds(TIMESTEP);
assert!(approx_eq!(f64, seconds_difference, 0.5 / 60.0, ulps=1));

pub fn ceil(self) -> Timestamp

Round up to the next whole-number Timestamp (or its own value if it is already a whole number).

Example

use crystalorb::timestamp::{FloatTimestamp, Timestamp};

let t1 = FloatTimestamp::from_unwrapped(123.4);
let t2 = FloatTimestamp::from_unwrapped(123.0);

assert_eq!(t1.ceil(), Timestamp::default() + 124);
assert_eq!(t2.ceil(), Timestamp::default() + 123);

pub fn floor(self) -> Timestamp

Round down to the previous whole-number Timestamp (or its own value if it is already a whole number).

Example

use crystalorb::timestamp::{FloatTimestamp, Timestamp};

let t1 = FloatTimestamp::from_unwrapped(123.4);
let t2 = FloatTimestamp::from_unwrapped(123.0);

assert_eq!(t1.floor(), Timestamp::default() + 123);
assert_eq!(t2.floor(), Timestamp::default() + 123);

Trait Implementations

impl Clone for FloatTimestamp

fn clone(&self) -> FloatTimestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FloatTimestamp

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FloatTimestamp

fn default() -> FloatTimestamp

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FloatTimestamp

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<FloatTimestamp> for Timestamp

fn from(float_timestamp: FloatTimestamp) -> Self

Performs the conversion.

impl From<Timestamp> for FloatTimestamp

fn from(timestamp: Timestamp) -> FloatTimestamp

Performs the conversion.

impl PartialEq<FloatTimestamp> for FloatTimestamp

fn eq(&self, other: &FloatTimestamp) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FloatTimestamp) -> bool

This method tests for !=.

impl Serialize for FloatTimestamp

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Sub<FloatTimestamp> for FloatTimestamp

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Copy for FloatTimestamp

impl StructuralPartialEq for FloatTimestamp