Recent spinlock commit made scheduling unsafe for threading
[blender.git] / source / blender / blenkernel / BKE_depsgraph.h
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) 2004 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): none yet.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BKE_DEPSGRAPH_H__
27 #define __BKE_DEPSGRAPH_H__
28
29 /** \file BKE_depsgraph.h
30  *  \ingroup bke
31  */
32
33 /* Dependency Graph
34  *
35  * The dependency graph tracks relations between datablocks, and is used to
36  * determine which datablocks need to be update based on dependencies and
37  * visibility.
38  *
39  * It does not itself execute changes in objects, but rather sorts the objects
40  * in the appropriate order and sets flags indicating they should be updated.
41  */
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 struct ID;
48 struct Main;
49 struct Object;
50 struct Scene;
51 struct ListBase;
52
53 /* Build and Update
54  *
55  * DAG_scene_relations_update will rebuild the dependency graph for a given
56  * scene if needed, and sort objects in the scene.
57  *
58  * DAG_relations_tag_update will clear all dependency graphs and mark them to
59  * be rebuilt later. The graph is not rebuilt immediately to avoid slowdowns
60  * when this function is call multiple times from different operators.
61  *
62  * DAG_scene_relations_rebuild forces an immediaterebuild of the dependency
63  * graph, this is only needed in rare cases
64  */
65
66 void DAG_scene_relations_update(struct Main *bmain, struct Scene *sce);
67 void DAG_relations_tag_update(struct Main *bmain);
68 void DAG_scene_relations_rebuild(struct Main *bmain, struct Scene *scene);
69 void DAG_scene_free(struct Scene *sce);
70
71 /* Update Tagging
72  *
73  * DAG_scene_update_flags will mark all objects that depend on time (animation,
74  * physics, ..) to be recalculated, used when changing the current frame.
75  * 
76  * DAG_on_visible_update will mark all objects that are visible for the first
77  * time to be updated, for example on file load or changing layer visibility.
78  *
79  * DAG_id_tag_update will mark a given datablock to be updated. The flag indicates
80  * a specific subset to be update (only object transform and data for now).
81  *
82  * DAG_id_type_tag marks a particular datablock type as having changing. This does
83  * not cause any updates but is used by external render engines to detect if for
84  * example a datablock was removed. */
85
86 void DAG_scene_update_flags(struct Main *bmain, struct Scene *sce, unsigned int lay, const short do_time);
87 void DAG_on_visible_update(struct Main *bmain, const short do_time);
88
89 void DAG_id_tag_update(struct ID *id, short flag);
90 void DAG_id_tag_update_ex(struct Main *bmain, struct ID *id, short flag);
91 void DAG_id_type_tag(struct Main *bmain, short idtype);
92 int  DAG_id_type_tagged(struct Main *bmain, short idtype);
93
94 /* Flushing Tags
95  *
96  * DAG_scene_flush_update flushes object recalculation flags immediately to other
97  * dependencies. Do not use outside of depsgraph.c, this will be removed.
98  *
99  * DAG_ids_flush_tagged will flush datablock update flags flags to dependencies,
100  * use this right before updating to mark all the needed datablocks for update.
101  *
102  * DAG_ids_check_recalc and DAG_ids_clear_recalc are used for external render
103  * engines to detect changes. */
104
105 void DAG_scene_flush_update(struct Main *bmain, struct Scene *sce, unsigned int lay, const short do_time);
106 void DAG_ids_flush_tagged(struct Main *bmain);
107 void DAG_ids_check_recalc(struct Main *bmain, struct Scene *scene, int time);
108 void DAG_ids_clear_recalc(struct Main *bmain);
109
110 /* Armature: sorts the bones according to dependencies between them */
111
112 void DAG_pose_sort(struct Object *ob);
113
114 /* Editors: callbacks to notify editors of datablock changes */
115
116 void DAG_editors_update_cb(void (*id_func)(struct Main *bmain, struct ID *id),
117                            void (*scene_func)(struct Main *bmain, struct Scene *scene, int updated));
118
119 /* ** Threaded update ** */
120
121 /* Global initialization/deinitialization */
122 void DAG_threaded_init(void);
123 void DAG_threaded_exit(void);
124
125 /* Initialize the DAG for threaded update. */
126 void DAG_threaded_update_begin(struct Scene *scene);
127
128 /* Run a callback for every node which is ready for update. */
129 void DAG_threaded_update_foreach_ready_node(struct Scene *scene,
130                                             void (*func)(void *node, void *user_data),
131                                             void *user_data);
132
133 struct Object *DAG_threaded_update_get_node_object(void *node_v);
134
135 const char *DAG_threaded_update_get_node_name(void *node_v);
136
137 void DAG_threaded_update_handle_node_updated(void *node_v,
138                                              void (*func)(void *node, void *user_data),
139                                              void *user_data);
140
141 /* Debugging: print dependency graph for scene or armature object to console */
142
143 void DAG_print_dependencies(struct Main *bmain, struct Scene *scene, struct Object *ob);
144
145 #ifdef __cplusplus
146 }
147 #endif
148                 
149 #endif