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