include cleanup, no functional changes
[blender.git] / source / blender / blenkernel / BKE_node.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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * The Original Code is Copyright (C) 2005 Blender Foundation.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): Bob Holcomb.
29  *
30  * ***** END GPL LICENSE BLOCK *****
31  */
32
33 #ifndef BKE_NODE_H
34 #define BKE_NODE_H
35
36 /* not very important, but the stack solver likes to know a maximum */
37 #define MAX_SOCKET      64
38
39 struct bContext;
40 struct bNode;
41 struct bNodeLink;
42 struct bNodeSocket;
43 struct bNodeStack;
44 struct bNodeTree;
45 struct GPUMaterial;
46 struct GPUNode;
47 struct GPUNodeStack;
48 struct ID;
49 struct ListBase;
50 struct Main;
51 struct MTex;
52 struct PointerRNA;
53 struct rctf;
54 struct RenderData;
55 struct Scene;
56 struct Tex;
57 struct uiLayout;
58
59
60 /* ************** NODE TYPE DEFINITIONS ***** */
61
62 typedef struct bNodeSocketType {
63         int type, limit;
64         char *name;
65         float val1, val2, val3, val4;   /* default alloc value for inputs */
66         float min, max;                                 /* default range for inputs */
67         
68         /* after this line is used internal only */
69         struct bNodeSocket *sock;               /* used during verify_types */
70         struct bNodeSocket *internsock; /* group nodes, the internal socket counterpart */
71         int own_index;                                  /* verify group nodes */
72         
73 } bNodeSocketType;
74
75 typedef struct bNodeType {
76         void *next,*prev;
77         int type;
78         char *name;
79         float width, minwidth, maxwidth;
80         short nclass, flag;
81         
82         bNodeSocketType *inputs, *outputs;
83         
84         char storagename[64];                   /* struct name for DNA */
85         
86         void (*execfunc)(void *data, struct bNode *, struct bNodeStack **, struct bNodeStack **);
87         
88         /* this line is set on startup of blender */
89         void (*uifunc)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
90
91         void (*initfunc)(struct bNode *);
92         void (*freestoragefunc)(struct bNode *);
93         void (*copystoragefunc)(struct bNode *, struct bNode *);
94         
95         /* for use with dynamic typedefs */
96         ID *id;
97         void *pynode; /* holds pointer to python script */
98         void *pydict; /* holds pointer to python script dictionary (scope)*/
99
100         /* gpu */
101         int (*gpufunc)(struct GPUMaterial *mat, struct bNode *node, struct GPUNodeStack *in, struct GPUNodeStack *out);
102
103 } bNodeType;
104
105 /* node->exec, now in use for composites (#define for break is same as ready yes) */
106 #define NODE_PROCESSING 1
107 #define NODE_READY              2
108 #define NODE_BREAK              2
109 #define NODE_FINISHED   4
110 #define NODE_FREEBUFS   8
111 #define NODE_SKIPPED    16
112
113 /* nodetype->nclass, for add-menu and themes */
114 #define NODE_CLASS_INPUT                0
115 #define NODE_CLASS_OUTPUT               1
116 #define NODE_CLASS_OP_COLOR             3
117 #define NODE_CLASS_OP_VECTOR    4
118 #define NODE_CLASS_OP_FILTER    5
119 #define NODE_CLASS_GROUP                6
120 #define NODE_CLASS_FILE                 7
121 #define NODE_CLASS_CONVERTOR    8
122 #define NODE_CLASS_MATTE                9
123 #define NODE_CLASS_DISTORT              10
124 #define NODE_CLASS_OP_DYNAMIC   11
125 #define NODE_CLASS_PATTERN 12
126 #define NODE_CLASS_TEXTURE 13
127
128 /* ************** GENERIC API, TREES *************** */
129
130 void                    ntreeVerifyTypes(struct bNodeTree *ntree);
131
132 struct bNodeTree *ntreeAddTree(int type);
133 void                    ntreeInitTypes(struct bNodeTree *ntree);
134
135 void                    ntreeMakeOwnType(struct bNodeTree *ntree);
136 void                    ntreeUpdateType(struct bNodeTree *ntree, struct bNodeType *ntype);
137 void                    ntreeFreeTree(struct bNodeTree *ntree);
138 struct bNodeTree *ntreeCopyTree(struct bNodeTree *ntree, int internal_select);
139 void                    ntreeMakeLocal(struct bNodeTree *ntree);
140
141 void                    ntreeSocketUseFlags(struct bNodeTree *ntree);
142
143 void                    ntreeSolveOrder(struct bNodeTree *ntree);
144
145 void                    ntreeBeginExecTree(struct bNodeTree *ntree);
146 void                    ntreeExecTree(struct bNodeTree *ntree, void *callerdata, int thread);
147 void                    ntreeCompositExecTree(struct bNodeTree *ntree, struct RenderData *rd, int do_previews);
148 void                    ntreeEndExecTree(struct bNodeTree *ntree);
149
150 void                    ntreeInitPreview(struct bNodeTree *, int xsize, int ysize);
151 void                    ntreeClearPreview(struct bNodeTree *ntree);
152
153 void                    ntreeFreeCache(struct bNodeTree *ntree);
154                                 
155                                 /* calls allowing threaded composite */
156 struct bNodeTree *ntreeLocalize(struct bNodeTree *ntree);
157 void                    ntreeLocalSync(struct bNodeTree *localtree, struct bNodeTree *ntree);
158 void                    ntreeLocalMerge(struct bNodeTree *localtree, struct bNodeTree *ntree);
159
160 /* ************** GENERIC API, NODES *************** */
161
162 void                    nodeVerifyType(struct bNodeTree *ntree, struct bNode *node);
163
164 void                    nodeAddToPreview(struct bNode *, float *, int, int);
165
166 void                    nodeUnlinkNode(struct bNodeTree *ntree, struct bNode *node);
167 void                    nodeUniqueName(struct bNodeTree *ntree, struct bNode *node);
168 void                    nodeAddSockets(struct bNode *node, struct bNodeType *ntype);
169 struct bNode    *nodeAddNodeType(struct bNodeTree *ntree, int type, struct bNodeTree *ngroup, struct ID *id);
170 void                    nodeRegisterType(struct ListBase *typelist, const struct bNodeType *ntype) ;
171 void                    nodeUpdateType(struct bNodeTree *ntree, struct bNode* node, struct bNodeType *ntype);
172 void                    nodeMakeDynamicType(struct bNode *node);
173 int                             nodeDynamicUnlinkText(struct ID *txtid);
174 void                    nodeFreeNode(struct bNodeTree *ntree, struct bNode *node);
175 struct bNode    *nodeCopyNode(struct bNodeTree *ntree, struct bNode *node, int internal);
176
177 struct bNodeLink *nodeAddLink(struct bNodeTree *ntree, struct bNode *fromnode, struct bNodeSocket *fromsock, struct bNode *tonode, struct bNodeSocket *tosock);
178 void                    nodeRemLink(struct bNodeTree *ntree, struct bNodeLink *link);
179 void                    nodeRemSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
180
181 struct bNode    *nodeFindNodebyName(struct bNodeTree *ntree, const char *name);
182 int                     nodeFindNode(struct bNodeTree *ntree, struct bNodeSocket *sock, struct bNode **nodep, int *sockindex);
183
184 struct bNodeLink *nodeFindLink(struct bNodeTree *ntree, struct bNodeSocket *from, struct bNodeSocket *to);
185 int                             nodeCountSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
186
187 void                    nodeSetActive(struct bNodeTree *ntree, struct bNode *node);
188 struct bNode    *nodeGetActive(struct bNodeTree *ntree);
189 struct bNode    *nodeGetActiveID(struct bNodeTree *ntree, short idtype);
190 int                             nodeSetActiveID(struct bNodeTree *ntree, short idtype, struct ID *id);
191 void                    nodeClearActiveID(struct bNodeTree *ntree, short idtype);
192
193 void                    NodeTagChanged(struct bNodeTree *ntree, struct bNode *node);
194 void                    NodeTagIDChanged(struct bNodeTree *ntree, struct ID *id);
195
196 /* ************** Groups ****************** */
197
198 struct bNode    *nodeMakeGroupFromSelected(struct bNodeTree *ntree);
199 int                             nodeGroupUnGroup(struct bNodeTree *ntree, struct bNode *gnode);
200
201 void                    nodeVerifyGroup(struct bNodeTree *ngroup);
202 void                    nodeGroupSocketUseFlags(struct bNodeTree *ngroup);
203
204 void                    nodeCopyGroup(struct bNode *gnode);
205
206 /* ************** COMMON NODES *************** */
207
208 #define NODE_GROUP              2
209 #define NODE_GROUP_MENU         1000
210 #define NODE_DYNAMIC_MENU       4000
211
212 extern bNodeType node_group_typeinfo;
213
214
215 /* ************** SHADER NODES *************** */
216
217 struct ShadeInput;
218 struct ShadeResult;
219
220 /* note: types are needed to restore callbacks, don't change values */
221 /* range 1 - 100 is reserved for common nodes */
222 /* using toolbox, we add node groups by assuming the values below don't exceed NODE_GROUP_MENU for now */
223
224 #define SH_NODE_OUTPUT          1
225
226 #define SH_NODE_MATERIAL        100
227 #define SH_NODE_RGB                     101
228 #define SH_NODE_VALUE           102
229 #define SH_NODE_MIX_RGB         103
230 #define SH_NODE_VALTORGB        104
231 #define SH_NODE_RGBTOBW         105
232 #define SH_NODE_TEXTURE         106
233 #define SH_NODE_NORMAL          107
234 #define SH_NODE_GEOMETRY        108
235 #define SH_NODE_MAPPING         109
236 #define SH_NODE_CURVE_VEC       110
237 #define SH_NODE_CURVE_RGB       111
238 #define SH_NODE_CAMERA          114
239 #define SH_NODE_MATH            115
240 #define SH_NODE_VECT_MATH       116
241 #define SH_NODE_SQUEEZE         117
242 #define SH_NODE_MATERIAL_EXT    118
243 #define SH_NODE_INVERT          119
244 #define SH_NODE_SEPRGB          120
245 #define SH_NODE_COMBRGB         121
246 #define SH_NODE_HUE_SAT         122
247 #define NODE_DYNAMIC            123
248
249 /* custom defines options for Material node */
250 #define SH_NODE_MAT_DIFF   1
251 #define SH_NODE_MAT_SPEC   2
252 #define SH_NODE_MAT_NEG    4
253 /* custom defines: states for Script node. These are bit indices */
254 #define NODE_DYNAMIC_READY      0 /* 1 */
255 #define NODE_DYNAMIC_LOADED     1 /* 2 */
256 #define NODE_DYNAMIC_NEW        2 /* 4 */
257 #define NODE_DYNAMIC_UPDATED    3 /* 8 */
258 #define NODE_DYNAMIC_ADDEXIST   4 /* 16 */
259 #define NODE_DYNAMIC_ERROR      5 /* 32 */
260 #define NODE_DYNAMIC_REPARSE    6 /* 64 */
261 #define NODE_DYNAMIC_SET        15 /* sign */
262
263 /* the type definitions array */
264 extern struct ListBase node_all_shaders;
265
266 /* API */
267
268 void                    ntreeShaderExecTree(struct bNodeTree *ntree, struct ShadeInput *shi, struct ShadeResult *shr);
269 void                    ntreeShaderGetTexcoMode(struct bNodeTree *ntree, int osa, short *texco, int *mode);
270 void                    nodeShaderSynchronizeID(struct bNode *node, int copyto);
271
272                                 /* switch material render loop */
273 extern void (*node_shader_lamp_loop)(struct ShadeInput *, struct ShadeResult *);
274 void                    set_node_shader_lamp_loop(void (*lamp_loop_func)(struct ShadeInput *, struct ShadeResult *));
275
276 void                    ntreeGPUMaterialNodes(struct bNodeTree *ntree, struct GPUMaterial *mat);
277
278
279 /* ************** COMPOSITE NODES *************** */
280
281 /* output socket defines */
282 #define RRES_OUT_IMAGE          0
283 #define RRES_OUT_ALPHA          1
284 #define RRES_OUT_Z                      2
285 #define RRES_OUT_NORMAL         3
286 #define RRES_OUT_UV                     4
287 #define RRES_OUT_VEC            5
288 #define RRES_OUT_RGBA           6
289 #define RRES_OUT_DIFF           7
290 #define RRES_OUT_SPEC           8
291 #define RRES_OUT_SHADOW         9
292 #define RRES_OUT_AO                     10
293 #define RRES_OUT_REFLECT        11
294 #define RRES_OUT_REFRACT        12
295 #define RRES_OUT_INDIRECT       13
296 #define RRES_OUT_INDEXOB        14
297 #define RRES_OUT_MIST           15
298 #define RRES_OUT_EMIT           16
299 #define RRES_OUT_ENV            17
300
301 /* note: types are needed to restore callbacks, don't change values */
302 #define CMP_NODE_VIEWER         201
303 #define CMP_NODE_RGB            202
304 #define CMP_NODE_VALUE          203
305 #define CMP_NODE_MIX_RGB        204
306 #define CMP_NODE_VALTORGB       205
307 #define CMP_NODE_RGBTOBW        206
308 #define CMP_NODE_NORMAL         207
309 #define CMP_NODE_CURVE_VEC      208
310 #define CMP_NODE_CURVE_RGB      209
311 #define CMP_NODE_ALPHAOVER      210
312 #define CMP_NODE_BLUR           211
313 #define CMP_NODE_FILTER         212
314 #define CMP_NODE_MAP_VALUE      213
315 #define CMP_NODE_TIME           214
316 #define CMP_NODE_VECBLUR        215
317 #define CMP_NODE_SEPRGBA        216
318 #define CMP_NODE_SEPHSVA        217
319 #define CMP_NODE_SETALPHA       218
320 #define CMP_NODE_HUE_SAT        219
321 #define CMP_NODE_IMAGE          220
322 #define CMP_NODE_R_LAYERS       221
323 #define CMP_NODE_COMPOSITE      222
324 #define CMP_NODE_OUTPUT_FILE    223
325 #define CMP_NODE_TEXTURE        224
326 #define CMP_NODE_TRANSLATE      225
327 #define CMP_NODE_ZCOMBINE       226
328 #define CMP_NODE_COMBRGBA       227
329 #define CMP_NODE_DILATEERODE    228
330 #define CMP_NODE_ROTATE         229
331 #define CMP_NODE_SCALE          230
332 #define CMP_NODE_SEPYCCA        231
333 #define CMP_NODE_COMBYCCA       232
334 #define CMP_NODE_SEPYUVA        233
335 #define CMP_NODE_COMBYUVA       234
336 #define CMP_NODE_DIFF_MATTE     235
337 #define CMP_NODE_COLOR_SPILL    236
338 #define CMP_NODE_CHROMA_MATTE   237
339 #define CMP_NODE_CHANNEL_MATTE  238
340 #define CMP_NODE_FLIP           239
341 #define CMP_NODE_SPLITVIEWER    240
342 #define CMP_NODE_INDEX_MASK     241
343 #define CMP_NODE_MAP_UV         242
344 #define CMP_NODE_ID_MASK        243
345 #define CMP_NODE_DEFOCUS        244
346 #define CMP_NODE_DISPLACE       245
347 #define CMP_NODE_COMBHSVA       246
348 #define CMP_NODE_MATH           247
349 #define CMP_NODE_LUMA_MATTE     248
350 #define CMP_NODE_BRIGHTCONTRAST 249
351 #define CMP_NODE_GAMMA          250
352 #define CMP_NODE_INVERT         251
353 #define CMP_NODE_NORMALIZE      252
354 #define CMP_NODE_CROP           253
355 #define CMP_NODE_DBLUR          254
356 #define CMP_NODE_BILATERALBLUR  255
357 #define CMP_NODE_PREMULKEY  256
358 #define CMP_NODE_DIST_MATTE     257
359 #define CMP_NODE_VIEW_LEVELS    258
360 #define CMP_NODE_COLOR_MATTE 259
361 #define CMP_NODE_COLORBALANCE 260
362 #define CMP_NODE_HUECORRECT 261
363
364 #define CMP_NODE_GLARE          301
365 #define CMP_NODE_TONEMAP        302
366 #define CMP_NODE_LENSDIST       303
367
368 /* channel toggles */
369 #define CMP_CHAN_RGB            1
370 #define CMP_CHAN_A                      2
371 #define CMP_CHAN_R                      4
372 #define CMP_CHAN_G                      8
373 #define CMP_CHAN_B                      16
374
375 /* filter types */
376 #define CMP_FILT_SOFT           0
377 #define CMP_FILT_SHARP          1
378 #define CMP_FILT_LAPLACE        2
379 #define CMP_FILT_SOBEL          3
380 #define CMP_FILT_PREWITT        4
381 #define CMP_FILT_KIRSCH         5
382 #define CMP_FILT_SHADOW         6
383
384 /* scale node type, in custom1 */
385 #define CMP_SCALE_RELATIVE              0
386 #define CMP_SCALE_ABSOLUTE              1
387 #define CMP_SCALE_SCENEPERCENT  2
388 #define CMP_SCALE_RENDERPERCENT 3
389
390
391 /* the type definitions array */
392 extern struct ListBase node_all_composit;
393
394 /* API */
395 struct CompBuf;
396 void ntreeCompositTagRender(struct Scene *sce);
397 int ntreeCompositTagAnimated(struct bNodeTree *ntree);
398 void ntreeCompositTagGenerators(struct bNodeTree *ntree);
399 void ntreeCompositForceHidden(struct bNodeTree *ntree, struct Scene *scene);
400
401 void free_compbuf(struct CompBuf *cbuf); /* internal...*/
402
403
404 /* ************** TEXTURE NODES *************** */
405
406 struct TexResult;
407
408 #define TEX_NODE_OUTPUT     401
409 #define TEX_NODE_CHECKER    402
410 #define TEX_NODE_TEXTURE    403
411 #define TEX_NODE_BRICKS     404
412 #define TEX_NODE_MATH       405
413 #define TEX_NODE_MIX_RGB    406
414 #define TEX_NODE_RGBTOBW    407
415 #define TEX_NODE_VALTORGB   408
416 #define TEX_NODE_IMAGE      409
417 #define TEX_NODE_CURVE_RGB  410
418 #define TEX_NODE_INVERT     411
419 #define TEX_NODE_HUE_SAT    412
420 #define TEX_NODE_CURVE_TIME 413
421 #define TEX_NODE_ROTATE     414
422 #define TEX_NODE_VIEWER     415
423 #define TEX_NODE_TRANSLATE  416
424 #define TEX_NODE_COORD      417
425 #define TEX_NODE_DISTANCE   418
426 #define TEX_NODE_COMPOSE    419
427 #define TEX_NODE_DECOMPOSE  420
428 #define TEX_NODE_VALTONOR   421
429 #define TEX_NODE_SCALE      422
430 #define TEX_NODE_AT         423
431
432 /* 501-599 reserved. Use like this: TEX_NODE_PROC + TEX_CLOUDS, etc */
433 #define TEX_NODE_PROC      500
434 #define TEX_NODE_PROC_MAX  600
435
436 extern struct ListBase node_all_textures;
437
438 /* API */
439 int  ntreeTexTagAnimated(struct bNodeTree *ntree);
440 void ntreeTexSetPreviewFlag(int);
441 int ntreeTexExecTree(struct bNodeTree *ntree, struct TexResult *target, float *coord, float *dxt, float *dyt, int osatex, short thread, struct Tex *tex, short which_output, int cfra, int preview, struct ShadeInput *shi, struct MTex *mtex);
442 void ntreeTexCheckCyclics(struct bNodeTree *ntree);
443 char* ntreeTexOutputMenu(struct bNodeTree *ntree);
444
445
446 /**/
447
448 void init_nodesystem(void);
449 void free_nodesystem(void);
450
451 /**/
452
453 void clear_scene_in_nodes(struct Main *bmain, struct Scene *sce);
454
455 #endif