Merge with trunk/2.5 at r25563
[blender-staging.git] / source / blender / makesdna / DNA_node_types.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) 2005 Blender Foundation.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef DNA_NODE_TYPES_H
31 #define DNA_NODE_TYPES_H
32
33 #include "DNA_ID.h"
34 #include "DNA_vec_types.h"
35 #include "DNA_listBase.h"
36
37 struct ListBase;
38 struct SpaceNode;
39 struct bNodeLink;
40 struct bNodeType;
41 struct bNodeGroup;
42 struct AnimData;
43 struct bGPdata;
44 struct uiBlock;
45
46 #define NODE_MAXSTR 32
47
48
49 typedef struct bNodeStack {
50         float vec[4];
51         float min, max;                 /* min/max for values (UI writes it, execute might use it) */
52         void *data;
53         short hasinput;                 /* when input has link, tagged before executing */
54         short hasoutput;                /* when output is linked, tagged before executing */
55         short datatype;                 /* type of data pointer */
56         short sockettype;               /* type of socket stack comes from, to remap linking different sockets */
57 } bNodeStack;
58
59 /* ns->datatype, shadetree only */
60 #define NS_OSA_VECTORS          1
61 #define NS_OSA_VALUES           2
62
63 typedef struct bNodeSocket {
64         struct bNodeSocket *next, *prev, *new_sock;
65         
66         char name[32];
67         bNodeStack ns;                          /* custom data for inputs, only UI writes in this */
68         
69         short type, flag;                       /* type is copy from socket type struct */
70         short limit, stack_index;       /* limit for dependency sort, stack_index for exec */
71         short intern;                           /* intern = tag for group nodes */
72         short stack_index_ext;          /* for groups, to find the caller stack index */
73         int pad1;
74         
75         float locx, locy;
76         
77         /* internal data to retrieve relations and groups */
78         
79         int own_index, to_index;        /* group socket identifiers, to find matching pairs after reading files */
80         
81         struct bNodeSocket *tosock;     /* group-node sockets point to the internal group counterpart sockets, set after read file  */
82         struct bNodeLink *link;         /* a link pointer, set in nodeSolveOrder() */
83         
84 } bNodeSocket;
85
86 /* sock->type */
87 #define SOCK_VALUE              0
88 #define SOCK_VECTOR             1
89 #define SOCK_RGBA               2
90
91 /* sock->flag, first bit is select */
92                 /* hidden is user defined, to hide unused */
93 #define SOCK_HIDDEN                             2
94                 /* only used now for groups... */
95 #define SOCK_IN_USE                             4
96                 /* unavailable is for dynamic sockets */
97 #define SOCK_UNAVAIL                    8
98                 /* flag for selection status */
99 #define SOCK_SEL                        16
100 #
101 #
102 typedef struct bNodePreview {
103         unsigned char *rect;
104         short xsize, ysize;
105 } bNodePreview;
106
107
108 /* limit data in bNode to what we want to see saved? */
109 typedef struct bNode {
110         struct bNode *next, *prev, *new_node;
111         
112         char name[32];
113         short type, flag;
114         short done, level;              /* both for dependency and sorting */
115         short lasty, menunr;    /* lasty: check preview render status, menunr: browse ID blocks */
116         short stack_index;              /* for groupnode, offset in global caller stack */
117         short nr;                               /* number of this node in list, used for UI exec events */
118         
119         ListBase inputs, outputs;
120         struct ID *id;                  /* optional link to libdata */
121         void *storage;                  /* custom data, must be struct, for storage in file */
122         
123         float locx, locy;               /* root offset for drawing */
124         float width, miniwidth;                 
125         short custom1, custom2; /* to be abused for buttons */
126         float custom3, custom4;
127         
128         short need_exec, exec;  /* need_exec is set as UI execution event, exec is flag during exec */
129         void *threaddata;               /* optional extra storage for use in thread (read only then!) */
130         
131         rctf totr;                              /* entire boundbox */
132         rctf butr;                              /* optional buttons area */
133         rctf prvr;                              /* optional preview area */
134         bNodePreview *preview;  /* optional preview image */
135         struct uiBlock *block;  /* runtime during drawing */
136         
137         struct bNodeType *typeinfo;     /* lookup of callbacks and defaults */
138         
139 } bNode;
140
141 /* node->flag */
142 #define NODE_SELECT                     1
143 #define NODE_OPTIONS            2
144 #define NODE_PREVIEW            4
145 #define NODE_HIDDEN                     8
146 #define NODE_ACTIVE                     16
147 #define NODE_ACTIVE_ID          32
148 #define NODE_DO_OUTPUT          64
149 #define NODE_GROUP_EDIT         128
150                 /* free test flag, undefined */
151 #define NODE_TEST                       256
152                 /* composite: don't do node but pass on buffer(s) */
153 #define NODE_MUTED                      512
154 #define NODE_CUSTOM_NAME                1024
155
156 typedef struct bNodeLink {
157         struct bNodeLink *next, *prev;
158         
159         bNode *fromnode, *tonode;
160         bNodeSocket *fromsock, *tosock;
161         
162         int flag, pad;
163         
164 } bNodeLink;
165
166 /* the basis for a Node tree, all links and nodes reside internal here */
167 /* only re-usable node trees are in the library though, materials and textures allocate own tree struct */
168 typedef struct bNodeTree {
169         ID id;
170         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */ 
171         
172         struct bGPdata *gpd;            /* grease pencil data */
173         
174         ListBase nodes, links;
175         
176         bNodeStack *stack;                              /* stack is only while executing, no read/write in file */
177         struct ListBase *threadstack;   /* same as above */
178         
179         int type, init;                                 /* set init on fileread */
180         int stacksize;                                  /* amount of elements in stack */
181         int cur_index;                                  /* sockets in groups have unique identifiers, adding new sockets always 
182                                                                            will increase this counter */
183         int flag, pad;                                  
184         
185         ListBase alltypes;                              /* type definitions */
186         struct bNodeType *owntype;              /* for groups or dynamic trees, no read/write */
187
188         /* selected input/output socket */
189         bNodeSocket *selin;
190         bNodeSocket *selout;
191
192         /* callbacks */
193         void (*timecursor)(void *, int nr);
194         void (*stats_draw)(void *, char *str);
195         int (*test_break)(void *);
196         void *tbh, *tch, *sdh;
197         
198 } bNodeTree;
199
200 /* ntree->type, index */
201 #define NTREE_SHADER    0
202 #define NTREE_COMPOSIT  1
203 #define NTREE_TEXTURE   2
204
205 /* ntree->init, flag */
206 #define NTREE_TYPE_INIT 1
207 #define NTREE_EXEC_INIT 2
208
209 /* ntree->flag */
210 #define NTREE_DS_EXPAND 1       /* for animation editors */
211
212 /* data structs, for node->storage */
213
214 /* this one has been replaced with ImageUser, keep it for do_versions() */
215 typedef struct NodeImageAnim {
216         int frames, sfra, nr;
217         char cyclic, movie;
218         short pad;
219 } NodeImageAnim;
220
221 typedef struct NodeBlurData {
222         short sizex, sizey;
223         short samples, maxspeed, minspeed, relative;
224         float fac, percentx, percenty;
225         short filtertype;
226         char bokeh, gamma;
227         short curved;
228         short pad;
229         int image_in_width, image_in_height; /* needed for absolute/relative conversions */
230 } NodeBlurData;
231
232 typedef struct NodeDBlurData {
233         float center_x, center_y, distance, angle, spin, zoom;
234         short iter;
235         char wrap, pad;
236 } NodeDBlurData;
237
238 typedef struct NodeBilateralBlurData {
239         float sigma_color, sigma_space;
240         short iter, pad;
241 } NodeBilateralBlurData;
242
243 typedef struct NodeHueSat {
244         float hue, sat, val;
245 } NodeHueSat;
246
247 typedef struct NodeImageFile {
248         char name[256];
249         short imtype, subimtype, quality, codec;
250         int sfra, efra;
251 } NodeImageFile;
252
253 typedef struct NodeChroma {
254         float t1,t2,t3;
255         float fsize,fstrength,falpha;
256         float key[4];
257 } NodeChroma;
258
259 typedef struct NodeTwoXYs {
260         short x1, x2, y1, y2;
261 } NodeTwoXYs;
262
263 typedef struct NodeTwoFloats {
264         float x, y;
265 } NodeTwoFloats;
266
267 typedef struct NodeGeometry {
268         char uvname[32];
269         char colname[32];
270 } NodeGeometry;
271
272 typedef struct NodeVertexCol {
273         char name[32];
274 } NodeVertexCol;
275
276 /* qdn: Defocus blur node */
277 typedef struct NodeDefocus {
278         char bktype, rotation, preview, gamco;
279         short samples, no_zbuf;
280         float fstop, maxblur, bthresh, scale;
281 } NodeDefocus;
282
283 typedef struct NodeScriptDict {
284         void *dict; /* for PyObject *dict */
285         void *node; /* for BPy_Node *node */
286 } NodeScriptDict;
287
288 /* qdn: glare node */
289 typedef struct NodeGlare {
290         char quality, type, iter;
291         char angle, angle_ofs, size, pad[2];
292         float colmod, mix, threshold, fade;
293 } NodeGlare;
294
295 /* qdn: tonemap node */
296 typedef struct NodeTonemap {
297         float key, offset, gamma;
298         float f, m, a, c;
299         int type;
300 } NodeTonemap;
301
302 /* qdn: lens distortion node */
303 typedef struct NodeLensDist {
304         short jit, proj, fit, pad;
305 } NodeLensDist;
306
307 /* TEX_output */
308 typedef struct TexNodeOutput {
309         char name[32];
310 } TexNodeOutput;
311
312
313 /* comp channel matte */
314 #define CMP_NODE_CHANNEL_MATTE_CS_RGB   1
315 #define CMP_NODE_CHANNEL_MATTE_CS_HSV   2
316 #define CMP_NODE_CHANNEL_MATTE_CS_YUV   3
317 #define CMP_NODE_CHANNEL_MATTE_CS_YCC   4
318
319 #endif