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