|
Blender V5.3
|
#include <BKE_undo_system.hh>
Public Attributes | |
| UndoType * | next |
| UndoType * | prev |
| const char * | identifier |
| bool(*) | poll (bContext *C) |
| void(*) | step_encode_init (bContext *C, UndoStep *us) |
| bool(*) | step_encode (bContext *C, Main *bmain, UndoStep *us) |
| void(*) | step_decode (bContext *C, Main *bmain, UndoStep *us, eUndoStepDir dir, bool is_final) |
| void(*) | step_free (UndoStep *us) |
| void(*) | step_foreach_ID_ref (UndoStep *us, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data) |
| uint | flags |
| size_t | step_size |
Definition at line 138 of file BKE_undo_system.hh.
| uint blender::UndoType::flags |
Information for the generic undo system to refine handling of this specific undo type.
Definition at line 193 of file BKE_undo_system.hh.
Referenced by blender::BKE_undosys_step_push_with_type(), blender::ED_armature_undosys_type(), blender::ED_curve_undosys_type(), blender::ED_font_undosys_type(), blender::ED_image_undosys_type(), blender::ED_lattice_undosys_type(), blender::ED_mball_undosys_type(), blender::ED_memfile_undosys_type(), blender::ED_mesh_undosys_type(), blender::ED_paintcurve_undosys_type(), blender::ED_particle_undosys_type(), blender::ED_text_undosys_type(), blender::ED_undosys_type_grease_pencil(), blender::ed::sculpt_paint::undo::register_type(), blender::undo_encode_hints_from_context(), blender::undosys_step_iter_first(), blender::ed::curves::undosys_type_register(), and blender::ed::pointcloud::undosys_type_register().
| const char* blender::UndoType::identifier |
Identifier for the undo type, also exposed as the RNA enum identifier. Use upper-case with underscore separated words (e.g. "EDIT_ARMATURE").
Definition at line 144 of file BKE_undo_system.hh.
Referenced by blender::BKE_undosys_print(), blender::BKE_undosys_step_load_data_ex(), blender::BKE_undosys_step_push_init_with_type(), blender::BKE_undosys_step_push_with_type(), blender::ED_armature_undosys_type(), blender::ED_curve_undosys_type(), blender::ED_font_undosys_type(), blender::ED_image_undosys_type(), blender::ED_lattice_undosys_type(), blender::ED_mball_undosys_type(), blender::ED_memfile_undosys_type(), blender::ED_mesh_undosys_type(), blender::ED_paintcurve_undosys_type(), blender::ED_particle_undosys_type(), blender::ED_text_undosys_type(), blender::ED_undosys_type_grease_pencil(), blender::ed::sculpt_paint::undo::register_type(), blender::undosys_step_decode(), blender::undosys_step_encode(), blender::undosys_step_free_and_unlink(), blender::ed::curves::undosys_type_register(), and blender::ed::pointcloud::undosys_type_register().
| UndoType* blender::UndoType::next |
Definition at line 139 of file BKE_undo_system.hh.
When undefined, we don't consider this undo type for context checks. Operators must explicitly set the undo type and handle adding the undo step. This is needed when tools operate on data which isn't the primary mode (eg, paint-curve in sculpt mode).
Definition at line 152 of file BKE_undo_system.hh.
Referenced by blender::ED_armature_undosys_type(), blender::ED_curve_undosys_type(), blender::ED_font_undosys_type(), blender::ED_lattice_undosys_type(), blender::ED_mball_undosys_type(), blender::ED_memfile_undosys_type(), blender::ED_mesh_undosys_type(), blender::ED_paintcurve_undosys_type(), blender::ED_particle_undosys_type(), blender::ED_text_undosys_type(), blender::ED_undosys_type_grease_pencil(), blender::ed::sculpt_paint::undo::register_type(), blender::ed::curves::undosys_type_register(), and blender::ed::pointcloud::undosys_type_register().
| UndoType * blender::UndoType::prev |
Definition at line 139 of file BKE_undo_system.hh.
| void(*) blender::UndoType::step_decode(bContext *C, Main *bmain, UndoStep *us, eUndoStepDir dir, bool is_final) |
| is_final | whether the step being decoded is the target undo step being restored. |
Definition at line 167 of file BKE_undo_system.hh.
Referenced by blender::ED_armature_undosys_type(), blender::ED_curve_undosys_type(), blender::ED_font_undosys_type(), blender::ED_image_undosys_type(), blender::ED_lattice_undosys_type(), blender::ED_mball_undosys_type(), blender::ED_memfile_undosys_type(), blender::ED_mesh_undosys_type(), blender::ED_paintcurve_undosys_type(), blender::ED_particle_undosys_type(), blender::ED_text_undosys_type(), blender::ED_undosys_type_grease_pencil(), blender::ed::sculpt_paint::undo::register_type(), blender::undosys_step_decode(), blender::ed::curves::undosys_type_register(), and blender::ed::pointcloud::undosys_type_register().
Definition at line 162 of file BKE_undo_system.hh.
Referenced by blender::ED_armature_undosys_type(), blender::ED_curve_undosys_type(), blender::ED_font_undosys_type(), blender::ED_image_undosys_type(), blender::ED_lattice_undosys_type(), blender::ED_mball_undosys_type(), blender::ED_memfile_undosys_type(), blender::ED_mesh_undosys_type(), blender::ED_paintcurve_undosys_type(), blender::ED_particle_undosys_type(), blender::ED_text_undosys_type(), blender::ED_undosys_type_grease_pencil(), blender::ed::sculpt_paint::undo::register_type(), blender::undosys_step_encode(), blender::ed::curves::undosys_type_register(), and blender::ed::pointcloud::undosys_type_register().
None of these callbacks manage list add/removal.
Note that 'step_encode_init' is optional, some undo types need to perform operations before undo push finishes.
Definition at line 160 of file BKE_undo_system.hh.
Referenced by blender::BKE_undosys_step_push_init_with_type(), blender::ED_image_undosys_type(), blender::ED_paintcurve_undosys_type(), blender::ED_text_undosys_type(), and blender::ed::sculpt_paint::undo::register_type().
| void(*) blender::UndoType::step_foreach_ID_ref(UndoStep *us, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data) |
This callback ensures data-block (ID) references are valid before use.
Some undo systems need to reference data-blocks, however these pointers are not stable and may have changed when restoring the undo-step (when the data-block creation was undone, then redone, for example)
To support this use case, this callback supports a generic method of ensuring data-block pointers are valid before use.
Definition at line 188 of file BKE_undo_system.hh.
Referenced by blender::BKE_undosys_step_push_with_type(), blender::ED_armature_undosys_type(), blender::ED_curve_undosys_type(), blender::ED_font_undosys_type(), blender::ED_image_undosys_type(), blender::ED_lattice_undosys_type(), blender::ED_mball_undosys_type(), blender::ED_mesh_undosys_type(), blender::ED_paintcurve_undosys_type(), blender::ED_particle_undosys_type(), blender::ED_text_undosys_type(), blender::ED_undosys_type_grease_pencil(), blender::undosys_step_decode(), blender::undosys_step_encode(), blender::ed::curves::undosys_type_register(), blender::ed::pointcloud::undosys_type_register(), and blender::UNUSED_FUNCTION().
| void(*) blender::UndoType::step_free(UndoStep *us) |
Definition at line 174 of file BKE_undo_system.hh.
Referenced by blender::ED_armature_undosys_type(), blender::ED_curve_undosys_type(), blender::ED_font_undosys_type(), blender::ED_image_undosys_type(), blender::ED_lattice_undosys_type(), blender::ED_mball_undosys_type(), blender::ED_memfile_undosys_type(), blender::ED_mesh_undosys_type(), blender::ED_paintcurve_undosys_type(), blender::ED_particle_undosys_type(), blender::ED_text_undosys_type(), blender::ED_undosys_type_grease_pencil(), blender::ed::sculpt_paint::undo::register_type(), blender::undosys_step_free_and_unlink(), blender::ed::curves::undosys_type_register(), and blender::ed::pointcloud::undosys_type_register().
| size_t blender::UndoType::step_size |
The size of the undo struct 'inherited' from UndoStep for that specific type. Used for generic allocation in BKE's undo_system.cc.
Definition at line 199 of file BKE_undo_system.hh.
Referenced by blender::BKE_undosys_step_push_init_with_type(), blender::BKE_undosys_step_push_with_type(), blender::ED_armature_undosys_type(), blender::ED_curve_undosys_type(), blender::ED_font_undosys_type(), blender::ED_image_undosys_type(), blender::ED_lattice_undosys_type(), blender::ED_mball_undosys_type(), blender::ED_memfile_undosys_type(), blender::ED_mesh_undosys_type(), blender::ED_paintcurve_undosys_type(), blender::ED_particle_undosys_type(), blender::ED_text_undosys_type(), blender::ED_undosys_type_grease_pencil(), blender::ed::sculpt_paint::undo::register_type(), blender::ed::curves::undosys_type_register(), and blender::ed::pointcloud::undosys_type_register().