Struct re_viewer_context::TimeControl

pub struct TimeControl {
    last_frame: LastFrame,
    timeline: ActiveTimeline,
    states: BTreeMap<Timeline, TimeStateEntry>,
    playing: bool,
    following: bool,
    speed: f32,
    looping: Looping,
    pub highlighted_range: Option<ResolvedTimeRange>,
}

Controls the global view and progress of the time.

Fields

last_frame: LastFrame

timeline: ActiveTimeline

Name of the timeline (e.g. log_time).

states: BTreeMap<Timeline, TimeStateEntry>

playing: bool

If true, we are either in PlayState::Playing or PlayState::Following.

following: bool

If true, we are in “follow” mode (see PlayState::Following). Ignored when [Self.playing] is false.

speed: f32

looping: Looping

highlighted_range: Option<ResolvedTimeRange>

Range with special highlight.

This is used during UI interactions. E.g. to show visual history range that’s highlighted.

Implementations

impl TimeControl

pub fn update( &mut self, times_per_timeline: &TimesPerTimeline, stable_dt: f32, more_data_is_coming: bool, callbacks: Option<&TimelineCallbacks>, ) -> NeedsRepaint

Move the time forward (if playing), and perhaps pause if we’ve reached the end.

pub fn handle_callbacks(&mut self, callbacks: &TimelineCallbacks)

Handle updating last frame state and trigger callbacks on changes.

pub fn play_state(&self) -> PlayState

pub fn looping(&self) -> Looping

pub fn set_looping(&mut self, looping: Looping)

pub fn set_play_state( &mut self, times_per_timeline: &TimesPerTimeline, play_state: PlayState, )

pub fn pause(&mut self)

pub fn step_time_back(&mut self, times_per_timeline: &TimesPerTimeline)

pub fn step_time_fwd(&mut self, times_per_timeline: &TimesPerTimeline)

pub fn restart(&mut self, times_per_timeline: &TimesPerTimeline)

pub fn toggle_play_pause(&mut self, times_per_timeline: &TimesPerTimeline)

pub fn speed(&self) -> f32

playback speed

pub fn set_speed(&mut self, speed: f32)

playback speed

pub fn fps(&self) -> Option<f32>

playback fps

pub fn set_fps(&mut self, fps: f32)

playback fps

pub fn select_a_valid_timeline(&mut self, times_per_timeline: &TimesPerTimeline)

Make sure the selected timeline is a valid one

pub fn timeline(&self) -> &Timeline

The currently selected timeline

pub fn time_type(&self) -> TimeType

The time type of the currently selected timeline

pub fn set_timeline(&mut self, timeline: Timeline)

pub fn time(&self) -> Option<TimeReal>

The current time.

pub fn time_int(&self) -> Option<TimeInt>

The current time.

pub fn time_i64(&self) -> Option<i64>

The current time.

pub fn current_query(&self) -> LatestAtQuery

Query for latest value at the currently selected time on the currently selected timeline.

pub fn active_loop_selection(&self) -> Option<ResolvedTimeRangeF>

The current loop range, iff selection looping is turned on.

pub fn full_range( &self, times_per_timeline: &TimesPerTimeline, ) -> Option<ResolvedTimeRange>

The full range of times for the current timeline

pub fn loop_selection(&self) -> Option<ResolvedTimeRangeF>

The selected slice of time that is called the “loop selection”.

This can still return Some even if looping is currently off.

pub fn set_loop_selection(&mut self, selection: ResolvedTimeRangeF)

Set the current loop selection without enabling looping.

pub fn remove_loop_selection(&mut self)

Remove the current loop selection.

pub fn is_time_selected(&self, timeline: &Timeline, needle: TimeInt) -> bool

Is the current time in the selection range (if any), or at the current time mark?

pub fn set_timeline_and_time( &mut self, timeline: Timeline, time: impl Into<TimeReal>, )

pub fn time_for_timeline(&self, timeline: Timeline) -> Option<TimeReal>

pub fn set_time_for_timeline( &mut self, timeline: Timeline, time: impl Into<TimeReal>, )

pub fn set_time(&mut self, time: impl Into<TimeReal>)

pub fn time_view(&self) -> Option<TimeView>

The range of time we are currently zoomed in on.

pub fn set_time_view(&mut self, view: TimeView)

The range of time we are currently zoomed in on.

pub fn reset_time_view(&mut self)

The range of time we are currently zoomed in on.

Trait Implementations

impl Clone for TimeControl

fn clone(&self) -> TimeControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TimeControl

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeControl

where TimeControl: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TimeControl

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TimeControl

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TimeControl