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