Patch to change license to GPL only, from GSR.
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /*
32 #define DEPS_DEBUG
33 */
34
35 struct Scene;
36 struct DagNodeQueue;
37 struct DagForest;
38 struct DagNode;
39
40 /* **** DAG relation types *** */
41
42         /* scene link to object */
43 #define DAG_RL_SCENE            1
44         /* object link to data */
45 #define DAG_RL_DATA                     2
46
47         /* object changes object (parent, track, constraints) */
48 #define DAG_RL_OB_OB            4
49         /* object changes obdata (hooks, constraints) */
50 #define DAG_RL_OB_DATA          8
51         /* data changes object (vertex parent) */
52 #define DAG_RL_DATA_OB          16
53         /* data changes data (deformers) */
54 #define DAG_RL_DATA_DATA        32
55
56 #define DAG_NO_RELATION         64
57 #define DAG_RL_ALL                      63
58 #define DAG_RL_ALL_BUT_DATA 61
59
60
61 typedef void (*graph_action_func)(void * ob, void **data);
62
63 // queues are returned by all BFS & DFS queries
64 // opaque type
65 void    *pop_ob_queue(struct DagNodeQueue *queue);
66 int             queue_count(struct DagNodeQueue *queue);
67 void    queue_delete(struct DagNodeQueue *queue);
68
69 // queries
70 struct DagForest        *build_dag(struct Scene *sce, short mask);
71 void                            free_forest(struct DagForest *Dag);
72
73 // note :
74 // the meanings of the 2 returning values is a bit different :
75 // BFS return 1 for cross-edges and back-edges. the latter are considered harmfull, not the former
76 // DFS return 1 only for back-edges
77 int pre_and_post_BFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
78 int pre_and_post_DFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
79
80 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);
81 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);
82
83 struct DagNodeQueue *get_obparents(struct DagForest     *dag, void *ob); 
84 struct DagNodeQueue *get_first_ancestors(struct DagForest       *dag, void *ob); 
85 struct DagNodeQueue *get_all_childs(struct DagForest    *dag, void *ob); //
86 short           are_obs_related(struct DagForest        *dag, void *ob1, void *ob2);
87 int                                     is_acyclic(struct DagForest     *dag); //
88 //int                                   get_cycles(struct DagForest     *dag, struct DagNodeQueue **queues, int *count); //
89
90 void    boundbox_deps(void);
91 void    draw_all_deps(void);
92
93 /* ********** API *************** */
94 /* Note that the DAG never executes changes in Objects, only sets flags in Objects */
95
96 void    DAG_scene_sort(struct Scene *sce);
97
98                 /* flag all objects that need recalc because they're animated */
99 void    DAG_scene_update_flags(struct Scene *sce, unsigned int lay);
100                 /* flag all objects that need recalc because they're animated, influencing this object only */
101 void    DAG_object_update_flags(struct Scene *sce, struct Object *ob, unsigned int lay);
102
103                 /* flushes all recalc flags in objects down the dependency tree */
104 void    DAG_scene_flush_update(struct Scene *sce, unsigned int lay);
105                 /* flushes all recalc flags for this object down the dependency tree */
106 void    DAG_object_flush_update(struct Scene *sce, struct Object *ob, short flag);
107
108 void    DAG_pose_sort(struct Object *ob);
109                 
110 #endif