UndoStep Struct Reference

#include <BKE_undo_system.hh>

Public Attributes
UndoStep *	next
UndoStep *	prev
char	name [64]
const UndoType *	type
size_t	data_size
bool	skip
bool	use_memfile_step
bool	use_old_bmain_data
bool	is_applied

Detailed Description

Definition at line 72 of file BKE_undo_system.hh.

Member Data Documentation

data_size

size_t UndoStep::data_size

Size in bytes of all data in step (not including the step).

Definition at line 77 of file BKE_undo_system.hh.

Referenced by armature_undosys_step_encode(), BKE_undosys_stack_limit_steps_and_memory(), curve_undosys_step_encode(), font_undosys_step_encode(), image_undosys_step_encode(), lattice_undosys_step_encode(), mball_undosys_step_encode(), memfile_undosys_step_encode(), mesh_undosys_step_encode(), paintcurve_undosys_step_encode(), blender::ed::sculpt_paint::undo::step_encode(), text_undosys_step_encode(), and text_undosys_step_encode_init().

is_applied

bool UndoStep::is_applied

For use by undo systems that accumulate changes (mesh-sculpt & image-painting).

Definition at line 86 of file BKE_undo_system.hh.

Referenced by image_undosys_step_decode_redo(), image_undosys_step_decode_redo_impl(), image_undosys_step_decode_undo(), image_undosys_step_decode_undo_impl(), image_undosys_step_encode(), blender::ed::sculpt_paint::undo::step_decode_redo(), blender::ed::sculpt_paint::undo::step_decode_redo_impl(), blender::ed::sculpt_paint::undo::step_decode_undo(), blender::ed::sculpt_paint::undo::step_decode_undo_impl(), blender::ed::sculpt_paint::undo::step_encode(), and text_undosys_step_encode().

name

char UndoStep::name[64]

Definition at line 74 of file BKE_undo_system.hh.

Referenced by armature_undosys_step_decode(), BKE_undosys_step_load_data_ex(), BKE_undosys_step_push_init_with_type(), BKE_undosys_step_push_with_type(), curve_undosys_step_decode(), ED_undo_grouped_push(), font_undosys_step_decode(), lattice_undosys_step_decode(), mball_undosys_step_decode(), mesh_undosys_step_decode(), particle_undosys_step_decode(), blender::ed::curves::undo::step_decode(), blender::ed::greasepencil::undo::step_decode(), undosys_step_decode(), undosys_step_encode(), and undosys_step_free_and_unlink().

next

UndoStep* UndoStep::next

Definition at line 73 of file BKE_undo_system.hh.

Referenced by BKE_undosys_step_calc_direction(), BKE_undosys_step_load_data_ex(), BKE_undosys_step_push_init_with_type(), BKE_undosys_step_redo(), BKE_undosys_step_same_type_next(), ED_undo_push(), image_undosys_step_decode_redo(), image_undosys_step_decode_undo(), memfile_undosys_step_decode(), memfile_undosys_step_free(), blender::ed::sculpt_paint::undo::step_decode_redo(), blender::ed::sculpt_paint::undo::step_decode_undo(), undosys_stack_clear_all_first(), and undosys_step_iter_first().

prev

UndoStep * UndoStep::prev

Definition at line 73 of file BKE_undo_system.hh.

Referenced by BKE_undosys_stack_active_with_type(), BKE_undosys_stack_clear_active(), BKE_undosys_stack_has_undo(), BKE_undosys_stack_limit_steps_and_memory(), BKE_undosys_step_calc_direction(), BKE_undosys_step_load_data_ex(), BKE_undosys_step_redo_with_data_ex(), BKE_undosys_step_same_type_prev(), BKE_undosys_step_undo(), ED_image_undo_push_begin_with_image(), ed_undo_step_by_name(), image_undosys_step_decode_redo(), image_undosys_step_decode_undo(), image_undosys_step_encode(), memfile_undosys_step_decode(), blender::ed::sculpt_paint::undo::step_decode_redo(), blender::ed::sculpt_paint::undo::step_decode_undo(), undo_history_draw_menu(), undosys_stack_clear_all_first(), undosys_step_decode(), and undosys_step_iter_first().

skip

bool UndoStep::skip

Users should never see this step (only use for internal consistency).

Definition at line 79 of file BKE_undo_system.hh.

Referenced by BKE_undosys_stack_group_end(), BKE_undosys_stack_limit_steps_and_memory(), BKE_undosys_step_load_data_ex(), BKE_undosys_step_load_from_index(), BKE_undosys_step_push_with_type(), and ED_undo_is_state_valid().

type

const UndoType* UndoStep::type

Definition at line 75 of file BKE_undo_system.hh.

Referenced by BKE_undosys_stack_active_with_type(), BKE_undosys_stack_init_or_active_with_type(), BKE_undosys_stack_limit_steps_and_memory(), BKE_undosys_step_load_data_ex(), BKE_undosys_step_push(), BKE_undosys_step_push_init_with_type(), BKE_undosys_step_push_with_type(), BKE_undosys_step_same_type_next(), BKE_undosys_step_same_type_prev(), ED_image_undo_push_begin_with_image(), ED_undosys_stack_memfile_get_if_active(), ED_undosys_stack_memfile_id_changed_tag(), image_undosys_step_decode_redo(), image_undosys_step_decode_undo(), image_undosys_step_encode(), blender::ed::sculpt_paint::undo::step_decode_redo(), blender::ed::sculpt_paint::undo::step_decode_undo(), text_undosys_poll(), text_undosys_step_encode_init(), undosys_step_decode(), undosys_step_encode(), undosys_step_free_and_unlink(), and undosys_step_iter_first().

use_memfile_step

bool UndoStep::use_memfile_step

Some situations require the global state to be stored, edge cases when exiting modes.

Definition at line 81 of file BKE_undo_system.hh.

Referenced by BKE_undosys_step_push_with_type(), and blender::ed::sculpt_paint::undo::step_encode().

use_old_bmain_data

bool UndoStep::use_old_bmain_data

When this is true, undo/memfile read code is allowed to re-use old data-blocks for unchanged IDs, and existing depsgraphs. This has to be forbidden in some cases (like renamed IDs).

Definition at line 84 of file BKE_undo_system.hh.

Referenced by BKE_undosys_step_push_with_type(), memfile_undosys_step_decode(), and memfile_undosys_step_encode().

---

The documentation for this struct was generated from the following file:

• BKE_undo_system.hh