Merge branch 'master' into blender2.8
[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 Scene;
69 struct SceneLayer;
70
71 typedef enum eEvaluationMode {
72         DAG_EVAL_VIEWPORT       = 0,    /* evaluate for OpenGL viewport */
73         DAG_EVAL_PREVIEW        = 1,    /* evaluate for render with preview settings */
74         DAG_EVAL_RENDER         = 2,    /* evaluate for render purposes */
75 } eEvaluationMode;
76
77 /* Dependency graph evaluation context
78  *
79  * This structure stores all the local dependency graph data,
80  * which is needed for it's evaluation,
81  */
82 typedef struct EvaluationContext {
83         eEvaluationMode mode;
84         float ctime;
85
86         struct SceneLayer *scene_layer;
87 } EvaluationContext;
88
89 /* DagNode->eval_flags */
90 enum {
91         /* Regardless to curve->path animation flag path is to be evaluated anyway,
92          * to meet dependencies with such a things as curve modifier and other guys
93          * who're using curve deform, where_on_path and so.
94          */
95         DAG_EVAL_NEED_CURVE_PATH = 1,
96         /* Scene evaluation would need to have object's data on CPU,
97          * meaning no GPU shortcuts is allowed.
98          */
99         DAG_EVAL_NEED_CPU        = 2,
100 };
101
102 #ifdef __cplusplus
103 extern "C" {
104 #endif
105
106 bool DEG_depsgraph_use_legacy(void);
107 void DEG_depsgraph_switch_to_legacy(void);
108 void DEG_depsgraph_switch_to_new(void);
109
110 /* ************************************************ */
111 /* Depsgraph API */
112
113 /* CRUD ------------------------------------------- */
114
115 // Get main depsgraph instance from context!
116
117 /* Create new Depsgraph instance */
118 // TODO: what args are needed here? What's the building-graph entry point?
119 Depsgraph *DEG_graph_new(void);
120
121 /* Free Depsgraph itself and all its data */
122 void DEG_graph_free(Depsgraph *graph);
123
124 /* Node Types Registry ---------------------------- */
125
126 /* Register all node types */
127 void DEG_register_node_types(void);
128
129 /* Free node type registry on exit */
130 void DEG_free_node_types(void);
131
132 /* Update Tagging -------------------------------- */
133
134 /* Tag node(s) associated with states such as time and visibility */
135 void DEG_scene_update_flags(Depsgraph *graph, const bool do_time);
136
137 /* Update dependency graph when visible scenes/layers changes. */
138 void DEG_graph_on_visible_update(struct Main *bmain, struct Scene *scene);
139
140 /* Update all dependency graphs when visible scenes/layers changes. */
141 void DEG_on_visible_update(struct Main *bmain, const bool do_time);
142
143 /* Tag given ID for an update in all the dependency graphs. */
144 enum {
145         /* Object transformation changed, corresponds to OB_RECALC_OB. */
146         DEG_TAG_TRANSFORM   = (1 << 0),
147
148         /* Object geoemtry changed, corresponds to OB_RECALC_DATA. */
149         DEG_TAG_GEOMETRY    = (1 << 1),
150
151         /* Time changed and animation is to be re-evaluated, OB_RECALC_TIME. */
152         DEG_TAG_TIME        = (1 << 2),
153
154         /* Particle system changed. */
155         DEG_TAG_PSYSC_REDO  =  (1 << 3),
156         DEG_TAG_PSYS_RESET  =  (1 << 4),
157         DEG_TAG_PSYS_TYPE   =  (1 << 5),
158         DEG_TAG_PSYS_CHILD  = (1 << 6),
159         DEG_TAG_PSYS_PHYS   = (1 << 7),
160         DEG_TAG_PSYS        = ((1 << 3) | (1 << 4) | (1 << 5) | (1 << 6) | (1 << 7)),
161
162         /* Update copy on write component without flushing down the road. */
163         DEG_TAG_COPY_ON_WRITE = (1 << 8),
164
165         /* Tag shading components for update.
166          * Only parameters of material changed).
167          */
168         DEG_TAG_SHADING_UPDATE  = (1 << 9),
169 };
170 void DEG_id_tag_update(struct ID *id, int flag);
171 void DEG_id_tag_update_ex(struct Main *bmain,
172                           struct ID *id,
173                           int flag);
174
175 /* Tag given ID type for update.
176  *
177  * Used by all sort of render engines to quickly check if
178  * IDs of a given type need to be checked for update.
179  */
180 void DEG_id_type_tag(struct Main *bmain, short id_type);
181
182 void DEG_ids_clear_recalc(struct Main *bmain);
183
184 /* Update Flushing ------------------------------- */
185
186 /* Flush updates for all IDs */
187 void DEG_ids_flush_tagged(struct Main *bmain, struct Scene *scene);
188
189 /* Check if something was changed in the database and inform
190  * editors about this.
191  */
192 void DEG_ids_check_recalc(struct Main *bmain,
193                           struct Scene *scene,
194                           bool time);
195
196 /* ************************************************ */
197 /* Evaluation Engine API */
198
199 /* Evaluation Context ---------------------------- */
200
201 /* Create new evaluation context. */
202 struct EvaluationContext *DEG_evaluation_context_new(eEvaluationMode mode);
203
204 /* Initialize evaluation context.
205  * Used by the areas which currently overrides the context or doesn't have
206  * access to a proper one.
207  */
208 void DEG_evaluation_context_init(struct EvaluationContext *eval_ctx,
209                                  eEvaluationMode mode);
210 void DEG_evaluation_context_init_from_scene(struct EvaluationContext *eval_ctx,
211                                             struct Scene *scene,
212                                             struct SceneLayer *scene_layer,
213                                             eEvaluationMode mode);
214
215 /* Free evaluation context. */
216 void DEG_evaluation_context_free(struct EvaluationContext *eval_ctx);
217
218 /* Graph Evaluation  ----------------------------- */
219
220 /* Frame changed recalculation entry point
221  * < context_type: context to perform evaluation for
222  * < ctime: (frame) new frame to evaluate values on
223  */
224 void DEG_evaluate_on_framechange(struct EvaluationContext *eval_ctx,
225                                  struct Main *bmain,
226                                  Depsgraph *graph,
227                                  float ctime);
228
229 /* Data changed recalculation entry point.
230  * < context_type: context to perform evaluation for
231  */
232 void DEG_evaluate_on_refresh_ex(struct EvaluationContext *eval_ctx,
233                                 Depsgraph *graph);
234
235 /* Data changed recalculation entry point.
236  * < context_type: context to perform evaluation for
237  */
238 void DEG_evaluate_on_refresh(struct EvaluationContext *eval_ctx,
239                              Depsgraph *graph,
240                              struct Scene *scene);
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 void (*DEG_EditorUpdateIDCb)(struct Main *bmain, struct ID *id);
251 typedef void (*DEG_EditorUpdateSceneCb)(struct Main *bmain,
252                                         struct Scene *scene,
253                                         int updated);
254 typedef void (*DEG_EditorUpdateScenePreCb)(struct Main *bmain,
255                                            struct Scene *scene,
256                                            bool time);
257
258 /* Set callbacks which are being called when depsgraph changes. */
259 void DEG_editors_set_update_cb(DEG_EditorUpdateIDCb id_func,
260                                DEG_EditorUpdateSceneCb scene_func,
261                                DEG_EditorUpdateScenePreCb scene_pre_func);
262
263 void DEG_editors_update_pre(struct Main *bmain, struct Scene *scene, bool time);
264
265 #ifdef __cplusplus
266 } /* extern "C" */
267 #endif
268
269 #endif  /* __DEG_DEPSGRAPH_H__ */