5f20939fc236c75e5ea2013368088c021f81c0c5
[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;
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
96 #
97 #
98 typedef struct bNodePreview {
99         float *rect;
100         short xsize, ysize;
101 } bNodePreview;
102
103
104 /* limit data in bNode to what we want to see saved? */
105 typedef struct bNode {
106         struct bNode *next, *prev, *new_node;
107         
108         char name[32];
109         short type, flag;
110         short done, level;              /* both for dependency and sorting */
111         short lasty, menunr;    /* lasty: check preview render status, menunr: browse ID blocks */
112         short stack_index;              /* for groupnode, offset in global caller stack */
113         short nr;                               /* number of this node in list, used for UI exec events */
114         
115         ListBase inputs, outputs;
116         struct ID *id;                  /* optional link to libdata */
117         void *storage;                  /* custom data, must be struct, for storage in file */
118         
119         float locx, locy;               /* root offset for drawing */
120         float width, miniwidth;                 
121         short custom1, custom2; /* to be abused for buttons */
122         
123         short need_exec, exec;  /* need_exec is set as UI execution event, exec is flag during exec */
124         
125         rctf totr;                              /* entire boundbox */
126         rctf butr;                              /* optional buttons area */
127         rctf prvr;                              /* optional preview area */
128         bNodePreview *preview;  /* optional preview image */
129         
130         struct bNodeType *typeinfo;     /* lookup of callbacks and defaults */
131         
132 } bNode;
133
134 /* node->flag */
135 #define NODE_SELECT                     1
136 #define NODE_OPTIONS            2
137 #define NODE_PREVIEW            4
138 #define NODE_HIDDEN                     8
139 #define NODE_ACTIVE                     16
140 #define NODE_ACTIVE_ID          32
141 #define NODE_DO_OUTPUT          64
142 #define NODE_GROUP_EDIT         128
143                 /* free test flag, undefined */
144 #define NODE_TEST                       256
145
146 typedef struct bNodeLink {
147         struct bNodeLink *next, *prev;
148         
149         bNode *fromnode, *tonode;
150         bNodeSocket *fromsock, *tosock;
151         
152 } bNodeLink;
153
154 /* the basis for a Node tree, all links and nodes reside internal here */
155 /* only re-usable node trees are in the library though, materials allocate own tree struct */
156 typedef struct bNodeTree {
157         ID id;
158         
159         ListBase nodes, links;
160         
161         bNodeStack **stack;                             /* stack is only while executing, no read/write in file */
162         
163         int type, init;                                 /* set init on fileread */
164         int stacksize;                                  /* amount of elements in stack */
165         int cur_index;                                  /* sockets in groups have unique identifiers, adding new sockets always 
166                                                                            will increase this counter */
167         ListBase alltypes;                              /* type definitions */
168         struct bNodeType *owntype;              /* for groups or dynamic trees, no read/write */
169
170         /* callbacks */
171         void (*timecursor)(int nr);
172         void (*stats_draw)(char *str);
173         int (*test_break)(void);
174 } bNodeTree;
175
176 /* ntree->type, index */
177 #define NTREE_SHADER    0
178 #define NTREE_COMPOSIT  1
179
180 /* ntree->init, flag */
181 #define NTREE_TYPE_INIT 1
182 #define NTREE_EXEC_INIT 2
183
184 /* data structs, for node->storage */
185
186 /* this one has been replaced with ImageUser, keep it for do_versions() */
187 typedef struct NodeImageAnim {
188         int frames, sfra, nr;
189         char cyclic, movie;
190         short pad;
191 } NodeImageAnim;
192
193 typedef struct NodeBlurData {
194         short sizex, sizey, samples, maxspeed, minspeed, pad1;
195         float fac;
196         short filtertype;
197         char bokeh, gamma;
198         int pad2;
199 } NodeBlurData;
200
201 typedef struct NodeHueSat {
202         float hue, sat, val;
203 } NodeHueSat;
204
205 typedef struct NodeImageFile {
206         char name[256];
207         short imtype, subimtype, quality, codec;
208         int sfra, efra;
209 } NodeImageFile;
210
211 typedef struct NodeChroma {
212         float t1,t2,t3;
213         float fsize,fstrength,falpha;
214         float key[4];
215 } NodeChroma;
216
217 typedef struct NodeTwoXYs {
218         short x1, x2, y1, y2;
219 } NodeTwoXYs;
220
221 typedef struct NodeGeometry {
222         char uvname[32];
223         char colname[32];
224 } NodeGeometry;
225
226 typedef struct NodeVertexCol {
227         char name[32];
228 } NodeVertexCol;
229
230 /* qdn: Defocus blur node */
231 typedef struct NodeDefocus {
232         char bktype, rotation, preview, gamco;
233         short samples, no_zbuf;
234         float fstop, maxblur, bthresh, scale;
235 } NodeDefocus;
236
237
238 /* qdn: glare node */
239 typedef struct NodeGlare {
240         char quality, type, iter;
241         char angle, angle_ofs, size, pad[2];
242         float colmod, mix, threshold, fade;
243 } NodeGlare;
244
245 /* qdn: tonemap node */
246 typedef struct NodeTonemap {
247         float key, offset, gamma;
248         float f, m, a, c;
249         int type;
250 } NodeTonemap;
251
252 /* qdn: lens distortion node */
253 typedef struct NodeLensDist {
254         short jit, proj, fit, pad;
255 } NodeLensDist;
256
257 #endif