Filling in branch from trunk
[blender.git] / source / blender / blenkernel / BKE_depsgraph.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2004 Blender Foundation.
24  * All rights reserved.
25  *
26  * Contributor(s): none yet.
27  *
28  * ***** END GPL/BL DUAL LICENSE BLOCK *****
29  */
30
31 #ifndef DEPSGRAPH_API
32 #define DEPSGRAPH_API
33
34 /*
35 #define DEPS_DEBUG
36 */
37
38 struct Scene;
39 struct DagNodeQueue;
40 struct DagForest;
41 struct DagNode;
42
43 /* **** DAG relation types *** */
44
45         /* scene link to object */
46 #define DAG_RL_SCENE            1
47         /* object link to data */
48 #define DAG_RL_DATA                     2
49
50         /* object changes object (parent, track, constraints) */
51 #define DAG_RL_OB_OB            4
52         /* object changes obdata (hooks, constraints) */
53 #define DAG_RL_OB_DATA          8
54         /* data changes object (vertex parent) */
55 #define DAG_RL_DATA_OB          16
56         /* data changes data (deformers) */
57 #define DAG_RL_DATA_DATA        32
58
59 #define DAG_NO_RELATION         64
60 #define DAG_RL_ALL                      63
61 #define DAG_RL_ALL_BUT_DATA 61
62
63
64 typedef void (*graph_action_func)(void * ob, void **data);
65
66 // queues are returned by all BFS & DFS queries
67 // opaque type
68 void    *pop_ob_queue(struct DagNodeQueue *queue);
69 int             queue_count(struct DagNodeQueue *queue);
70 void    queue_delete(struct DagNodeQueue *queue);
71
72 // queries
73 struct DagForest        *build_dag(struct Scene *sce, short mask);
74 void                            free_forest(struct DagForest *Dag);
75
76 // note :
77 // the meanings of the 2 returning values is a bit different :
78 // BFS return 1 for cross-edges and back-edges. the latter are considered harmfull, not the former
79 // DFS return 1 only for back-edges
80 int pre_and_post_BFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
81 int pre_and_post_DFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
82
83 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);
84 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);
85
86 struct DagNodeQueue *get_obparents(struct DagForest     *dag, void *ob); 
87 struct DagNodeQueue *get_first_ancestors(struct DagForest       *dag, void *ob); 
88 struct DagNodeQueue *get_all_childs(struct DagForest    *dag, void *ob); //
89 short           are_obs_related(struct DagForest        *dag, void *ob1, void *ob2);
90 int                                     is_acyclic(struct DagForest     *dag); //
91 //int                                   get_cycles(struct DagForest     *dag, struct DagNodeQueue **queues, int *count); //
92
93 void    boundbox_deps(void);
94 void    draw_all_deps(void);
95
96 /* ********** API *************** */
97 /* Note that the DAG never executes changes in Objects, only sets flags in Objects */
98
99 void    DAG_scene_sort(struct Scene *sce);
100
101                 /* flag all objects that need recalc because they're animated */
102 void    DAG_scene_update_flags(struct Scene *sce, unsigned int lay);
103                 /* flag all objects that need recalc because they're animated, influencing this object only */
104 void    DAG_object_update_flags(struct Scene *sce, struct Object *ob, unsigned int lay);
105
106                 /* flushes all recalc flags in objects down the dependency tree */
107 void    DAG_scene_flush_update(struct Scene *sce, unsigned int lay);
108                 /* flushes all recalc flags for this object down the dependency tree */
109 void    DAG_object_flush_update(struct Scene *sce, struct Object *ob, short flag);
110
111 void    DAG_pose_sort(struct Object *ob);
112                 
113 #endif