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