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