Merging r46495 through r46557 from trunk into soc-2011-tomato
[blender.git] / source / blender / blenkernel / BKE_node.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Bob Holcomb.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_NODE_H__
29 #define __BKE_NODE_H__
30
31 /** \file BKE_node.h
32  *  \ingroup bke
33  */
34
35 #include "DNA_listBase.h"
36
37 #include "RNA_types.h"
38
39 /* not very important, but the stack solver likes to know a maximum */
40 #define MAX_SOCKET      64
41
42 struct bContext;
43 struct bNode;
44 struct bNodeLink;
45 struct bNodeSocket;
46 struct bNodeStack;
47 struct bNodeTree;
48 struct bNodeTreeExec;
49 struct GPUMaterial;
50 struct GPUNode;
51 struct GPUNodeStack;
52 struct ID;
53 struct ImageFormatData;
54 struct ListBase;
55 struct Main;
56 struct uiBlock;
57 struct uiLayout;
58 struct MTex;
59 struct PointerRNA;
60 struct rctf;
61 struct RenderData;
62 struct Scene;
63 struct Tex;
64 struct SpaceNode;
65 struct ARegion;
66 struct Object;
67
68 /* ************** NODE TYPE DEFINITIONS ***** */
69
70 /** Compact definition of a node socket.
71  * Can be used to quickly define a list of static sockets for a node,
72  * which are added to each new node of that type. 
73  *
74  * \deprecated New nodes should add default sockets in the initialization
75  * function instead. This struct is mostly kept for old nodes and should
76  * be removed some time.
77  */
78 typedef struct bNodeSocketTemplate {
79         int type, limit;
80         char name[64];  /* MAX_NAME */
81         float val1, val2, val3, val4;   /* default alloc value for inputs */
82         float min, max;
83         PropertySubType subtype;
84         int flag;
85         
86         /* after this line is used internal only */
87         struct bNodeSocket *sock;               /* used to hold verified socket */
88 } bNodeSocketTemplate;
89
90 typedef void (*NodeSocketButtonFunction)(const struct bContext *C, struct uiBlock *block, 
91                                                                                  struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock,
92                                                                                  const char *name, int x, int y, int width);
93
94 /** Defines a socket type.
95  * Defines the appearance and behavior of a socket in the UI.
96  */
97 typedef struct bNodeSocketType {
98         int type;
99         char ui_name[64];       /* MAX_NAME */
100         char ui_description[128];
101         int ui_icon;
102         char ui_color[4];
103         
104         const char *value_structname;
105         int value_structsize;
106         
107         NodeSocketButtonFunction buttonfunc;
108 } bNodeSocketType;
109
110 /** Template for creating a node.
111  * Stored required parameters to make a new node of a specific type.
112  */
113 typedef struct bNodeTemplate {
114         int type;
115         
116         struct Main *main;
117         struct Scene *scene;
118         struct bNodeTree *ngroup;       /* group tree */
119 } bNodeTemplate;
120
121 /** Defines a node type.
122  * Initial attributes and constants for a node as well as callback functions
123  * implementing the node behavior.
124  */
125 typedef struct bNodeType {
126         void *next, *prev;
127         short needs_free;               /* set for allocated types that need to be freed */
128         
129         int type;
130         char name[64];  /* MAX_NAME */
131         float width, minwidth, maxwidth;
132         float height, minheight, maxheight;
133         short nclass, flag, compatibility;
134         
135         /* templates for static sockets */
136         bNodeSocketTemplate *inputs, *outputs;
137         
138         char storagename[64];                   /* struct name for DNA */
139         
140         /// Main draw function for the node.
141         void (*drawfunc)(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode, struct bNodeTree *ntree, struct bNode *node);
142         /// Updates the node geometry attributes according to internal state before actual drawing.
143         void (*drawupdatefunc)(const struct bContext *C, struct bNodeTree *ntree, struct bNode *node);
144         /// Draw the option buttons on the node.
145         void (*uifunc)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
146         /// Additional parameters in the side panel.
147         void (*uifuncbut)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
148         /// Draw a node socket. Default draws the input value button.
149         NodeSocketButtonFunction drawinputfunc;
150         NodeSocketButtonFunction drawoutputfunc;
151         /// Optional custom label function for the node header.
152         const char *(*labelfunc)(struct bNode *);
153         /// Optional custom resize handle polling.
154         int (*resize_area_func)(struct bNode *node, int x, int y);
155         
156         /// Called when the node is updated in the editor.
157         void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node);
158         /// Check and update if internal ID data has changed.
159         void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id);
160         
161         /// Initialize a new node instance of this type after creation.
162         void (*initfunc)(struct bNodeTree *ntree, struct bNode *node, struct bNodeTemplate *ntemp);
163         /// Free the custom storage data.
164         void (*freestoragefunc)(struct bNode *node);
165         /// Make a copy of the custom storage data.
166         void (*copystoragefunc)(struct bNode *node, struct bNode *target);
167         
168         /// Create a template from an existing node.
169         struct bNodeTemplate (*templatefunc)(struct bNode *);
170         /** If a node can be made from the template in the given node tree.
171          * \note Node groups can not be created inside their own node tree.
172          */
173         int (*validfunc)(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
174         
175         /// Initialize a node tree associated to this node type.
176         void (*inittreefunc)(struct bNodeTree *ntree);
177         /// Update a node tree associated to this node type.
178         void (*updatetreefunc)(struct bNodeTree *ntree);
179         
180         /* group edit callbacks for operators */
181         /* XXX this is going to be changed as required by the UI */
182         struct bNodeTree *(*group_edit_get)(struct bNode *node);
183         struct bNodeTree *(*group_edit_set)(struct bNode *node, int edit);
184         void (*group_edit_clear)(struct bNode *node);
185         
186         /* Generate a temporary list of internal links (bNodeLink), for muting and disconnect operators.
187          * Result must be freed by caller!
188          */
189         ListBase (*internal_connect)(struct bNodeTree *, struct bNode *node);
190         
191         /* **** execution callbacks **** */
192         void *(*initexecfunc)(struct bNode *node);
193         void (*freeexecfunc)(struct bNode *node, void *nodedata);
194         void (*execfunc)(void *data, struct bNode *, struct bNodeStack **, struct bNodeStack **);
195         /* XXX this alternative exec function has been added to avoid changing all node types.
196          * when a final generic version of execution code is defined, this will be changed anyway
197          */
198         void (*newexecfunc)(void *data, int thread, struct bNode *, void *nodedata, struct bNodeStack **, struct bNodeStack **);
199         /* gpu */
200         int (*gpufunc)(struct GPUMaterial *mat, struct bNode *node, struct GPUNodeStack *in, struct GPUNodeStack *out);
201         /* extended gpu function */
202         int (*gpuextfunc)(struct GPUMaterial *mat, struct bNode *node, void *nodedata, struct GPUNodeStack *in, struct GPUNodeStack *out);
203 } bNodeType;
204
205 /* node->exec, now in use for composites (#define for break is same as ready yes) */
206 #define NODE_PROCESSING 1
207 #define NODE_READY              2
208 #define NODE_BREAK              2
209 #define NODE_FINISHED   4
210 #define NODE_FREEBUFS   8
211 #define NODE_SKIPPED    16
212
213 /* sim_exec return value */
214 #define NODE_EXEC_FINISHED      0
215 #define NODE_EXEC_SUSPEND       1
216
217 /* nodetype->nclass, for add-menu and themes */
218 #define NODE_CLASS_INPUT                        0
219 #define NODE_CLASS_OUTPUT                       1
220 #define NODE_CLASS_OP_COLOR                     3
221 #define NODE_CLASS_OP_VECTOR            4
222 #define NODE_CLASS_OP_FILTER            5
223 #define NODE_CLASS_GROUP                        6
224 #define NODE_CLASS_FILE                         7
225 #define NODE_CLASS_CONVERTOR            8
226 #define NODE_CLASS_MATTE                        9
227 #define NODE_CLASS_DISTORT                      10
228 #define NODE_CLASS_OP_DYNAMIC           11
229 #define NODE_CLASS_PATTERN                      12
230 #define NODE_CLASS_TEXTURE                      13
231 #define NODE_CLASS_EXECUTION            14
232 #define NODE_CLASS_GETDATA                      15
233 #define NODE_CLASS_SETDATA                      16
234 #define NODE_CLASS_MATH                         17
235 #define NODE_CLASS_MATH_VECTOR          18
236 #define NODE_CLASS_MATH_ROTATION        19
237 #define NODE_CLASS_PARTICLES            25
238 #define NODE_CLASS_TRANSFORM            30
239 #define NODE_CLASS_COMBINE                      31
240 #define NODE_CLASS_SHADER                       40
241 #define NODE_CLASS_LAYOUT                       100
242
243 /* nodetype->compatibility */
244 #define NODE_OLD_SHADING        1
245 #define NODE_NEW_SHADING        2
246
247 /* enum values for input/output */
248 #define SOCK_IN         1
249 #define SOCK_OUT        2
250
251 struct bNodeTreeExec;
252
253 typedef void (*bNodeTreeCallback)(void *calldata, struct ID *owner_id, struct bNodeTree *ntree);
254 typedef void (*bNodeClassCallback)(void *calldata, int nclass, const char *name);
255 typedef struct bNodeTreeType
256 {
257         int type;                                               /* type identifier */
258         char idname[64];                                /* id name for RNA identification */
259         
260         ListBase node_types;                    /* type definitions */
261         
262         /* callbacks */
263         void (*free_cache)(struct bNodeTree *ntree);
264         void (*free_node_cache)(struct bNodeTree *ntree, struct bNode *node);
265         void (*foreach_nodetree)(struct Main *main, void *calldata, bNodeTreeCallback func);            /* iteration over all node trees */
266         void (*foreach_nodeclass)(struct Scene *scene, void *calldata, bNodeClassCallback func);        /* iteration over all node classes */
267
268         /* calls allowing threaded composite */
269         void (*localize)(struct bNodeTree *localtree, struct bNodeTree *ntree);
270         void (*local_sync)(struct bNodeTree *localtree, struct bNodeTree *ntree);
271         void (*local_merge)(struct bNodeTree *localtree, struct bNodeTree *ntree);
272
273         /* Tree update. Overrides nodetype->updatetreefunc! */
274         void (*update)(struct bNodeTree *ntree);
275         /* Node update. Overrides nodetype->updatefunc! */
276         void (*update_node)(struct bNodeTree *ntree, struct bNode *node);
277         
278         int (*validate_link)(struct bNodeTree *ntree, struct bNodeLink *link);
279
280         /* Default internal linking. */
281         ListBase (*internal_connect)(struct bNodeTree *, struct bNode *node);
282 } bNodeTreeType;
283
284 /* ************** GENERIC API, TREES *************** */
285
286 struct bNodeTreeType *ntreeGetType(int type);
287 struct bNodeType *ntreeGetNodeType(struct bNodeTree *ntree);
288 struct bNodeSocketType *ntreeGetSocketType(int type);
289
290 struct bNodeTree *ntreeAddTree(const char *name, int type, int nodetype);
291 void                    ntreeInitTypes(struct bNodeTree *ntree);
292
293 void                    ntreeFreeTree(struct bNodeTree *ntree);
294 struct bNodeTree *ntreeCopyTree(struct bNodeTree *ntree);
295 void                    ntreeSwitchID(struct bNodeTree *ntree, struct ID *sce_from, struct ID *sce_to);
296 void                    ntreeMakeLocal(struct bNodeTree *ntree);
297 int                             ntreeHasType(struct bNodeTree *ntree, int type);
298
299 void                    ntreeUpdateTree(struct bNodeTree *ntree);
300 /* XXX Currently each tree update call does call to ntreeVerifyNodes too.
301  * Some day this should be replaced by a decent depsgraph automatism!
302  */
303 void                    ntreeVerifyNodes(struct Main *main, struct ID *id);
304
305 void                    ntreeGetDependencyList(struct bNodeTree *ntree, struct bNode ***deplist, int *totnodes);
306
307 /* XXX old trees handle output flags automatically based on special output node types and last active selection.
308  * new tree types have a per-output socket flag to indicate the final output to use explicitly.
309  */
310 void                    ntreeSetOutput(struct bNodeTree *ntree);
311 void                    ntreeInitPreview(struct bNodeTree *, int xsize, int ysize);
312 void                    ntreeClearPreview(struct bNodeTree *ntree);
313
314 void                    ntreeFreeCache(struct bNodeTree *ntree);
315
316 int                             ntreeNodeExists(struct bNodeTree *ntree, struct bNode *testnode);
317 int                             ntreeOutputExists(struct bNode *node, struct bNodeSocket *testsock);
318 struct bNodeTree *ntreeLocalize(struct bNodeTree *ntree);
319 void                    ntreeLocalSync(struct bNodeTree *localtree, struct bNodeTree *ntree);
320 void                    ntreeLocalMerge(struct bNodeTree *localtree, struct bNodeTree *ntree);
321
322 /* ************** GENERIC API, NODES *************** */
323
324 struct bNodeSocket *nodeAddSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, const char *name, int type);
325 struct bNodeSocket *nodeInsertSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, struct bNodeSocket *next_sock, const char *name, int type);
326 void nodeRemoveSocket(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock);
327 void nodeRemoveAllSockets(struct bNodeTree *ntree, struct bNode *node);
328
329 void                    nodeAddToPreview(struct bNode *, float *, int, int, int);
330
331 struct bNode    *nodeAddNode(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
332 void                    nodeUnlinkNode(struct bNodeTree *ntree, struct bNode *node);
333 void                    nodeUniqueName(struct bNodeTree *ntree, struct bNode *node);
334
335 void                    nodeRegisterType(struct bNodeTreeType *ttype, struct bNodeType *ntype);
336 void                    nodeMakeDynamicType(struct bNode *node);
337 int                             nodeDynamicUnlinkText(struct ID *txtid);
338
339 void                    nodeFreeNode(struct bNodeTree *ntree, struct bNode *node);
340 struct bNode    *nodeCopyNode(struct bNodeTree *ntree, struct bNode *node);
341
342 struct bNodeLink *nodeAddLink(struct bNodeTree *ntree, struct bNode *fromnode, struct bNodeSocket *fromsock, struct bNode *tonode, struct bNodeSocket *tosock);
343 void                    nodeRemLink(struct bNodeTree *ntree, struct bNodeLink *link);
344 void                    nodeRemSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
345 void                    nodeInternalRelink(struct bNodeTree *ntree, struct bNode *node);
346
347 void                    nodeSpaceCoords(struct bNode *node, float *locx, float *locy);
348 void                    nodeAttachNode(struct bNode *node, struct bNode *parent);
349 void                    nodeDetachNode(struct bNode *node);
350
351 struct bNode    *nodeFindNodebyName(struct bNodeTree *ntree, const char *name);
352 int                             nodeFindNode(struct bNodeTree *ntree, struct bNodeSocket *sock, struct bNode **nodep, int *sockindex, int *in_out);
353
354 struct bNodeLink *nodeFindLink(struct bNodeTree *ntree, struct bNodeSocket *from, struct bNodeSocket *to);
355 int                             nodeCountSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
356
357 void                    nodeSetActive(struct bNodeTree *ntree, struct bNode *node);
358 struct bNode    *nodeGetActive(struct bNodeTree *ntree);
359 struct bNode    *nodeGetActiveID(struct bNodeTree *ntree, short idtype);
360 int                             nodeSetActiveID(struct bNodeTree *ntree, short idtype, struct ID *id);
361 void                    nodeClearActiveID(struct bNodeTree *ntree, short idtype);
362 struct bNode    *nodeGetActiveTexture(struct bNodeTree *ntree);
363
364 void                    nodeUpdate(struct bNodeTree *ntree, struct bNode *node);
365 int                             nodeUpdateID(struct bNodeTree *ntree, struct ID *id);
366
367 void                    nodeFreePreview(struct bNode *node);
368
369 int                             nodeSocketIsHidden(struct bNodeSocket *sock);
370 void                    nodeSocketSetType(struct bNodeSocket *sock, int type);
371
372 /* ************** NODE TYPE ACCESS *************** */
373
374 struct bNodeTemplate nodeMakeTemplate(struct bNode *node);
375 int                             nodeValid(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
376 const char*             nodeLabel(struct bNode *node);
377 struct bNodeTree *nodeGroupEditGet(struct bNode *node);
378 struct bNodeTree *nodeGroupEditSet(struct bNode *node, int edit);
379 void                    nodeGroupEditClear(struct bNode *node);
380
381 /* Init a new node type struct with default values and callbacks */
382 void                    node_type_base(struct bNodeTreeType *ttype, struct bNodeType *ntype, int type,
383                                const char *name, short nclass, short flag);
384 void                    node_type_socket_templates(struct bNodeType *ntype, struct bNodeSocketTemplate *inputs, struct bNodeSocketTemplate *outputs);
385 void                    node_type_size(struct bNodeType *ntype, int width, int minwidth, int maxwidth);
386 void                    node_type_init(struct bNodeType *ntype, void (*initfunc)(struct bNodeTree *ntree, struct bNode *node, struct bNodeTemplate *ntemp));
387 void                    node_type_valid(struct bNodeType *ntype, int (*validfunc)(struct bNodeTree *ntree, struct bNodeTemplate *ntemp));
388 void                    node_type_storage(struct bNodeType *ntype,
389                                                                   const char *storagename,
390                                                                   void (*freestoragefunc)(struct bNode *),
391                                                                   void (*copystoragefunc)(struct bNode *, struct bNode *));
392 void                    node_type_label(struct bNodeType *ntype, const char *(*labelfunc)(struct bNode *));
393 void                    node_type_template(struct bNodeType *ntype, struct bNodeTemplate (*templatefunc)(struct bNode *));
394 void                    node_type_update(struct bNodeType *ntype,
395                                                                  void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node),
396                                                                  void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id));
397 void                    node_type_tree(struct bNodeType *ntype,
398                                                            void (*inittreefunc)(struct bNodeTree *),
399                                                            void (*updatetreefunc)(struct bNodeTree *));
400 void                    node_type_group_edit(struct bNodeType *ntype,
401                                                                          struct bNodeTree *(*group_edit_get)(struct bNode *node),
402                                                                          struct bNodeTree *(*group_edit_set)(struct bNode *node, int edit),
403                                                                          void (*group_edit_clear)(struct bNode *node));
404
405 void                    node_type_exec(struct bNodeType *ntype, void (*execfunc)(void *data, struct bNode *, struct bNodeStack **,
406                                                                          struct bNodeStack **));
407 void                    node_type_exec_new(struct bNodeType *ntype,
408                                                                    void *(*initexecfunc)(struct bNode *node),
409                                                                    void (*freeexecfunc)(struct bNode *node, void *nodedata),
410                                                                    void (*newexecfunc)(void *data, int thread, struct bNode *, void *nodedata,
411                                                                                        struct bNodeStack **, struct bNodeStack **));
412 void                    node_type_internal_connect(struct bNodeType *ntype, ListBase (*internal_connect)(struct bNodeTree *, struct bNode *));
413 void                    node_type_gpu(struct bNodeType *ntype, int (*gpufunc)(struct GPUMaterial *mat, struct bNode *node,
414                                                                       struct GPUNodeStack *in, struct GPUNodeStack *out));
415 void                    node_type_gpu_ext(struct bNodeType *ntype, int (*gpuextfunc)(struct GPUMaterial *mat, struct bNode *node,
416                                                                              void *nodedata, struct GPUNodeStack *in,
417                                                                              struct GPUNodeStack *out));
418 void                    node_type_compatibility(struct bNodeType *ntype, short compatibility);
419
420 /* ************** COMMON NODES *************** */
421
422 #define NODE_GROUP              2
423 #define NODE_FORLOOP    3
424 #define NODE_WHILELOOP  4
425 #define NODE_FRAME              5
426 #define NODE_GROUP_MENU         10000
427 #define NODE_DYNAMIC_MENU       20000
428
429 /* look up a socket on a group node by the internal group socket */
430 struct bNodeSocket *node_group_find_input(struct bNode *gnode, struct bNodeSocket *gsock);
431 struct bNodeSocket *node_group_find_output(struct bNode *gnode, struct bNodeSocket *gsock);
432
433 struct bNodeSocket *node_group_add_socket(struct bNodeTree *ngroup, const char *name, int type, int in_out);
434 struct bNodeSocket *node_group_expose_socket(struct bNodeTree *ngroup, struct bNodeSocket *sock, int in_out);
435 void node_group_expose_all_sockets(struct bNodeTree *ngroup);
436 void node_group_remove_socket(struct bNodeTree *ngroup, struct bNodeSocket *gsock, int in_out);
437
438 struct bNode    *node_group_make_from_selected(struct bNodeTree *ntree);
439 int                             node_group_ungroup(struct bNodeTree *ntree, struct bNode *gnode);
440
441 /* in node_common.c */
442 void register_node_type_frame(struct bNodeTreeType *ttype);
443
444 /* ************** SHADER NODES *************** */
445
446 struct ShadeInput;
447 struct ShadeResult;
448
449 /* note: types are needed to restore callbacks, don't change values */
450 /* range 1 - 100 is reserved for common nodes */
451 /* using toolbox, we add node groups by assuming the values below don't exceed NODE_GROUP_MENU for now */
452
453 #define SH_NODE_OUTPUT          1
454
455 #define SH_NODE_MATERIAL        100
456 #define SH_NODE_RGB                     101
457 #define SH_NODE_VALUE           102
458 #define SH_NODE_MIX_RGB         103
459 #define SH_NODE_VALTORGB        104
460 #define SH_NODE_RGBTOBW         105
461 #define SH_NODE_TEXTURE         106
462 #define SH_NODE_NORMAL          107
463 #define SH_NODE_GEOMETRY        108
464 #define SH_NODE_MAPPING         109
465 #define SH_NODE_CURVE_VEC       110
466 #define SH_NODE_CURVE_RGB       111
467 #define SH_NODE_CAMERA          114
468 #define SH_NODE_MATH            115
469 #define SH_NODE_VECT_MATH       116
470 #define SH_NODE_SQUEEZE         117
471 #define SH_NODE_MATERIAL_EXT    118
472 #define SH_NODE_INVERT          119
473 #define SH_NODE_SEPRGB          120
474 #define SH_NODE_COMBRGB         121
475 #define SH_NODE_HUE_SAT         122
476 #define NODE_DYNAMIC            123
477
478 #define SH_NODE_OUTPUT_MATERIAL                 124
479 #define SH_NODE_OUTPUT_WORLD                    125
480 #define SH_NODE_OUTPUT_LAMP                             126
481 #define SH_NODE_FRESNEL                                 127
482 #define SH_NODE_MIX_SHADER                              128
483 #define SH_NODE_ATTRIBUTE                               129
484 #define SH_NODE_BACKGROUND                              130
485 #define SH_NODE_BSDF_ANISOTROPIC                131
486 #define SH_NODE_BSDF_DIFFUSE                    132
487 #define SH_NODE_BSDF_GLOSSY                             133
488 #define SH_NODE_BSDF_GLASS                              134
489 #define SH_NODE_BSDF_TRANSLUCENT                137
490 #define SH_NODE_BSDF_TRANSPARENT                138
491 #define SH_NODE_BSDF_VELVET                             139
492 #define SH_NODE_EMISSION                                140
493 #define SH_NODE_NEW_GEOMETRY                    141
494 #define SH_NODE_LIGHT_PATH                              142
495 #define SH_NODE_TEX_IMAGE                               143
496 #define SH_NODE_TEX_SKY                                 145
497 #define SH_NODE_TEX_GRADIENT                    146
498 #define SH_NODE_TEX_VORONOI                             147
499 #define SH_NODE_TEX_MAGIC                               148
500 #define SH_NODE_TEX_WAVE                                149
501 #define SH_NODE_TEX_NOISE                               150
502 #define SH_NODE_TEX_MUSGRAVE                    152
503 #define SH_NODE_TEX_COORD                               155
504 #define SH_NODE_ADD_SHADER                              156
505 #define SH_NODE_TEX_ENVIRONMENT                 157
506 #define SH_NODE_OUTPUT_TEXTURE                  158
507 #define SH_NODE_HOLDOUT                                 159
508 #define SH_NODE_LAYER_WEIGHT                    160
509 #define SH_NODE_VOLUME_TRANSPARENT              161
510 #define SH_NODE_VOLUME_ISOTROPIC                162
511 #define SH_NODE_GAMMA                                   163
512 #define SH_NODE_TEX_CHECKER                             164
513 #define SH_NODE_BRIGHTCONTRAST                  165
514 #define SH_NODE_LIGHT_FALLOFF                   166
515
516 /* custom defines options for Material node */
517 #define SH_NODE_MAT_DIFF   1
518 #define SH_NODE_MAT_SPEC   2
519 #define SH_NODE_MAT_NEG    4
520 /* custom defines: states for Script node. These are bit indices */
521 #define NODE_DYNAMIC_READY      0 /* 1 */
522 #define NODE_DYNAMIC_LOADED     1 /* 2 */
523 #define NODE_DYNAMIC_NEW        2 /* 4 */
524 #define NODE_DYNAMIC_UPDATED    3 /* 8 */
525 #define NODE_DYNAMIC_ADDEXIST   4 /* 16 */
526 #define NODE_DYNAMIC_ERROR      5 /* 32 */
527 #define NODE_DYNAMIC_REPARSE    6 /* 64 */
528 #define NODE_DYNAMIC_SET        15 /* sign */
529
530 /* API */
531
532 struct bNodeTreeExec *ntreeShaderBeginExecTree(struct bNodeTree *ntree, int use_tree_data);
533 void                    ntreeShaderEndExecTree(struct bNodeTreeExec *exec, int use_tree_data);
534 void                    ntreeShaderExecTree(struct bNodeTree *ntree, struct ShadeInput *shi, struct ShadeResult *shr);
535 void                    ntreeShaderGetTexcoMode(struct bNodeTree *ntree, int osa, short *texco, int *mode);
536 void                    nodeShaderSynchronizeID(struct bNode *node, int copyto);
537
538                                 /* switch material render loop */
539 extern void (*node_shader_lamp_loop)(struct ShadeInput *, struct ShadeResult *);
540 void                    set_node_shader_lamp_loop(void (*lamp_loop_func)(struct ShadeInput *, struct ShadeResult *));
541
542 void                    ntreeGPUMaterialNodes(struct bNodeTree *ntree, struct GPUMaterial *mat);
543
544
545 /* ************** COMPOSITE NODES *************** */
546
547 /* output socket defines */
548 #define RRES_OUT_IMAGE                          0
549 #define RRES_OUT_ALPHA                          1
550 #define RRES_OUT_Z                                      2
551 #define RRES_OUT_NORMAL                         3
552 #define RRES_OUT_UV                                     4
553 #define RRES_OUT_VEC                            5
554 #define RRES_OUT_RGBA                           6
555 #define RRES_OUT_DIFF                           7
556 #define RRES_OUT_SPEC                           8
557 #define RRES_OUT_SHADOW                         9
558 #define RRES_OUT_AO                                     10
559 #define RRES_OUT_REFLECT                        11
560 #define RRES_OUT_REFRACT                        12
561 #define RRES_OUT_INDIRECT                       13
562 #define RRES_OUT_INDEXOB                        14
563 #define RRES_OUT_INDEXMA                        15
564 #define RRES_OUT_MIST                           16
565 #define RRES_OUT_EMIT                           17
566 #define RRES_OUT_ENV                            18
567 #define RRES_OUT_DIFF_DIRECT            19
568 #define RRES_OUT_DIFF_INDIRECT          20
569 #define RRES_OUT_DIFF_COLOR                     21
570 #define RRES_OUT_GLOSSY_DIRECT          22
571 #define RRES_OUT_GLOSSY_INDIRECT        23
572 #define RRES_OUT_GLOSSY_COLOR           24
573 #define RRES_OUT_TRANSM_DIRECT          25
574 #define RRES_OUT_TRANSM_INDIRECT        26
575 #define RRES_OUT_TRANSM_COLOR           27
576
577 /* note: types are needed to restore callbacks, don't change values */
578 #define CMP_NODE_VIEWER         201
579 #define CMP_NODE_RGB            202
580 #define CMP_NODE_VALUE          203
581 #define CMP_NODE_MIX_RGB        204
582 #define CMP_NODE_VALTORGB       205
583 #define CMP_NODE_RGBTOBW        206
584 #define CMP_NODE_NORMAL         207
585 #define CMP_NODE_CURVE_VEC      208
586 #define CMP_NODE_CURVE_RGB      209
587 #define CMP_NODE_ALPHAOVER      210
588 #define CMP_NODE_BLUR           211
589 #define CMP_NODE_FILTER         212
590 #define CMP_NODE_MAP_VALUE      213
591 #define CMP_NODE_TIME           214
592 #define CMP_NODE_VECBLUR        215
593 #define CMP_NODE_SEPRGBA        216
594 #define CMP_NODE_SEPHSVA        217
595 #define CMP_NODE_SETALPHA       218
596 #define CMP_NODE_HUE_SAT        219
597 #define CMP_NODE_IMAGE          220
598 #define CMP_NODE_R_LAYERS       221
599 #define CMP_NODE_COMPOSITE      222
600 #define CMP_NODE_OUTPUT_FILE    223
601 #define CMP_NODE_TEXTURE        224
602 #define CMP_NODE_TRANSLATE      225
603 #define CMP_NODE_ZCOMBINE       226
604 #define CMP_NODE_COMBRGBA       227
605 #define CMP_NODE_DILATEERODE    228
606 #define CMP_NODE_ROTATE         229
607 #define CMP_NODE_SCALE          230
608 #define CMP_NODE_SEPYCCA        231
609 #define CMP_NODE_COMBYCCA       232
610 #define CMP_NODE_SEPYUVA        233
611 #define CMP_NODE_COMBYUVA       234
612 #define CMP_NODE_DIFF_MATTE     235
613 #define CMP_NODE_COLOR_SPILL    236
614 #define CMP_NODE_CHROMA_MATTE   237
615 #define CMP_NODE_CHANNEL_MATTE  238
616 #define CMP_NODE_FLIP           239
617 #define CMP_NODE_SPLITVIEWER    240
618 #define CMP_NODE_INDEX_MASK     241
619 #define CMP_NODE_MAP_UV         242
620 #define CMP_NODE_ID_MASK        243
621 #define CMP_NODE_DEFOCUS        244
622 #define CMP_NODE_DISPLACE       245
623 #define CMP_NODE_COMBHSVA       246
624 #define CMP_NODE_MATH           247
625 #define CMP_NODE_LUMA_MATTE     248
626 #define CMP_NODE_BRIGHTCONTRAST 249
627 #define CMP_NODE_GAMMA          250
628 #define CMP_NODE_INVERT         251
629 #define CMP_NODE_NORMALIZE      252
630 #define CMP_NODE_CROP           253
631 #define CMP_NODE_DBLUR          254
632 #define CMP_NODE_BILATERALBLUR  255
633 #define CMP_NODE_PREMULKEY  256
634 #define CMP_NODE_DIST_MATTE     257
635 #define CMP_NODE_VIEW_LEVELS    258
636 #define CMP_NODE_COLOR_MATTE 259
637 #define CMP_NODE_COLORBALANCE 260
638 #define CMP_NODE_HUECORRECT 261
639 #define CMP_NODE_MOVIECLIP      262
640 #define CMP_NODE_STABILIZE2D    263
641 #define CMP_NODE_TRANSFORM      264
642 #define CMP_NODE_MOVIEDISTORTION        265
643 #define CMP_NODE_DOUBLEEDGEMASK    266
644 #define CMP_NODE_OUTPUT_MULTI_FILE__DEPRECATED  267     /* DEPRECATED multi file node has been merged into regular CMP_NODE_OUTPUT_FILE */
645 #define CMP_NODE_MASK           268
646
647 #define CMP_NODE_GLARE          301
648 #define CMP_NODE_TONEMAP        302
649 #define CMP_NODE_LENSDIST       303
650
651 /* channel toggles */
652 #define CMP_CHAN_RGB            1
653 #define CMP_CHAN_A                      2
654 #define CMP_CHAN_R                      4
655 #define CMP_CHAN_G                      8
656 #define CMP_CHAN_B                      16
657
658 /* filter types */
659 #define CMP_FILT_SOFT           0
660 #define CMP_FILT_SHARP          1
661 #define CMP_FILT_LAPLACE        2
662 #define CMP_FILT_SOBEL          3
663 #define CMP_FILT_PREWITT        4
664 #define CMP_FILT_KIRSCH         5
665 #define CMP_FILT_SHADOW         6
666
667 /* scale node type, in custom1 */
668 #define CMP_SCALE_RELATIVE              0
669 #define CMP_SCALE_ABSOLUTE              1
670 #define CMP_SCALE_SCENEPERCENT  2
671 #define CMP_SCALE_RENDERPERCENT 3
672
673
674 /* API */
675 struct CompBuf;
676 struct bNodeTreeExec *ntreeCompositBeginExecTree(struct bNodeTree *ntree, int use_tree_data);
677 void ntreeCompositEndExecTree(struct bNodeTreeExec *exec, int use_tree_data);
678 void ntreeCompositExecTree(struct bNodeTree *ntree, struct RenderData *rd, int do_previews);
679 void ntreeCompositTagRender(struct Scene *sce);
680 int ntreeCompositTagAnimated(struct bNodeTree *ntree);
681 void ntreeCompositTagGenerators(struct bNodeTree *ntree);
682 void ntreeCompositForceHidden(struct bNodeTree *ntree, struct Scene *scene);
683 void ntreeCompositClearTags(struct bNodeTree *ntree);
684
685 struct bNodeSocket *ntreeCompositOutputFileAddSocket(struct bNodeTree *ntree, struct bNode *node,
686                                                      const char *name, struct ImageFormatData *im_format);
687 int ntreeCompositOutputFileRemoveActiveSocket(struct bNodeTree *ntree, struct bNode *node);
688 void ntreeCompositOutputFileSetPath(struct bNode *node, struct bNodeSocket *sock, const char *name);
689 void ntreeCompositOutputFileSetLayer(struct bNode *node, struct bNodeSocket *sock, const char *name);
690 /* needed in do_versions */
691 void ntreeCompositOutputFileUniquePath(struct ListBase *list, struct bNodeSocket *sock, const char defname[], char delim);
692 void ntreeCompositOutputFileUniqueLayer(struct ListBase *list, struct bNodeSocket *sock, const char defname[], char delim);
693
694 /* ************** TEXTURE NODES *************** */
695
696 struct TexResult;
697
698 #define TEX_NODE_OUTPUT     401
699 #define TEX_NODE_CHECKER    402
700 #define TEX_NODE_TEXTURE    403
701 #define TEX_NODE_BRICKS     404
702 #define TEX_NODE_MATH       405
703 #define TEX_NODE_MIX_RGB    406
704 #define TEX_NODE_RGBTOBW    407
705 #define TEX_NODE_VALTORGB   408
706 #define TEX_NODE_IMAGE      409
707 #define TEX_NODE_CURVE_RGB  410
708 #define TEX_NODE_INVERT     411
709 #define TEX_NODE_HUE_SAT    412
710 #define TEX_NODE_CURVE_TIME 413
711 #define TEX_NODE_ROTATE     414
712 #define TEX_NODE_VIEWER     415
713 #define TEX_NODE_TRANSLATE  416
714 #define TEX_NODE_COORD      417
715 #define TEX_NODE_DISTANCE   418
716 #define TEX_NODE_COMPOSE    419
717 #define TEX_NODE_DECOMPOSE  420
718 #define TEX_NODE_VALTONOR   421
719 #define TEX_NODE_SCALE      422
720 #define TEX_NODE_AT         423
721
722 /* 501-599 reserved. Use like this: TEX_NODE_PROC + TEX_CLOUDS, etc */
723 #define TEX_NODE_PROC      500
724 #define TEX_NODE_PROC_MAX  600
725
726 /* API */
727 int  ntreeTexTagAnimated(struct bNodeTree *ntree);
728 void ntreeTexCheckCyclics(struct bNodeTree *ntree);
729
730 struct bNodeTreeExec *ntreeTexBeginExecTree(struct bNodeTree *ntree, int use_tree_data);
731 void ntreeTexEndExecTree(struct bNodeTreeExec *exec, int use_tree_data);
732 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);
733
734
735 /*************************************************/
736
737 void init_nodesystem(void);
738 void free_nodesystem(void);
739
740 void clear_scene_in_nodes(struct Main *bmain, struct Scene *sce);
741
742 #endif