doxygen: add newline after \file
[blender.git] / source / blender / depsgraph / intern / depsgraph_eval.cc
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup depsgraph
22  *
23  * Evaluation engine entrypoints for Depsgraph Engine.
24  */
25
26 #include "MEM_guardedalloc.h"
27
28 #include "BLI_listbase.h"
29 #include "BLI_utildefines.h"
30 #include "BLI_ghash.h"
31
32 extern "C" {
33 #include "BKE_scene.h"
34
35 #include "DNA_object_types.h"
36 #include "DNA_scene_types.h"
37 } /* extern "C" */
38
39 #include "DEG_depsgraph.h"
40 #include "DEG_depsgraph_query.h"
41
42 #include "intern/eval/deg_eval.h"
43 #include "intern/eval/deg_eval_flush.h"
44
45 #include "intern/node/deg_node.h"
46 #include "intern/node/deg_node_operation.h"
47 #include "intern/node/deg_node_time.h"
48
49 #include "intern/depsgraph.h"
50
51 /* Evaluate all nodes tagged for updating. */
52 void DEG_evaluate_on_refresh(Depsgraph *graph)
53 {
54         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
55         deg_graph->ctime = BKE_scene_frame_get(deg_graph->scene);
56         /* Update time on primary timesource. */
57         DEG::TimeSourceNode *tsrc = deg_graph->find_time_source();
58         tsrc->cfra = deg_graph->ctime;
59         /* Update time in scene. */
60         if (deg_graph->scene_cow) {
61                 BKE_scene_frame_set(deg_graph->scene_cow, deg_graph->ctime);
62         }
63         DEG::deg_evaluate_on_refresh(deg_graph);
64 }
65
66 /* Frame-change happened for root scene that graph belongs to. */
67 void DEG_evaluate_on_framechange(Main *bmain,
68                                  Depsgraph *graph,
69                                  float ctime)
70 {
71         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
72         deg_graph->ctime = ctime;
73         /* Update time on primary timesource. */
74         DEG::TimeSourceNode *tsrc = deg_graph->find_time_source();
75         tsrc->cfra = ctime;
76         tsrc->tag_update(deg_graph, DEG::DEG_UPDATE_SOURCE_TIME);
77         DEG::deg_graph_flush_updates(bmain, deg_graph);
78         /* Update time in scene. */
79         if (deg_graph->scene_cow) {
80                 BKE_scene_frame_set(deg_graph->scene_cow, deg_graph->ctime);
81         }
82         /* Perform recalculation updates. */
83         DEG::deg_evaluate_on_refresh(deg_graph);
84 }
85
86 bool DEG_needs_eval(Depsgraph *graph)
87 {
88         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
89         return BLI_gset_len(deg_graph->entry_tags) != 0;
90 }