Depsgraph: Remove evaluation priority completely
[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 "DNA_scene_types.h"
40
41 #include "BKE_depsgraph.h"
42 #include "BKE_scene.h"
43 } /* extern "C" */
44
45 #include "DEG_depsgraph.h"
46
47 #include "intern/eval/deg_eval.h"
48 #include "intern/eval/deg_eval_flush.h"
49
50 #include "intern/nodes/deg_node.h"
51 #include "intern/nodes/deg_node_operation.h"
52 #include "intern/nodes/deg_node_time.h"
53
54 #include "intern/depsgraph.h"
55
56 #ifdef WITH_LEGACY_DEPSGRAPH
57 static bool use_legacy_depsgraph = true;
58 #endif
59
60 bool DEG_depsgraph_use_legacy(void)
61 {
62 #ifdef DISABLE_NEW_DEPSGRAPH
63         return true;
64 #elif defined(WITH_LEGACY_DEPSGRAPH)
65         return use_legacy_depsgraph;
66 #else
67         BLI_assert(!"Should not be used with new depsgraph");
68         return false;
69 #endif
70 }
71
72 void DEG_depsgraph_switch_to_legacy(void)
73 {
74 #ifdef WITH_LEGACY_DEPSGRAPH
75         use_legacy_depsgraph = true;
76 #else
77         BLI_assert(!"Should not be used with new depsgraph");
78 #endif
79 }
80
81 void DEG_depsgraph_switch_to_new(void)
82 {
83 #ifdef WITH_LEGACY_DEPSGRAPH
84         use_legacy_depsgraph = false;
85 #else
86         BLI_assert(!"Should not be used with new depsgraph");
87 #endif
88 }
89
90 /* ****************** */
91 /* Evaluation Context */
92
93 /* Create new evaluation context. */
94 EvaluationContext *DEG_evaluation_context_new(int mode)
95 {
96         EvaluationContext *eval_ctx =
97                 (EvaluationContext *)MEM_callocN(sizeof(EvaluationContext),
98                                                  "EvaluationContext");
99         eval_ctx->mode = mode;
100         return eval_ctx;
101 }
102
103 /**
104  * Initialize evaluation context.
105  * Used by the areas which currently overrides the context or doesn't have
106  * access to a proper one.
107  */
108 void DEG_evaluation_context_init(EvaluationContext *eval_ctx, int mode)
109 {
110         eval_ctx->mode = mode;
111 }
112
113 /* Free evaluation context. */
114 void DEG_evaluation_context_free(EvaluationContext *eval_ctx)
115 {
116         MEM_freeN(eval_ctx);
117 }
118
119 /* Evaluate all nodes tagged for updating. */
120 void DEG_evaluate_on_refresh(EvaluationContext *eval_ctx,
121                              Depsgraph *graph,
122                              Scene *scene)
123 {
124         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
125         /* Update time on primary timesource. */
126         DEG::TimeSourceDepsNode *tsrc = deg_graph->find_time_source();
127         tsrc->cfra = BKE_scene_frame_get(scene);
128         unsigned int layers = deg_graph->layers;
129         /* XXX(sergey): This works around missing updates in temp scenes used
130          * by various scripts, but is weak and needs closer investigation.
131          */
132         if (layers == 0) {
133                 layers = scene->lay;
134         }
135         DEG::deg_evaluate_on_refresh(eval_ctx, deg_graph, layers);
136 }
137
138 /* Frame-change happened for root scene that graph belongs to. */
139 void DEG_evaluate_on_framechange(EvaluationContext *eval_ctx,
140                                  Main *bmain,
141                                  Depsgraph *graph,
142                                  float ctime,
143                                  const unsigned int layers)
144 {
145         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
146         /* Update time on primary timesource. */
147         DEG::TimeSourceDepsNode *tsrc = deg_graph->find_time_source();
148         tsrc->cfra = ctime;
149         tsrc->tag_update(deg_graph);
150         DEG::deg_graph_flush_updates(bmain, deg_graph);
151         /* Perform recalculation updates. */
152         DEG::deg_evaluate_on_refresh(eval_ctx, deg_graph, layers);
153 }
154
155 bool DEG_needs_eval(Depsgraph *graph)
156 {
157         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
158         return BLI_gset_size(deg_graph->entry_tags) != 0;
159 }