Depsgraph: Simplify some workarounds and make API closer to final
[blender.git] / source / blender / depsgraph / intern / depsgraph_eval.cc
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/intern/depsgraph_eval.cc
28  *  \ingroup depsgraph
29  *
30  * Evaluation engine entrypoints for Depsgraph Engine.
31  */
32
33 #include "MEM_guardedalloc.h"
34
35 #include "BLI_utildefines.h"
36 #include "BLI_ghash.h"
37
38 extern "C" {
39 #include "BKE_scene.h"
40
41 #include "DNA_scene_types.h"
42 } /* extern "C" */
43
44 #include "DEG_depsgraph.h"
45
46 #include "intern/eval/deg_eval.h"
47 #include "intern/eval/deg_eval_flush.h"
48
49 #include "intern/nodes/deg_node.h"
50 #include "intern/nodes/deg_node_operation.h"
51
52 #include "intern/depsgraph.h"
53
54 /* Unfinished and unused, and takes quite some pre-processing time. */
55 #undef USE_EVAL_PRIORITY
56
57 /* ****************** */
58 /* Evaluation Context */
59
60 /* Create new evaluation context. */
61 EvaluationContext *DEG_evaluation_context_new(eEvaluationMode mode)
62 {
63         EvaluationContext *eval_ctx =
64                 (EvaluationContext *)MEM_callocN(sizeof(EvaluationContext),
65                                                  "EvaluationContext");
66         DEG_evaluation_context_init(eval_ctx, mode);
67         return eval_ctx;
68 }
69
70 /**
71  * Initialize evaluation context.
72  * Used by the areas which currently overrides the context or doesn't have
73  * access to a proper one.
74  */
75 void DEG_evaluation_context_init(EvaluationContext *eval_ctx,
76                                  eEvaluationMode mode)
77 {
78         eval_ctx->mode = mode;
79 }
80
81 void DEG_evaluation_context_init_from_scene(EvaluationContext *eval_ctx,
82                                             Scene *scene,
83                                             SceneLayer *scene_layer,
84                                             RenderEngineType *engine,
85                                             eEvaluationMode mode)
86 {
87         DEG_evaluation_context_init(eval_ctx, mode);
88         eval_ctx->depsgraph = BKE_scene_get_depsgraph(scene, scene_layer, false);
89         eval_ctx->scene_layer = scene_layer;
90         eval_ctx->engine = engine;
91         eval_ctx->ctime = BKE_scene_frame_get(scene);
92 }
93
94 /* Free evaluation context. */
95 void DEG_evaluation_context_free(EvaluationContext *eval_ctx)
96 {
97         MEM_freeN(eval_ctx);
98 }
99
100 /* Evaluate all nodes tagged for updating. */
101 void DEG_evaluate_on_refresh(EvaluationContext *eval_ctx,
102                              Depsgraph *graph)
103 {
104         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
105         /* Update time on primary timesource. */
106         DEG::TimeSourceDepsNode *tsrc = deg_graph->find_time_source();
107         tsrc->cfra = BKE_scene_frame_get(deg_graph->scene);
108         DEG::deg_evaluate_on_refresh(eval_ctx, deg_graph);
109 }
110
111 /* Frame-change happened for root scene that graph belongs to. */
112 void DEG_evaluate_on_framechange(EvaluationContext *eval_ctx,
113                                  Main *bmain,
114                                  Depsgraph *graph,
115                                  float ctime)
116 {
117         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
118         /* Update time on primary timesource. */
119         DEG::TimeSourceDepsNode *tsrc = deg_graph->find_time_source();
120         tsrc->cfra = ctime;
121         tsrc->tag_update(deg_graph);
122         DEG::deg_graph_flush_updates(bmain, deg_graph);
123         /* Perform recalculation updates. */
124         DEG::deg_evaluate_on_refresh(eval_ctx, deg_graph);
125 }
126
127 bool DEG_needs_eval(Depsgraph *graph)
128 {
129         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
130         return BLI_gset_size(deg_graph->entry_tags) != 0;
131 }