BKE_callbacks.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
struct Depsgraph;
struct ID;
struct Main;
struct PointerRNA;
 
enum eCbEvent {
  BKE_CB_EVT_FRAME_CHANGE_PRE,
  BKE_CB_EVT_FRAME_CHANGE_POST,
  BKE_CB_EVT_RENDER_PRE,
  BKE_CB_EVT_RENDER_POST,
  BKE_CB_EVT_RENDER_WRITE,
  BKE_CB_EVT_RENDER_STATS,
  BKE_CB_EVT_RENDER_INIT,
  BKE_CB_EVT_RENDER_COMPLETE,
  BKE_CB_EVT_RENDER_CANCEL,
  BKE_CB_EVT_LOAD_PRE,
  BKE_CB_EVT_LOAD_POST,
  BKE_CB_EVT_LOAD_POST_FAIL,
  BKE_CB_EVT_SAVE_PRE,
  BKE_CB_EVT_SAVE_POST,
  BKE_CB_EVT_SAVE_POST_FAIL,
  BKE_CB_EVT_UNDO_PRE,
  BKE_CB_EVT_UNDO_POST,
  BKE_CB_EVT_REDO_PRE,
  BKE_CB_EVT_REDO_POST,
  BKE_CB_EVT_DEPSGRAPH_UPDATE_PRE,
  BKE_CB_EVT_DEPSGRAPH_UPDATE_POST,
  BKE_CB_EVT_VERSION_UPDATE,
  BKE_CB_EVT_LOAD_FACTORY_USERDEF_POST,
  BKE_CB_EVT_LOAD_FACTORY_STARTUP_POST,
  BKE_CB_EVT_XR_SESSION_START_PRE,
  BKE_CB_EVT_ANNOTATION_PRE,
  BKE_CB_EVT_ANNOTATION_POST,
  BKE_CB_EVT_OBJECT_BAKE_PRE,
  BKE_CB_EVT_OBJECT_BAKE_COMPLETE,
  BKE_CB_EVT_OBJECT_BAKE_CANCEL,
  BKE_CB_EVT_COMPOSITE_PRE,
  BKE_CB_EVT_COMPOSITE_POST,
  BKE_CB_EVT_COMPOSITE_CANCEL,
  BKE_CB_EVT_ANIMATION_PLAYBACK_PRE,
  BKE_CB_EVT_ANIMATION_PLAYBACK_POST,
  BKE_CB_EVT_TRANSLATION_UPDATE_POST,
  BKE_CB_EVT_EXTENSION_REPOS_UPDATE_PRE,
  BKE_CB_EVT_EXTENSION_REPOS_UPDATE_POST,
  BKE_CB_EVT_EXTENSION_REPOS_SYNC,
  BKE_CB_EVT_EXTENSION_REPOS_FILES_CLEAR,
  BKE_CB_EVT_BLENDIMPORT_PRE,
  BKE_CB_EVT_BLENDIMPORT_POST,
  BKE_CB_EVT_TOT,
};
 
struct bCallbackFuncStore {
  bCallbackFuncStore *next, *prev;
  void (*func)(Main *, PointerRNA **, int num_pointers, void *arg);
  void *arg;
  short alloc;
};
 
void BKE_callback_exec(Main *bmain, PointerRNA **pointers, int num_pointers, eCbEvent evt);
void BKE_callback_exec_null(Main *bmain, eCbEvent evt);
void BKE_callback_exec_id(Main *bmain, ID *id, eCbEvent evt);
void BKE_callback_exec_id_depsgraph(Main *bmain, ID *id, Depsgraph *depsgraph, eCbEvent evt);
void BKE_callback_exec_string(Main *bmain, eCbEvent evt, const char *str);
void BKE_callback_add(bCallbackFuncStore *funcstore, eCbEvent evt);
void BKE_callback_remove(bCallbackFuncStore *funcstore, eCbEvent evt);
 
void BKE_callback_global_init();
void BKE_callback_global_finalize();