Struct ClockHandle 

pub struct ClockHandle { /* private fields */ }

Controls a clock.

When a ClockHandle is dropped, the corresponding clock will be removed.

Implementations

impl ClockHandle

pub fn id(&self) -> ClockId

Returns the unique identifier for the clock.

pub fn ticking(&self) -> bool

Returns true if the clock is currently ticking and false if not.

pub fn time(&self) -> ClockTime

Returns the current time of the clock.

pub fn fractional_position(&self) -> f64

Returns the time between ticks (from 0.0 to 1.0) of the clock.

A time of 0.5 is halfway between two ticks.

pub fn set_speed( &self, speed: impl Into<Value<ClockSpeed>>, tween: Tween, ) -> Result<(), CommandError>

Sets the speed of the clock.

pub fn start(&self) -> Result<(), CommandError>

Starts or resumes the clock.

pub fn pause(&self) -> Result<(), CommandError>

Pauses the clock.

pub fn stop(&self) -> Result<(), CommandError>

Stops and resets the clock.

Trait Implementations

impl Drop for ClockHandle

fn drop(&mut self)

Executes the destructor for this type.

impl From<&ClockHandle> for ClockId

fn from(handle: &ClockHandle) -> ClockId

Converts to this type from the input type.