1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file
* \ingroup bke
*/
#pragma once
#ifdef __cplusplus
extern "C" {
#endif
struct Depsgraph;
struct ID;
struct Main;
struct PointerRNA;
/**
Callbacks for One Off Actions
* =============================
*
* - `{ACTION}` use in cases where only a single callback is required,
* `VERSION_UPDATE` and `RENDER_STATS` for example.
*
* \note avoid single callbacks if there is a chance `PRE/POST` are useful to differentiate
* since renaming callbacks may break Python scripts.
*
* Callbacks for Common Actions
* ============================
*
* - `{ACTION}_PRE` run before the action.
* - `{ACTION}_POST` run after the action.
*
* Optional Additional Callbacks
* -----------------------------
*
* - `{ACTION}_INIT` when the handler may manipulate the context used to run the action.
*
* Examples where `INIT` functions may be useful are:
*
* - When rendering, an `INIT` function may change the camera or render settings,
* things which a `PRE` function can't support as this information has already been used.
* - When saving an `INIT` function could temporarily change the preferences.
*
* - `{ACTION}_POST_FAIL` should be included if the action may fail.
*
* Use this so a call to the `PRE` callback always has a matching call to `POST` or `POST_FAIL`.
*
* \note in most cases only `PRE/POST` are required.
*
* Callbacks for Background/Modal Tasks
* ====================================
*
* - `{ACTION}_INIT`
* - `{ACTION}_COMPLETE` when a background job has finished.
* - `{ACTION}_CANCEL` When a background job is canceled partway through.
*
* While cancellation may be caused by any number of reasons, common causes may include:
*
* - Explicit user cancellation.
* - Exiting Blender.
* - Failure to acquire resources (such as disk-full, out of memory ... etc).
*
* \note `PRE/POST` handlers may be used along side modal task handlers
* as is the case for rendering, where rendering an animation uses modal task handlers,
* rendering a single frame has `PRE/POST` handlers.
*
* Python Access
* =============
*
* All callbacks here must be exposed via the Python module `bpy.app.handlers`,
* see `bpy_app_handlers.c`.
*/
typedef enum {
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_SAVE_PRE,
BKE_CB_EVT_SAVE_POST,
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_TOT,
} eCbEvent;
typedef struct bCallbackFuncStore {
struct bCallbackFuncStore *next, *prev;
void (*func)(struct Main *, struct PointerRNA **, const int num_pointers, void *arg);
void *arg;
short alloc;
} bCallbackFuncStore;
void BKE_callback_exec(struct Main *bmain,
struct PointerRNA **pointers,
const int num_pointers,
eCbEvent evt);
void BKE_callback_exec_null(struct Main *bmain, eCbEvent evt);
void BKE_callback_exec_id(struct Main *bmain, struct ID *id, eCbEvent evt);
void BKE_callback_exec_id_depsgraph(struct Main *bmain,
struct ID *id,
struct Depsgraph *depsgraph,
eCbEvent evt);
void BKE_callback_add(bCallbackFuncStore *funcstore, eCbEvent evt);
void BKE_callback_global_init(void);
void BKE_callback_global_finalize(void);
#ifdef __cplusplus
}
#endif
|
