- UNUSED macro wasn't throwing an error with GCC if a var become used.
[blender.git] / source / blender / blenkernel / depsgraph_private.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 #ifndef DEPSGRAPH_PRIVATE
28 #define DEPSGRAPH_PRIVATE
29
30 #include "BKE_depsgraph.h"
31 #include "DNA_constraint_types.h"
32 #include "BKE_constraint.h"
33
34
35 #define DEPSX   5.0f
36 #define DEPSY   1.8f
37
38 #define DAGQUEUEALLOC 50
39
40 enum {
41         DAG_WHITE = 0,
42         DAG_GRAY = 1,
43         DAG_BLACK = 2
44 };
45
46
47
48 typedef struct DagAdjList
49 {
50         struct DagNode *node;
51         short type;
52         int count;                      // number of identical arcs
53         unsigned int lay;   // for flushing redraw/rebuild events
54         char *name;
55         struct DagAdjList *next;
56 } DagAdjList;
57
58
59 typedef struct DagNode 
60 {
61         int color;
62         short type;
63         float x, y, k;  
64         void * ob;
65         void * first_ancestor;
66         int ancestor_count;
67         int lay;                        // accumulated layers of its relations + itself
68         int scelay;                     // layers due to being in scene
69         int lasttime;           // if lasttime != DagForest->time, this node was not evaluated yet for flushing
70         int BFS_dist;           // BFS distance
71         int DFS_dist;           // DFS distance
72         int DFS_dvtm;           // DFS discovery time
73         int DFS_fntm;           // DFS Finishing time
74         struct DagAdjList *child;
75         struct DagAdjList *parent;
76         struct DagNode *next;
77 } DagNode;
78
79 typedef struct DagNodeQueueElem {
80         struct DagNode *node;
81         struct DagNodeQueueElem *next;
82 } DagNodeQueueElem;
83
84 typedef struct DagNodeQueue
85 {
86         DagNodeQueueElem *first;
87         DagNodeQueueElem *last;
88         int count;
89         int maxlevel;
90         struct DagNodeQueue *freenodes;
91 } DagNodeQueue;
92
93 // forest as we may have more than one DAG unnconected
94 typedef struct DagForest 
95 {
96         ListBase DagNode;
97         struct GHash *nodeHash;
98         int numNodes;
99         int is_acyclic;
100         int time;               // for flushing/tagging, compare with node->lasttime
101 } DagForest;
102
103
104 // queue operations
105 DagNodeQueue * queue_create (int slots);
106 void queue_raz(DagNodeQueue *queue);
107 void push_queue(DagNodeQueue *queue, DagNode *node);
108 void push_stack(DagNodeQueue *queue, DagNode *node);
109 DagNode * pop_queue(DagNodeQueue *queue);
110 DagNode * get_top_node_queue(DagNodeQueue *queue);
111
112 // Dag management
113 DagForest *getMainDag(void);
114 void setMainDag(DagForest *dag);
115 DagForest * dag_init(void);
116 DagNode * dag_find_node (DagForest *forest,void * fob);
117 DagNode * dag_add_node (DagForest *forest,void * fob);
118 DagNode * dag_get_node (DagForest *forest,void * fob);
119 DagNode * dag_get_sub_node (DagForest *forest,void * fob);
120 void dag_add_relation(DagForest *forest, DagNode *fob1, DagNode *fob2, short rel, char *name);
121
122 void graph_bfs(void);
123
124 DagNodeQueue * graph_dfs(void);
125
126 void set_node_xy(DagNode *node, float x, float y);
127 void graph_print_queue(DagNodeQueue *nqueue);
128 void graph_print_queue_dist(DagNodeQueue *nqueue);
129 void graph_print_adj_list(void);
130
131 int build_deps(short mask);
132
133 #endif