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