Correction for own recent commit -- didn't know it's unsupported in
[blender.git] / source / blender / blenkernel / BKE_depsgraph.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2004 Blender Foundation.
21  * All rights reserved.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef DEPSGRAPH_API
29 #define DEPSGRAPH_API
30
31 /** \file BKE_depsgraph.h
32  *  \ingroup bke
33  */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /*
40 #define DEPS_DEBUG
41 */
42
43 struct ID;
44 struct Main;
45 struct Scene;
46 struct DagNodeQueue;
47 struct DagForest;
48 struct DagNode;
49 struct GHash;
50
51 /* **** DAG relation types *** */
52
53         /* scene link to object */
54 #define DAG_RL_SCENE            (1<<0)
55         /* object link to data */
56 #define DAG_RL_DATA                     (1<<1)
57
58         /* object changes object (parent, track, constraints) */
59 #define DAG_RL_OB_OB            (1<<2)
60         /* object changes obdata (hooks, constraints) */
61 #define DAG_RL_OB_DATA          (1<<3)
62         /* data changes object (vertex parent) */
63 #define DAG_RL_DATA_OB          (1<<4)
64         /* data changes data (deformers) */
65 #define DAG_RL_DATA_DATA        (1<<5)
66
67 #define DAG_NO_RELATION         (1<<6)
68
69 #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)
70 #define DAG_RL_ALL                      (DAG_RL_ALL_BUT_DATA|DAG_RL_DATA)
71
72
73 typedef void (*graph_action_func)(void * ob, void **data);
74
75 // queues are returned by all BFS & DFS queries
76 // opaque type
77 void    *pop_ob_queue(struct DagNodeQueue *queue);
78 int             queue_count(struct DagNodeQueue *queue);
79 void    queue_delete(struct DagNodeQueue *queue);
80
81 // queries
82 struct DagForest        *build_dag(struct Main *bmain, struct Scene *sce, short mask);
83 void                            free_forest(struct DagForest *Dag);
84
85 // note :
86 // the meanings of the 2 returning values is a bit different :
87 // BFS return 1 for cross-edges and back-edges. the latter are considered harmfull, not the former
88 // DFS return 1 only for back-edges
89 int pre_and_post_BFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
90 int pre_and_post_DFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
91
92 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);
93 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);
94
95 struct DagNodeQueue *get_obparents(struct DagForest     *dag, void *ob); 
96 struct DagNodeQueue *get_first_ancestors(struct DagForest       *dag, void *ob); 
97 struct DagNodeQueue *get_all_childs(struct DagForest    *dag, void *ob); //
98 short           are_obs_related(struct DagForest        *dag, void *ob1, void *ob2);
99 int                                     is_acyclic(struct DagForest     *dag); //
100 //int                                   get_cycles(struct DagForest     *dag, struct DagNodeQueue **queues, int *count); //
101
102 void    boundbox_deps(void);
103 void    draw_all_deps(void);
104
105 /* ********** API *************** */
106 /* Note that the DAG never executes changes in Objects, only sets flags in Objects */
107
108                 /* (re)-create dependency graph for scene */
109 void    DAG_scene_sort(struct Main *bmain, struct Scene *sce);
110
111                 /* flag all objects that need recalc because they're animated */
112 void    DAG_scene_update_flags(struct Main *bmain, struct Scene *sce, unsigned int lay, const short do_time);
113                 /* flushes all recalc flags in objects down the dependency tree */
114 void    DAG_scene_flush_update(struct Main *bmain, struct Scene *sce, unsigned int lay, const short do_time);
115                 /* tag objects for update on file load */
116 void    DAG_on_visible_update(struct Main *bmain, const short do_time);
117
118                 /* when setting manual RECALC flags, call this afterwards */
119 void    DAG_ids_flush_update(struct Main *bmain, int time);
120
121                 /* tag datablock to get updated for the next redraw */
122 void    DAG_id_tag_update(struct ID *id, short flag);
123                 /* flush all tagged updates */
124 void    DAG_ids_flush_tagged(struct Main *bmain);
125
126                 /* (re)-create dependency graph for armature pose */
127 void    DAG_pose_sort(struct Object *ob);
128
129                 /* callback for editors module to do updates */
130 void    DAG_editors_update_cb(void (*func)(struct Main *bmain, struct ID *id));
131
132 #ifdef __cplusplus
133 }
134 #endif
135                 
136 #endif