Patch #7897 Texture Nodes!
[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
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         float custom3, custom4;
125         
126         short need_exec, exec;  /* need_exec is set as UI execution event, exec is flag during exec */
127         
128         rctf totr;                              /* entire boundbox */
129         rctf butr;                              /* optional buttons area */
130         rctf prvr;                              /* optional preview area */
131         bNodePreview *preview;  /* optional preview image */
132         
133         struct bNodeType *typeinfo;     /* lookup of callbacks and defaults */
134         
135 } bNode;
136
137 /* node->flag */
138 #define NODE_SELECT                     1
139 #define NODE_OPTIONS            2
140 #define NODE_PREVIEW            4
141 #define NODE_HIDDEN                     8
142 #define NODE_ACTIVE                     16
143 #define NODE_ACTIVE_ID          32
144 #define NODE_DO_OUTPUT          64
145 #define NODE_GROUP_EDIT         128
146                 /* free test flag, undefined */
147 #define NODE_TEST                       256
148                 /* composite: don't do node but pass on buffer(s) */
149 #define NODE_MUTED                      512
150
151 typedef struct bNodeLink {
152         struct bNodeLink *next, *prev;
153         
154         bNode *fromnode, *tonode;
155         bNodeSocket *fromsock, *tosock;
156         
157 } bNodeLink;
158
159 /* the basis for a Node tree, all links and nodes reside internal here */
160 /* only re-usable node trees are in the library though, materials and textures allocate own tree struct */
161 typedef struct bNodeTree {
162         ID id;
163         
164         ListBase nodes, links;
165         
166         bNodeStack *stack;                              /* stack is only while executing, no read/write in file */
167         struct ListBase *threadstack;   /* same as above */
168         
169         int type, init;                                 /* set init on fileread */
170         int stacksize;                                  /* amount of elements in stack */
171         int cur_index;                                  /* sockets in groups have unique identifiers, adding new sockets always 
172                                                                            will increase this counter */
173         ListBase alltypes;                              /* type definitions */
174         struct bNodeType *owntype;              /* for groups or dynamic trees, no read/write */
175
176         /* selected input/output socket */
177         bNodeSocket *selin;
178         bNodeSocket *selout;
179
180         /* callbacks */
181         void (*timecursor)(int nr);
182         void (*stats_draw)(char *str);
183         int (*test_break)(void);
184 } bNodeTree;
185
186 /* ntree->type, index */
187 #define NTREE_SHADER    0
188 #define NTREE_COMPOSIT  1
189 #define NTREE_TEXTURE   2
190
191 /* ntree->init, flag */
192 #define NTREE_TYPE_INIT 1
193 #define NTREE_EXEC_INIT 2
194
195 /* data structs, for node->storage */
196
197 /* this one has been replaced with ImageUser, keep it for do_versions() */
198 typedef struct NodeImageAnim {
199         int frames, sfra, nr;
200         char cyclic, movie;
201         short pad;
202 } NodeImageAnim;
203
204 typedef struct NodeBlurData {
205         short sizex, sizey;
206         short samples, maxspeed, minspeed, relative;
207         float fac, percentx, percenty;
208         short filtertype;
209         char bokeh, gamma;
210         short curved;
211         short pad;
212         int image_in_width, image_in_height; /* needed for absolute/relative conversions */
213 } NodeBlurData;
214
215 typedef struct NodeDBlurData {
216         float center_x, center_y, distance, angle, spin, zoom;
217         short iter;
218         char wrap, pad;
219 } NodeDBlurData;
220
221 typedef struct NodeBilateralBlurData {
222         float sigma_color, sigma_space;
223         short iter, pad;
224 } NodeBilateralBlurData;
225
226 typedef struct NodeHueSat {
227         float hue, sat, val;
228 } NodeHueSat;
229
230 typedef struct NodeImageFile {
231         char name[256];
232         short imtype, subimtype, quality, codec;
233         int sfra, efra;
234 } NodeImageFile;
235
236 typedef struct NodeChroma {
237         float t1,t2,t3;
238         float fsize,fstrength,falpha;
239         float key[4];
240 } NodeChroma;
241
242 typedef struct NodeTwoXYs {
243         short x1, x2, y1, y2;
244 } NodeTwoXYs;
245
246 typedef struct NodeTwoFloats {
247         float x, y;
248 } NodeTwoFloats;
249
250 typedef struct NodeGeometry {
251         char uvname[32];
252         char colname[32];
253 } NodeGeometry;
254
255 typedef struct NodeVertexCol {
256         char name[32];
257 } NodeVertexCol;
258
259 /* qdn: Defocus blur node */
260 typedef struct NodeDefocus {
261         char bktype, rotation, preview, gamco;
262         short samples, no_zbuf;
263         float fstop, maxblur, bthresh, scale;
264 } NodeDefocus;
265
266 typedef struct NodeScriptDict {
267         void *dict; /* for PyObject *dict */
268         void *node; /* for BPy_Node *node */
269 } NodeScriptDict;
270
271 /* qdn: glare node */
272 typedef struct NodeGlare {
273         char quality, type, iter;
274         char angle, angle_ofs, size, pad[2];
275         float colmod, mix, threshold, fade;
276 } NodeGlare;
277
278 /* qdn: tonemap node */
279 typedef struct NodeTonemap {
280         float key, offset, gamma;
281         float f, m, a, c;
282         int type;
283 } NodeTonemap;
284
285 /* qdn: lens distortion node */
286 typedef struct NodeLensDist {
287         short jit, proj, fit, pad;
288 } NodeLensDist;
289
290 /* TEX_output */
291 typedef struct TexNodeOutput {
292         char name[32];
293 } TexNodeOutput;
294
295 #endif