Cleanup: remove redundant doxygen \file argument
[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 \ingroup depsgraph
21  *
22  * Evaluation engine entrypoints for Depsgraph Engine.
23  */
24
25 #include "MEM_guardedalloc.h"
26
27 #include "BLI_listbase.h"
28 #include "BLI_utildefines.h"
29 #include "BLI_ghash.h"
30
31 extern "C" {
32 #include "BKE_scene.h"
33
34 #include "DNA_object_types.h"
35 #include "DNA_scene_types.h"
36 } /* extern "C" */
37
38 #include "DEG_depsgraph.h"
39 #include "DEG_depsgraph_query.h"
40
41 #include "intern/eval/deg_eval.h"
42 #include "intern/eval/deg_eval_flush.h"
43
44 #include "intern/node/deg_node.h"
45 #include "intern/node/deg_node_operation.h"
46 #include "intern/node/deg_node_time.h"
47
48 #include "intern/depsgraph.h"
49
50 /* Evaluate all nodes tagged for updating. */
51 void DEG_evaluate_on_refresh(Depsgraph *graph)
52 {
53         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
54         deg_graph->ctime = BKE_scene_frame_get(deg_graph->scene);
55         /* Update time on primary timesource. */
56         DEG::TimeSourceNode *tsrc = deg_graph->find_time_source();
57         tsrc->cfra = deg_graph->ctime;
58         /* Update time in scene. */
59         if (deg_graph->scene_cow) {
60                 BKE_scene_frame_set(deg_graph->scene_cow, deg_graph->ctime);
61         }
62         DEG::deg_evaluate_on_refresh(deg_graph);
63 }
64
65 /* Frame-change happened for root scene that graph belongs to. */
66 void DEG_evaluate_on_framechange(Main *bmain,
67                                  Depsgraph *graph,
68                                  float ctime)
69 {
70         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
71         deg_graph->ctime = ctime;
72         /* Update time on primary timesource. */
73         DEG::TimeSourceNode *tsrc = deg_graph->find_time_source();
74         tsrc->cfra = ctime;
75         tsrc->tag_update(deg_graph, DEG::DEG_UPDATE_SOURCE_TIME);
76         DEG::deg_graph_flush_updates(bmain, deg_graph);
77         /* Update time in scene. */
78         if (deg_graph->scene_cow) {
79                 BKE_scene_frame_set(deg_graph->scene_cow, deg_graph->ctime);
80         }
81         /* Perform recalculation updates. */
82         DEG::deg_evaluate_on_refresh(deg_graph);
83 }
84
85 bool DEG_needs_eval(Depsgraph *graph)
86 {
87         DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
88         return BLI_gset_len(deg_graph->entry_tags) != 0;
89 }