ED_undo.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "BLI_sys_types.h"
#include "BLI_vector.hh"
 
struct Base;
struct CLG_LogRef;
struct ID;
struct MemFile;
struct PointerRNA;
struct Object;
struct Scene;
struct UndoStack;
struct ViewLayer;
struct bContext;
struct wmOperator;
struct wmOperatorType;
struct wmWindowManager;
 
/* undo.c */

bool ED_undo_is_state_valid(bContext *C);
void ED_undo_group_begin(bContext *C);
void ED_undo_group_end(bContext *C);
void ED_undo_push(bContext *C, const char *str);
void ED_undo_push_op(bContext *C, wmOperator *op);
void ED_undo_grouped_push(bContext *C, const char *str);
void ED_undo_grouped_push_op(bContext *C, wmOperator *op);
void ED_undo_pop_op(bContext *C, wmOperator *op);
void ED_undo_pop(bContext *C);
void ED_undo_redo(bContext *C);
void ED_OT_undo(wmOperatorType *ot);
void ED_OT_undo_push(wmOperatorType *ot);
void ED_OT_redo(wmOperatorType *ot);
void ED_OT_undo_redo(wmOperatorType *ot);
void ED_OT_undo_history(wmOperatorType *ot);

bool ED_undo_operator_repeat(bContext *C, wmOperator *op);
void ED_undo_operator_repeat_cb(bContext *C, void *arg_op, void *arg_unused);
void ED_undo_operator_repeat_cb_evt(bContext *C, void *arg_op, int arg_unused);

bool ED_undo_is_valid(const bContext *C, const char *undoname);
 
bool ED_undo_is_memfile_compatible(const bContext *C);
 
/* Unfortunate workaround for limits mixing undo systems. */

bool ED_undo_is_legacy_compatible_for_property(bContext *C, ID *id, PointerRNA &ptr);

void ED_undo_object_editmode_validate_scene_from_windows(wmWindowManager *wm,
                                                         const Scene *scene_ref,
                                                         Scene **scene_p,
                                                         ViewLayer **view_layer_p);

void ED_undo_object_editmode_restore_helper(Scene *scene,
                                            ViewLayer *view_layer,
                                            Object **object_array,
                                            uint object_array_len,
                                            uint object_array_stride);
 
blender::Vector<Object *> ED_undo_editmode_objects_from_view_layer(const Scene *scene,
                                                                   ViewLayer *view_layer);
blender::Vector<Base *> ED_undo_editmode_bases_from_view_layer(const Scene *scene,
                                                               ViewLayer *view_layer);

UndoStack *ED_undo_stack_get();
 
/* Helpers. */
 
void ED_undo_object_set_active_or_warn(
    Scene *scene, ViewLayer *view_layer, Object *ob, const char *info, CLG_LogRef *log);
 
/* `undo_system_types.cc` */
 
void ED_undosys_type_init();
void ED_undosys_type_free();
 
/* `memfile_undo.cc` */
 
MemFile *ED_undosys_stack_memfile_get_if_active(UndoStack *ustack);
void ED_undosys_stack_memfile_id_changed_tag(UndoStack *ustack, ID *id);
size_t ED_undosys_total_memory_calc(UndoStack *ustack);