4d3f36b5fba3fe7bc30dadf40092e2921428ee1a
[blender.git] / source / blender / depsgraph / DEG_depsgraph.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2013 Blender Foundation.
19  * All rights reserved.
20  *
21  * Original Author: Joshua Leung
22  * Contributor(s): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/DEG_depsgraph.h
28  *  \ingroup depsgraph
29  *
30  * Public API for Depsgraph
31  *
32  * Dependency Graph
33  * ================
34  *
35  * The dependency graph tracks relations between various pieces of data in
36  * a Blender file, but mainly just those which make up scene data. It is used
37  * to determine the set of operations need to ensure that all data has been
38  * correctly evaluated in response to changes, based on dependencies and visibility
39  * of affected data.
40  *
41  *
42  * Evaluation Engine
43  * =================
44  *
45  * The evaluation takes the operation-nodes the Depsgraph has tagged for updating, 
46  * and schedules them up for being evaluated/executed such that the all dependency
47  * relationship constraints are satisfied. 
48  */
49
50 /* ************************************************* */
51 /* Forward-defined typedefs for core types
52  * - These are used in all depsgraph code and by all callers of Depsgraph API...
53  */
54
55 #ifndef __DEG_DEPSGRAPH_H__
56 #define __DEG_DEPSGRAPH_H__
57
58 /* Dependency Graph */
59 typedef struct Depsgraph Depsgraph;
60
61 /* ------------------------------------------------ */
62
63 struct EvaluationContext;
64 struct Main;
65
66 struct PointerRNA;
67 struct PropertyRNA;
68 struct RenderEngineType;
69 struct Scene;
70 struct ViewLayer;
71
72 typedef enum eEvaluationMode {
73         DAG_EVAL_VIEWPORT       = 0,    /* evaluate for OpenGL viewport */
74         DAG_EVAL_PREVIEW        = 1,    /* evaluate for render with preview settings */
75         DAG_EVAL_RENDER         = 2,    /* evaluate for render purposes */
76 } eEvaluationMode;
77
78 /* Dependency graph evaluation context
79  *
80  * This structure stores all the local dependency graph data,
81  * which is needed for it's evaluation,
82  */
83 typedef struct EvaluationContext {
84         eEvaluationMode mode;
85         float ctime;
86
87         struct Depsgraph *depsgraph;
88         struct ViewLayer *view_layer;
89         struct RenderEngineType *engine_type;
90 } EvaluationContext;
91
92 /* DagNode->eval_flags */
93 enum {
94         /* Regardless to curve->path animation flag path is to be evaluated anyway,
95          * to meet dependencies with such a things as curve modifier and other guys
96          * who're using curve deform, where_on_path and so.
97          */
98         DAG_EVAL_NEED_CURVE_PATH = 1,
99         /* Scene evaluation would need to have object's data on CPU,
100          * meaning no GPU shortcuts is allowed.
101          */
102         DAG_EVAL_NEED_CPU        = 2,
103 };
104
105 #ifdef __cplusplus
106 extern "C" {
107 #endif
108
109 bool DEG_depsgraph_use_copy_on_write(void);
110 void DEG_depsgraph_enable_copy_on_write(void);
111
112 /* ************************************************ */
113 /* Depsgraph API */
114
115 /* CRUD ------------------------------------------- */
116
117 // Get main depsgraph instance from context!
118
119 /* Create new Depsgraph instance */
120 // TODO: what args are needed here? What's the building-graph entry point?
121 Depsgraph *DEG_graph_new(void);
122
123 /* Free Depsgraph itself and all its data */
124 void DEG_graph_free(Depsgraph *graph);
125
126 /* Node Types Registry ---------------------------- */
127
128 /* Register all node types */
129 void DEG_register_node_types(void);
130
131 /* Free node type registry on exit */
132 void DEG_free_node_types(void);
133
134 /* Update Tagging -------------------------------- */
135
136 /* Update dependency graph when visible scenes/layers changes. */
137 void DEG_graph_on_visible_update(struct Main *bmain, Depsgraph *depsgraph);
138
139 /* Update all dependency graphs when visible scenes/layers changes. */
140 void DEG_on_visible_update(struct Main *bmain, const bool do_time);
141
142 /* Tag given ID for an update in all the dependency graphs. */
143 typedef enum eDepsgraph_Tag {
144         /* Object transformation changed, corresponds to OB_RECALC_OB. */
145         DEG_TAG_TRANSFORM   = (1 << 0),
146         /* Object geometry changed, corresponds to OB_RECALC_DATA. */
147         DEG_TAG_GEOMETRY    = (1 << 1),
148         /* Time changed and animation is to be re-evaluated, OB_RECALC_TIME. */
149         DEG_TAG_TIME        = (1 << 2),
150         /* Particle system changed. */
151         DEG_TAG_PSYS_REDO   = (1 << 3),
152         DEG_TAG_PSYS_RESET  = (1 << 4),
153         DEG_TAG_PSYS_TYPE   = (1 << 5),
154         DEG_TAG_PSYS_CHILD  = (1 << 6),
155         DEG_TAG_PSYS_PHYS   = (1 << 7),
156         DEG_TAG_PSYS_ALL    = (DEG_TAG_PSYS_REDO |
157                                DEG_TAG_PSYS_RESET |
158                                DEG_TAG_PSYS_TYPE |
159                                DEG_TAG_PSYS_CHILD |
160                                DEG_TAG_PSYS_PHYS),
161         /* Update copy on write component without flushing down the road. */
162         DEG_TAG_COPY_ON_WRITE = (1 << 8),
163         /* Tag shading components for update.
164          * Only parameters of material changed).
165          */
166         DEG_TAG_SHADING_UPDATE  = (1 << 9),
167         DEG_TAG_SELECT_UPDATE   = (1 << 10),
168         DEG_TAG_BASE_FLAGS_UPDATE = (1 << 11),
169         /* Only inform editors about the change. Don't modify datablock itself. */
170         DEG_TAG_EDITORS_UPDATE = (1 << 12),
171 } eDepsgraph_Tag;
172 void DEG_id_tag_update(struct ID *id, int flag);
173 void DEG_id_tag_update_ex(struct Main *bmain, struct ID *id, int flag);
174
175 void DEG_graph_id_tag_update(struct Main *bmain,
176                              struct Depsgraph *depsgraph,
177                              struct ID *id,
178                              int flag);
179
180 /* Mark a particular datablock type as having changing. This does
181  * not cause any updates but is used by external render engines to detect if for
182  * example a datablock was removed.
183  */
184 void DEG_id_type_tag(struct Main *bmain, short id_type);
185
186 void DEG_ids_clear_recalc(struct Main *bmain);
187
188 /* Update Flushing ------------------------------- */
189
190 /* Flush updates for IDs in a single scene. */
191 void DEG_graph_flush_update(struct Main *bmain, Depsgraph *depsgraph);
192
193 /* Check if something was changed in the database and inform
194  * editors about this.
195  */
196 void DEG_ids_check_recalc(struct Main *bmain,
197                           struct Depsgraph *depsgraph,
198                           struct Scene *scene,
199                           struct ViewLayer *view_layer,
200                           bool time);
201
202 /* ************************************************ */
203 /* Evaluation Engine API */
204
205 /* Evaluation Context ---------------------------- */
206
207 /* Create new evaluation context. */
208 struct EvaluationContext *DEG_evaluation_context_new(eEvaluationMode mode);
209
210 /* Initialize evaluation context.
211  * Used by the areas which currently overrides the context or doesn't have
212  * access to a proper one.
213  */
214 void DEG_evaluation_context_init(struct EvaluationContext *eval_ctx,
215                                  eEvaluationMode mode);
216 void DEG_evaluation_context_init_from_scene(struct EvaluationContext *eval_ctx,
217                                             struct Scene *scene,
218                                             struct ViewLayer *view_layer,
219                                             struct RenderEngineType *engine_type,
220                                             eEvaluationMode mode);
221
222 /* Free evaluation context. */
223 void DEG_evaluation_context_free(struct EvaluationContext *eval_ctx);
224
225 /* Graph Evaluation  ----------------------------- */
226
227 /* Frame changed recalculation entry point
228  * < context_type: context to perform evaluation for
229  * < ctime: (frame) new frame to evaluate values on
230  */
231 void DEG_evaluate_on_framechange(struct EvaluationContext *eval_ctx,
232                                  struct Main *bmain,
233                                  Depsgraph *graph,
234                                  float ctime);
235
236 /* Data changed recalculation entry point.
237  * < context_type: context to perform evaluation for
238  */
239 void DEG_evaluate_on_refresh(struct EvaluationContext *eval_ctx,
240                              Depsgraph *graph);
241
242 bool DEG_needs_eval(Depsgraph *graph);
243
244 /* Editors Integration  -------------------------- */
245
246 /* Mechanism to allow editors to be informed of depsgraph updates,
247  * to do their own updates based on changes.
248  */
249
250 typedef struct DEGEditorUpdateContext {
251         struct Main *bmain;
252         struct Depsgraph *depsgraph;
253         struct Scene *scene;
254         struct ViewLayer *view_layer;
255 } DEGEditorUpdateContext;
256
257 typedef void (*DEG_EditorUpdateIDCb)(
258         const DEGEditorUpdateContext *update_ctx,
259         struct ID *id);
260 typedef void (*DEG_EditorUpdateSceneCb)(
261         const DEGEditorUpdateContext *update_ctx, int updated);
262
263 /* Set callbacks which are being called when depsgraph changes. */
264 void DEG_editors_set_update_cb(DEG_EditorUpdateIDCb id_func,
265                                DEG_EditorUpdateSceneCb scene_func);
266
267 #ifdef __cplusplus
268 } /* extern "C" */
269 #endif
270
271 #endif  /* __DEG_DEPSGRAPH_H__ */