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