style cleanup / comment formatting for bli/bke/bmesh
[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 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 // #define DEPS_DEBUG
38
39 struct ID;
40 struct Main;
41 struct Scene;
42 struct DagNodeQueue;
43 struct DagForest;
44 struct DagNode;
45 struct GHash;
46
47 /* **** DAG relation types *** */
48
49         /* scene link to object */
50 #define DAG_RL_SCENE            (1<<0)
51         /* object link to data */
52 #define DAG_RL_DATA                     (1<<1)
53
54         /* object changes object (parent, track, constraints) */
55 #define DAG_RL_OB_OB            (1<<2)
56         /* object changes obdata (hooks, constraints) */
57 #define DAG_RL_OB_DATA          (1<<3)
58         /* data changes object (vertex parent) */
59 #define DAG_RL_DATA_OB          (1<<4)
60         /* data changes data (deformers) */
61 #define DAG_RL_DATA_DATA        (1<<5)
62
63 #define DAG_NO_RELATION         (1<<6)
64
65 #define DAG_RL_ALL_BUT_DATA (DAG_RL_SCENE|DAG_RL_OB_OB|DAG_RL_OB_DATA|DAG_RL_DATA_OB|DAG_RL_DATA_DATA)
66 #define DAG_RL_ALL                      (DAG_RL_ALL_BUT_DATA|DAG_RL_DATA)
67
68
69 typedef void (*graph_action_func)(void * ob, void **data);
70
71 // queues are returned by all BFS & DFS queries
72 // opaque type
73 void    *pop_ob_queue(struct DagNodeQueue *queue);
74 int             queue_count(struct DagNodeQueue *queue);
75 void    queue_delete(struct DagNodeQueue *queue);
76
77 // queries
78 struct DagForest        *build_dag(struct Main *bmain, struct Scene *sce, short mask);
79 void                            free_forest(struct DagForest *Dag);
80
81 // note :
82 // the meanings of the 2 returning values is a bit different :
83 // BFS return 1 for cross-edges and back-edges. the latter are considered harmfull, not the former
84 // DFS return 1 only for back-edges
85 int pre_and_post_BFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
86 int pre_and_post_DFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
87
88 int pre_and_post_source_BFS(struct DagForest *dag, short mask, struct DagNode *source, graph_action_func pre_func, graph_action_func post_func, void **data);
89 int pre_and_post_source_DFS(struct DagForest *dag, short mask, struct DagNode *source, graph_action_func pre_func, graph_action_func post_func, void **data);
90
91 struct DagNodeQueue *get_obparents(struct DagForest     *dag, void *ob); 
92 struct DagNodeQueue *get_first_ancestors(struct DagForest       *dag, void *ob); 
93 struct DagNodeQueue *get_all_childs(struct DagForest    *dag, void *ob); //
94 short           are_obs_related(struct DagForest        *dag, void *ob1, void *ob2);
95 int                                     is_acyclic(struct DagForest     *dag); //
96 //int                                   get_cycles(struct DagForest     *dag, struct DagNodeQueue **queues, int *count); //
97
98 /* ********** API *************** */
99 /* Note that the DAG never executes changes in Objects, only sets flags in Objects */
100
101                 /* (re)-create dependency graph for scene */
102 void    DAG_scene_sort(struct Main *bmain, struct Scene *sce);
103
104                 /* flag all objects that need recalc because they're animated */
105 void    DAG_scene_update_flags(struct Main *bmain, struct Scene *sce, unsigned int lay, const short do_time);
106                 /* flushes all recalc flags in objects down the dependency tree */
107 void    DAG_scene_flush_update(struct Main *bmain, struct Scene *sce, unsigned int lay, const short do_time);
108                 /* tag objects for update on file load */
109 void    DAG_on_visible_update(struct Main *bmain, const short do_time);
110
111                 /* when setting manual RECALC flags, call this afterwards */
112 void    DAG_ids_flush_update(struct Main *bmain, int time);
113
114                 /* tag datablock to get updated for the next redraw */
115 void    DAG_id_tag_update(struct ID *id, short flag);
116                 /* flush all tagged updates */
117 void    DAG_ids_flush_tagged(struct Main *bmain);
118                 /* check and clear ID recalc flags */
119 void    DAG_ids_check_recalc(struct Main *bmain, struct Scene *scene, int time);
120 void    DAG_ids_clear_recalc(struct Main *bmain);
121                 /* test if any of this id type is tagged for update */
122 void    DAG_id_type_tag(struct Main *bmain, short idtype);
123 int             DAG_id_type_tagged(struct Main *bmain, short idtype);
124
125                 /* (re)-create dependency graph for armature pose */
126 void    DAG_pose_sort(struct Object *ob);
127
128                 /* callback for editors module to do updates */
129 void    DAG_editors_update_cb(void (*id_func)(struct Main *bmain, struct ID *id),
130                               void (*scene_func)(struct Main *bmain, struct Scene *scene, int updated));
131
132                 /* debugging */
133 void    DAG_print_dependencies(struct Main *bmain, struct Scene *scene, struct Object *ob);
134
135 #ifdef __cplusplus
136 }
137 #endif
138                 
139 #endif