bugfix [#25208] randomize transform doesn't work on objects with keyframes
[blender-staging.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 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 /*
36 #define DEPS_DEBUG
37 */
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
51         /* object link to data */
52 #define DAG_RL_DATA                     2
53
54         /* object changes object (parent, track, constraints) */
55 #define DAG_RL_OB_OB            4
56         /* object changes obdata (hooks, constraints) */
57 #define DAG_RL_OB_DATA          8
58         /* data changes object (vertex parent) */
59 #define DAG_RL_DATA_OB          16
60         /* data changes data (deformers) */
61 #define DAG_RL_DATA_DATA        32
62
63 #define DAG_NO_RELATION         64
64 #define DAG_RL_ALL                      63
65 #define DAG_RL_ALL_BUT_DATA 61
66
67
68 typedef void (*graph_action_func)(void * ob, void **data);
69
70 // queues are returned by all BFS & DFS queries
71 // opaque type
72 void    *pop_ob_queue(struct DagNodeQueue *queue);
73 int             queue_count(struct DagNodeQueue *queue);
74 void    queue_delete(struct DagNodeQueue *queue);
75
76 // queries
77 struct DagForest        *build_dag(struct Main *bmain, struct Scene *sce, short mask);
78 void                            free_forest(struct DagForest *Dag);
79
80 // note :
81 // the meanings of the 2 returning values is a bit different :
82 // BFS return 1 for cross-edges and back-edges. the latter are considered harmfull, not the former
83 // DFS return 1 only for back-edges
84 int pre_and_post_BFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
85 int pre_and_post_DFS(struct DagForest *dag, short mask, graph_action_func pre_func, graph_action_func post_func, void **data);
86
87 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);
88 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);
89
90 struct DagNodeQueue *get_obparents(struct DagForest     *dag, void *ob); 
91 struct DagNodeQueue *get_first_ancestors(struct DagForest       *dag, void *ob); 
92 struct DagNodeQueue *get_all_childs(struct DagForest    *dag, void *ob); //
93 short           are_obs_related(struct DagForest        *dag, void *ob1, void *ob2);
94 int                                     is_acyclic(struct DagForest     *dag); //
95 //int                                   get_cycles(struct DagForest     *dag, struct DagNodeQueue **queues, int *count); //
96
97 void    boundbox_deps(void);
98 void    draw_all_deps(void);
99
100 /* ********** API *************** */
101 /* Note that the DAG never executes changes in Objects, only sets flags in Objects */
102
103                 /* (re)-create dependency graph for scene */
104 void    DAG_scene_sort(struct Main *bmain, struct Scene *sce);
105
106                 /* flag all objects that need recalc because they're animated */
107 void    DAG_scene_update_flags(struct Main *bmain, struct Scene *sce, unsigned int lay, const short do_time);
108                 /* flushes all recalc flags in objects down the dependency tree */
109 void    DAG_scene_flush_update(struct Main *bmain, struct Scene *sce, unsigned int lay, const short do_time);
110                 /* tag objects for update on file load */
111 void    DAG_on_load_update(struct Main *bmain, const short do_time);
112
113                 /* when setting manual RECALC flags, call this afterwards */
114 void    DAG_ids_flush_update(struct Main *bmain, int time);
115
116                 /* tag datablock to get updated for the next redraw */
117 void    DAG_id_tag_update(struct ID *id, short flag);
118                 /* flush all tagged updates */
119 void    DAG_ids_flush_tagged(struct Main *bmain);
120
121                 /* (re)-create dependency graph for armature pose */
122 void    DAG_pose_sort(struct Object *ob);
123
124                 /* callback for editors module to do updates */
125 void    DAG_editors_update_cb(void (*func)(struct Main *bmain, struct ID *id));
126
127 #ifdef __cplusplus
128 }
129 #endif
130                 
131 #endif