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