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