pub struct Undoer<State> { /* private fields */ }
Expand description
Automatic undo system.
Every frame you feed it the most recent state.
The Undoer
compares it with the latest undo point
and if there is a change it may create a new undo point.
Undoer
follows two simple rules:
- If the state has changed since the latest undo point, but has
remained stable for
stable_time
seconds, an new undo point is created. - If the state does not stabilize within
auto_save_interval
seconds, an undo point is created.
Rule 1) will make sure an undo point is not created until you stop dragging that slider. Rule 2) will make sure that you will get some undo points even if you are constantly changing the state.
Implementations
sourceimpl<State> Undoer<State> where
State: Clone + PartialEq,
impl<State> Undoer<State> where
State: Clone + PartialEq,
sourcepub fn has_undo(&self, current_state: &State) -> bool
pub fn has_undo(&self, current_state: &State) -> bool
Do we have an undo point different from the given state?
sourcepub fn is_in_flux(&self) -> bool
pub fn is_in_flux(&self) -> bool
Return true if the state is currently changing
pub fn undo(&mut self, current_state: &State) -> Option<&State>
sourcepub fn add_undo(&mut self, current_state: &State)
pub fn add_undo(&mut self, current_state: &State)
Add an undo point if, and only if, there has been a change since the latest undo point.
time
: current time in seconds.
sourcepub fn feed_state(&mut self, current_time: f64, current_state: &State)
pub fn feed_state(&mut self, current_time: f64, current_state: &State)
Call this as often as you want (e.g. every frame)
and Undoer
will determine if a new undo point should be created.
current_time
: current time in seconds.
Trait Implementations
sourceimpl<'de, State> Deserialize<'de> for Undoer<State> where
State: Deserialize<'de>,
State: Default,
impl<'de, State> Deserialize<'de> for Undoer<State> where
State: Deserialize<'de>,
State: Default,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl<State> RefUnwindSafe for Undoer<State> where
State: RefUnwindSafe,
impl<State> Send for Undoer<State> where
State: Send,
impl<State> Sync for Undoer<State> where
State: Sync,
impl<State> Unpin for Undoer<State> where
State: Unpin,
impl<State> UnwindSafe for Undoer<State> where
State: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more