Material buttons now view the active node material shading settings.
[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 int                             nodeSetActiveID(struct bNodeTree *ntree, short idtype, struct ID *id);
185 void                    nodeClearActiveID(struct bNodeTree *ntree, short idtype);
186
187 void                    NodeTagChanged(struct bNodeTree *ntree, struct bNode *node);
188 void                    NodeTagIDChanged(struct bNodeTree *ntree, struct ID *id);
189
190 /* ************** Groups ****************** */
191
192 struct bNode    *nodeMakeGroupFromSelected(struct bNodeTree *ntree);
193 int                             nodeGroupUnGroup(struct bNodeTree *ntree, struct bNode *gnode);
194
195 void                    nodeVerifyGroup(struct bNodeTree *ngroup);
196 void                    nodeGroupSocketUseFlags(struct bNodeTree *ngroup);
197
198 void                    nodeCopyGroup(struct bNode *gnode);
199
200 /* ************** COMMON NODES *************** */
201
202 #define NODE_GROUP              2
203 #define NODE_GROUP_MENU         1000
204 #define NODE_DYNAMIC_MENU       4000
205
206 extern bNodeType node_group_typeinfo;
207
208
209 /* ************** SHADER NODES *************** */
210
211 struct ShadeInput;
212 struct ShadeResult;
213
214 /* note: types are needed to restore callbacks, don't change values */
215 /* range 1 - 100 is reserved for common nodes */
216 /* using toolbox, we add node groups by assuming the values below don't exceed NODE_GROUP_MENU for now */
217
218 #define SH_NODE_OUTPUT          1
219
220 #define SH_NODE_MATERIAL        100
221 #define SH_NODE_RGB                     101
222 #define SH_NODE_VALUE           102
223 #define SH_NODE_MIX_RGB         103
224 #define SH_NODE_VALTORGB        104
225 #define SH_NODE_RGBTOBW         105
226 #define SH_NODE_TEXTURE         106
227 #define SH_NODE_NORMAL          107
228 #define SH_NODE_GEOMETRY        108
229 #define SH_NODE_MAPPING         109
230 #define SH_NODE_CURVE_VEC       110
231 #define SH_NODE_CURVE_RGB       111
232 #define SH_NODE_CAMERA          114
233 #define SH_NODE_MATH            115
234 #define SH_NODE_VECT_MATH       116
235 #define SH_NODE_SQUEEZE         117
236 #define SH_NODE_MATERIAL_EXT    118
237 #define SH_NODE_INVERT          119
238 #define SH_NODE_SEPRGB          120
239 #define SH_NODE_COMBRGB         121
240 #define SH_NODE_HUE_SAT         122
241 #define NODE_DYNAMIC            123
242
243 /* custom defines options for Material node */
244 #define SH_NODE_MAT_DIFF   1
245 #define SH_NODE_MAT_SPEC   2
246 #define SH_NODE_MAT_NEG    4
247 /* custom defines: states for Script node. These are bit indices */
248 #define NODE_DYNAMIC_READY      0 /* 1 */
249 #define NODE_DYNAMIC_LOADED     1 /* 2 */
250 #define NODE_DYNAMIC_NEW        2 /* 4 */
251 #define NODE_DYNAMIC_UPDATED    3 /* 8 */
252 #define NODE_DYNAMIC_ADDEXIST   4 /* 16 */
253 #define NODE_DYNAMIC_ERROR      5 /* 32 */
254 #define NODE_DYNAMIC_REPARSE    6 /* 64 */
255 #define NODE_DYNAMIC_SET        15 /* sign */
256
257 /* the type definitions array */
258 extern struct ListBase node_all_shaders;
259
260 /* API */
261
262 void                    ntreeShaderExecTree(struct bNodeTree *ntree, struct ShadeInput *shi, struct ShadeResult *shr);
263 void                    ntreeShaderGetTexcoMode(struct bNodeTree *ntree, int osa, short *texco, int *mode);
264 void                    nodeShaderSynchronizeID(struct bNode *node, int copyto);
265
266                                 /* switch material render loop */
267 extern void (*node_shader_lamp_loop)(struct ShadeInput *, struct ShadeResult *);
268 void                    set_node_shader_lamp_loop(void (*lamp_loop_func)(struct ShadeInput *, struct ShadeResult *));
269
270 void                    ntreeGPUMaterialNodes(struct bNodeTree *ntree, struct GPUMaterial *mat);
271
272
273 /* ************** COMPOSITE NODES *************** */
274
275 /* output socket defines */
276 #define RRES_OUT_IMAGE          0
277 #define RRES_OUT_ALPHA          1
278 #define RRES_OUT_Z                      2
279 #define RRES_OUT_NORMAL         3
280 #define RRES_OUT_UV                     4
281 #define RRES_OUT_VEC            5
282 #define RRES_OUT_RGBA           6
283 #define RRES_OUT_DIFF           7
284 #define RRES_OUT_SPEC           8
285 #define RRES_OUT_SHADOW         9
286 #define RRES_OUT_AO                     10
287 #define RRES_OUT_REFLECT        11
288 #define RRES_OUT_REFRACT        12
289 #define RRES_OUT_RADIO          13
290 #define RRES_OUT_INDEXOB        14
291 #define RRES_OUT_MIST           15
292
293 /* note: types are needed to restore callbacks, don't change values */
294 #define CMP_NODE_VIEWER         201
295 #define CMP_NODE_RGB            202
296 #define CMP_NODE_VALUE          203
297 #define CMP_NODE_MIX_RGB        204
298 #define CMP_NODE_VALTORGB       205
299 #define CMP_NODE_RGBTOBW        206
300 #define CMP_NODE_NORMAL         207
301 #define CMP_NODE_CURVE_VEC      208
302 #define CMP_NODE_CURVE_RGB      209
303 #define CMP_NODE_ALPHAOVER      210
304 #define CMP_NODE_BLUR           211
305 #define CMP_NODE_FILTER         212
306 #define CMP_NODE_MAP_VALUE      213
307 #define CMP_NODE_TIME           214
308 #define CMP_NODE_VECBLUR        215
309 #define CMP_NODE_SEPRGBA        216
310 #define CMP_NODE_SEPHSVA        217
311 #define CMP_NODE_SETALPHA       218
312 #define CMP_NODE_HUE_SAT        219
313 #define CMP_NODE_IMAGE          220
314 #define CMP_NODE_R_LAYERS       221
315 #define CMP_NODE_COMPOSITE      222
316 #define CMP_NODE_OUTPUT_FILE    223
317 #define CMP_NODE_TEXTURE        224
318 #define CMP_NODE_TRANSLATE      225
319 #define CMP_NODE_ZCOMBINE       226
320 #define CMP_NODE_COMBRGBA       227
321 #define CMP_NODE_DILATEERODE    228
322 #define CMP_NODE_ROTATE         229
323 #define CMP_NODE_SCALE          230
324 #define CMP_NODE_SEPYCCA        231
325 #define CMP_NODE_COMBYCCA       232
326 #define CMP_NODE_SEPYUVA        233
327 #define CMP_NODE_COMBYUVA       234
328 #define CMP_NODE_DIFF_MATTE     235
329 #define CMP_NODE_COLOR_SPILL    236
330 #define CMP_NODE_CHROMA_MATTE   237
331 #define CMP_NODE_CHANNEL_MATTE  238
332 #define CMP_NODE_FLIP           239
333 #define CMP_NODE_SPLITVIEWER    240
334 #define CMP_NODE_INDEX_MASK     241
335 #define CMP_NODE_MAP_UV         242
336 #define CMP_NODE_ID_MASK        243
337 #define CMP_NODE_DEFOCUS        244
338 #define CMP_NODE_DISPLACE       245
339 #define CMP_NODE_COMBHSVA       246
340 #define CMP_NODE_MATH           247
341 #define CMP_NODE_LUMA_MATTE     248
342 #define CMP_NODE_BRIGHTCONTRAST 249
343 #define CMP_NODE_GAMMA          250
344 #define CMP_NODE_INVERT         251
345 #define CMP_NODE_NORMALIZE      252
346 #define CMP_NODE_CROP           253
347 #define CMP_NODE_DBLUR          254
348 #define CMP_NODE_BILATERALBLUR  255
349 #define CMP_NODE_PREMULKEY  256
350 #define CMP_NODE_DIST_MATTE     257
351 #define CMP_NODE_VIEW_LEVELS    258
352 #define CMP_NODE_COLOR_MATTE 259
353
354 #define CMP_NODE_GLARE          301
355 #define CMP_NODE_TONEMAP        302
356 #define CMP_NODE_LENSDIST       303
357
358 /* channel toggles */
359 #define CMP_CHAN_RGB            1
360 #define CMP_CHAN_A                      2
361 #define CMP_CHAN_R                      4
362 #define CMP_CHAN_G                      8
363 #define CMP_CHAN_B                      16
364
365 /* filter types */
366 #define CMP_FILT_SOFT           0
367 #define CMP_FILT_SHARP          1
368 #define CMP_FILT_LAPLACE        2
369 #define CMP_FILT_SOBEL          3
370 #define CMP_FILT_PREWITT        4
371 #define CMP_FILT_KIRSCH         5
372 #define CMP_FILT_SHADOW         6
373
374 /* scale node type, in custom1 */
375 #define CMP_SCALE_RELATIVE              0
376 #define CMP_SCALE_ABSOLUTE              1
377 #define CMP_SCALE_SCENEPERCENT  2
378
379
380 /* the type definitions array */
381 extern struct ListBase node_all_composit;
382
383 /* API */
384 struct CompBuf;
385 void ntreeCompositTagRender(struct Scene *sce);
386 int ntreeCompositTagAnimated(struct bNodeTree *ntree);
387 void ntreeCompositTagGenerators(struct bNodeTree *ntree);
388 void ntreeCompositForceHidden(struct bNodeTree *ntree, struct Scene *scene);
389
390 void free_compbuf(struct CompBuf *cbuf); /* internal...*/
391
392
393 /* ************** TEXTURE NODES *************** */
394
395 struct TexResult;
396
397 #define TEX_NODE_OUTPUT     401
398 #define TEX_NODE_CHECKER    402
399 #define TEX_NODE_TEXTURE    403
400 #define TEX_NODE_BRICKS     404
401 #define TEX_NODE_MATH       405
402 #define TEX_NODE_MIX_RGB    406
403 #define TEX_NODE_RGBTOBW    407
404 #define TEX_NODE_VALTORGB   408
405 #define TEX_NODE_IMAGE      409
406 #define TEX_NODE_CURVE_RGB  410
407 #define TEX_NODE_INVERT     411
408 #define TEX_NODE_HUE_SAT    412
409 #define TEX_NODE_CURVE_TIME 413
410 #define TEX_NODE_ROTATE     414
411 #define TEX_NODE_VIEWER     415
412 #define TEX_NODE_TRANSLATE  416
413 #define TEX_NODE_COORD      417
414 #define TEX_NODE_DISTANCE   418
415 #define TEX_NODE_COMPOSE    419
416 #define TEX_NODE_DECOMPOSE  420
417 #define TEX_NODE_VALTONOR   421
418 #define TEX_NODE_SCALE      422
419 #define TEX_NODE_AT         423
420
421 /* 501-599 reserved. Use like this: TEX_NODE_PROC + TEX_CLOUDS, etc */
422 #define TEX_NODE_PROC      500
423 #define TEX_NODE_PROC_MAX  600
424
425 extern struct ListBase node_all_textures;
426
427 /* API */
428 int  ntreeTexTagAnimated(struct bNodeTree *ntree);
429 void ntreeTexSetPreviewFlag(int);
430 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);
431 void ntreeTexCheckCyclics(struct bNodeTree *ntree);
432 char* ntreeTexOutputMenu(struct bNodeTree *ntree);
433
434
435 /**/
436
437 void init_nodesystem(void);
438 void free_nodesystem(void);
439
440 /**/
441
442 void clear_scene_in_nodes(struct Main *bmain, struct Scene *sce);
443
444 #endif