Karana.KUtils.MultibodyTUI.history

Attributes

State

Classes

StateHistory

Container for a state object with undo and redo capabilities

Module Contents

Karana.KUtils.MultibodyTUI.history.State

class Karana.KUtils.MultibodyTUI.history.StateHistory(init_state: State)

Bases: Generic[State]

Container for a state object with undo and redo capabilities

property state: State

The current state

push(state: State)

Set a new state

property current_state_count: int

The number of states in the undo stack

Note that this includes the current state and is always positive.

property total_state_count: int

The number of states - past, present, and future

This is similar to past_state_count but also includes states in the redo stack.

undo_stack_size() → int

The number of states in the undo stack

Note that this includes the current state and is always positive

can_undo() → bool

Return whether an undo state is available

undo()

Return to the previous state

can_redo() → bool

Return whether a redo state is available

redo()

Return to the next state (ie: undo a previous undo)