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