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