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