718fa2f9ecd7d78b6eea109a7382ab351d00bf19
[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 /* not very important, but the stack solver likes to know a maximum */
38 #define MAX_SOCKET      64
39
40 struct bContext;
41 struct bNode;
42 struct bNodeLink;
43 struct bNodeSocket;
44 struct bNodeStack;
45 struct bNodeTree;
46 struct bNodeTreeExec;
47 struct GPUMaterial;
48 struct GPUNode;
49 struct GPUNodeStack;
50 struct ID;
51 struct ImageFormatData;
52 struct ListBase;
53 struct Main;
54 struct uiBlock;
55 struct uiLayout;
56 struct MTex;
57 struct PointerRNA;
58 struct rctf;
59 struct RenderData;
60 struct Scene;
61 struct Tex;
62 struct SpaceNode;
63 struct ARegion;
64 struct Object;
65 struct ColorManagedViewSettings;
66 struct ColorManagedDisplaySettings;
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         int subtype;  /* would use PropertySubType but this is a bad level include to use RNA */
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         /// Additional drawing on backdrop.
149         void (*uibackdropfunc)(struct SpaceNode *snode, struct ImBuf *backdrop, struct bNode *node, int x, int y);
150
151         /// Draw a node socket. Default draws the input value button.
152         NodeSocketButtonFunction drawinputfunc;
153         NodeSocketButtonFunction drawoutputfunc;
154
155         /// Optional custom label function for the node header.
156         const char *(*labelfunc)(struct bNode *);
157         /// Optional custom resize handle polling.
158         int (*resize_area_func)(struct bNode *node, int x, int y);
159         /// Optional selection area polling.
160         int (*select_area_func)(struct bNode *node, int x, int y);
161         /// Optional tweak area polling (for grabbing).
162         int (*tweak_area_func)(struct bNode *node, int x, int y);
163         
164         /// Called when the node is updated in the editor.
165         void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node);
166         /// Check and update if internal ID data has changed.
167         void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id);
168         
169         /// Initialize a new node instance of this type after creation.
170         void (*initfunc)(struct bNodeTree *ntree, struct bNode *node, struct bNodeTemplate *ntemp);
171         /// Free the custom storage data.
172         void (*freestoragefunc)(struct bNode *node);
173         /// Make a copy of the custom storage data.
174         void (*copystoragefunc)(struct bNode *node, struct bNode *target);
175         
176         /// Create a template from an existing node.
177         struct bNodeTemplate (*templatefunc)(struct bNode *);
178         /** If a node can be made from the template in the given node tree.
179          * \note Node groups can not be created inside their own node tree.
180          */
181         int (*validfunc)(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
182         
183         /// Initialize a node tree associated to this node type.
184         void (*inittreefunc)(struct bNodeTree *ntree);
185         /// Update a node tree associated to this node type.
186         void (*updatetreefunc)(struct bNodeTree *ntree);
187         
188         /* group edit callbacks for operators */
189         /* XXX this is going to be changed as required by the UI */
190         struct bNodeTree *(*group_edit_get)(struct bNode *node);
191         struct bNodeTree *(*group_edit_set)(struct bNode *node, int edit);
192         void (*group_edit_clear)(struct bNode *node);
193         
194         /* Update the internal links list, for muting and disconnect operators. */
195         void (*update_internal_links)(struct bNodeTree *, struct bNode *node);
196         
197         /* **** execution callbacks **** */
198         void *(*initexecfunc)(struct bNode *node);
199         void (*freeexecfunc)(struct bNode *node, void *nodedata);
200         void (*execfunc)(void *data, struct bNode *, struct bNodeStack **, struct bNodeStack **);
201         /* XXX this alternative exec function has been added to avoid changing all node types.
202          * when a final generic version of execution code is defined, this will be changed anyway
203          */
204         void (*newexecfunc)(void *data, int thread, struct bNode *, void *nodedata, struct bNodeStack **, struct bNodeStack **);
205         /* gpu */
206         int (*gpufunc)(struct GPUMaterial *mat, struct bNode *node, struct GPUNodeStack *in, struct GPUNodeStack *out);
207         /* extended gpu function */
208         int (*gpuextfunc)(struct GPUMaterial *mat, struct bNode *node, void *nodedata, struct GPUNodeStack *in, struct GPUNodeStack *out);
209 } bNodeType;
210
211 /* node->exec, now in use for composites (#define for break is same as ready yes) */
212 #define NODE_PROCESSING 1
213 #define NODE_READY              2
214 #define NODE_BREAK              2
215 #define NODE_FINISHED   4
216 #define NODE_FREEBUFS   8
217 #define NODE_SKIPPED    16
218
219 /* sim_exec return value */
220 #define NODE_EXEC_FINISHED      0
221 #define NODE_EXEC_SUSPEND       1
222
223 /* nodetype->nclass, for add-menu and themes */
224 #define NODE_CLASS_INPUT                        0
225 #define NODE_CLASS_OUTPUT                       1
226 #define NODE_CLASS_OP_COLOR                     3
227 #define NODE_CLASS_OP_VECTOR            4
228 #define NODE_CLASS_OP_FILTER            5
229 #define NODE_CLASS_GROUP                        6
230 #define NODE_CLASS_FILE                         7
231 #define NODE_CLASS_CONVERTOR            8
232 #define NODE_CLASS_MATTE                        9
233 #define NODE_CLASS_DISTORT                      10
234 #define NODE_CLASS_OP_DYNAMIC           11 /* deprecated */
235 #define NODE_CLASS_PATTERN                      12
236 #define NODE_CLASS_TEXTURE                      13
237 #define NODE_CLASS_EXECUTION            14
238 #define NODE_CLASS_GETDATA                      15
239 #define NODE_CLASS_SETDATA                      16
240 #define NODE_CLASS_MATH                         17
241 #define NODE_CLASS_MATH_VECTOR          18
242 #define NODE_CLASS_MATH_ROTATION        19
243 #define NODE_CLASS_PARTICLES            25
244 #define NODE_CLASS_TRANSFORM            30
245 #define NODE_CLASS_COMBINE                      31
246 #define NODE_CLASS_SCRIPT                       32
247 #define NODE_CLASS_SHADER                       40
248 #define NODE_CLASS_LAYOUT                       100
249
250 /* nodetype->compatibility */
251 #define NODE_OLD_SHADING        1
252 #define NODE_NEW_SHADING        2
253
254 /* node resize directions */
255 #define NODE_RESIZE_TOP         1
256 #define NODE_RESIZE_BOTTOM      2
257 #define NODE_RESIZE_RIGHT       4
258 #define NODE_RESIZE_LEFT        8
259
260 /* enum values for input/output */
261 #define SOCK_IN         1
262 #define SOCK_OUT        2
263
264 struct bNodeTreeExec;
265
266 typedef void (*bNodeTreeCallback)(void *calldata, struct ID *owner_id, struct bNodeTree *ntree);
267 typedef void (*bNodeClassCallback)(void *calldata, int nclass, const char *name);
268 typedef struct bNodeTreeType {
269         int type;                                               /* type identifier */
270         char idname[64];                                /* id name for RNA identification */
271         
272         ListBase node_types;                    /* type definitions */
273         
274         /* callbacks */
275         void (*free_cache)(struct bNodeTree *ntree);
276         void (*free_node_cache)(struct bNodeTree *ntree, struct bNode *node);
277         void (*foreach_nodetree)(struct Main *main, void *calldata, bNodeTreeCallback func);            /* iteration over all node trees */
278         void (*foreach_nodeclass)(struct Scene *scene, void *calldata, bNodeClassCallback func);        /* iteration over all node classes */
279
280         /* calls allowing threaded composite */
281         void (*localize)(struct bNodeTree *localtree, struct bNodeTree *ntree);
282         void (*local_sync)(struct bNodeTree *localtree, struct bNodeTree *ntree);
283         void (*local_merge)(struct bNodeTree *localtree, struct bNodeTree *ntree);
284
285         /* Tree update. Overrides nodetype->updatetreefunc! */
286         void (*update)(struct bNodeTree *ntree);
287         /* Node update. Overrides nodetype->updatefunc! */
288         void (*update_node)(struct bNodeTree *ntree, struct bNode *node);
289         
290         int (*validate_link)(struct bNodeTree *ntree, struct bNodeLink *link);
291
292         /* Default internal linking. */
293         void (*update_internal_links)(struct bNodeTree *, struct bNode *node);
294 } bNodeTreeType;
295
296 /* ************** GENERIC API, TREES *************** */
297
298 struct bNodeTreeType *ntreeGetType(int type);
299 struct bNodeType *ntreeGetNodeType(struct bNodeTree *ntree);
300 struct bNodeSocketType *ntreeGetSocketType(int type);
301
302 struct bNodeTree *ntreeAddTree(const char *name, int type, int nodetype);
303 void              ntreeInitTypes(struct bNodeTree *ntree);
304
305 /* copy/free funcs, need to manage ID users */
306 void              ntreeFreeTree_ex(struct bNodeTree *ntree, const short do_id_user);
307 void              ntreeFreeTree(struct bNodeTree *ntree);
308 struct bNodeTree *ntreeCopyTree_ex(struct bNodeTree *ntree, const short do_id_user);
309 struct bNodeTree *ntreeCopyTree(struct bNodeTree *ntree);
310 void              ntreeSwitchID_ex(struct bNodeTree *ntree, struct ID *sce_from, struct ID *sce_to, const short do_id_user);
311 void              ntreeSwitchID(struct bNodeTree *ntree, struct ID *sce_from, struct ID *sce_to);
312 /* node->id user count */
313 void              ntreeUserIncrefID(struct bNodeTree *ntree);
314 void              ntreeUserDecrefID(struct bNodeTree *ntree);
315
316
317 struct bNodeTree *ntreeFromID(struct ID *id);
318
319 void              ntreeMakeLocal(struct bNodeTree *ntree);
320 int               ntreeHasType(struct bNodeTree *ntree, int type);
321 void              ntreeUpdateTree(struct bNodeTree *ntree);
322 /* XXX Currently each tree update call does call to ntreeVerifyNodes too.
323  * Some day this should be replaced by a decent depsgraph automatism!
324  */
325 void              ntreeVerifyNodes(struct Main *main, struct ID *id);
326
327 void              ntreeGetDependencyList(struct bNodeTree *ntree, struct bNode ***deplist, int *totnodes);
328
329 /* XXX old trees handle output flags automatically based on special output node types and last active selection.
330  * new tree types have a per-output socket flag to indicate the final output to use explicitly.
331  */
332 void            ntreeSetOutput(struct bNodeTree *ntree);
333 void            ntreeInitPreview(struct bNodeTree *, int xsize, int ysize);
334 void            ntreeClearPreview(struct bNodeTree *ntree);
335
336 void            ntreeFreeCache(struct bNodeTree *ntree);
337
338 int             ntreeNodeExists(struct bNodeTree *ntree, struct bNode *testnode);
339 int             ntreeOutputExists(struct bNode *node, struct bNodeSocket *testsock);
340 struct bNodeTree *ntreeLocalize(struct bNodeTree *ntree);
341 void            ntreeLocalSync(struct bNodeTree *localtree, struct bNodeTree *ntree);
342 void            ntreeLocalMerge(struct bNodeTree *localtree, struct bNodeTree *ntree);
343
344 /* ************** GENERIC API, NODES *************** */
345
346 struct bNodeSocket *nodeAddSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, const char *name, int type);
347 struct bNodeSocket *nodeInsertSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, struct bNodeSocket *next_sock, const char *name, int type);
348 void nodeRemoveSocket(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock);
349 void nodeRemoveAllSockets(struct bNodeTree *ntree, struct bNode *node);
350
351 void            nodeAddToPreview(struct bNode *node, const float col[4], int x, int y, int do_manage);
352
353 struct bNode    *nodeAddNode(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
354 void            nodeUnlinkNode(struct bNodeTree *ntree, struct bNode *node);
355 void            nodeUniqueName(struct bNodeTree *ntree, struct bNode *node);
356
357 void            nodeRegisterType(struct bNodeTreeType *ttype, struct bNodeType *ntype);
358 void            nodeMakeDynamicType(struct bNode *node);
359 int             nodeDynamicUnlinkText(struct ID *txtid);
360
361 void            nodeFreeNode(struct bNodeTree *ntree, struct bNode *node);
362 struct bNode    *nodeCopyNode(struct bNodeTree *ntree, struct bNode *node);
363
364 struct bNodeLink *nodeAddLink(struct bNodeTree *ntree, struct bNode *fromnode, struct bNodeSocket *fromsock, struct bNode *tonode, struct bNodeSocket *tosock);
365 void            nodeRemLink(struct bNodeTree *ntree, struct bNodeLink *link);
366 void            nodeRemSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
367 void            nodeInternalRelink(struct bNodeTree *ntree, struct bNode *node);
368
369 void            nodeToView(struct bNode *node, float x, float y, float *rx, float *ry);
370 void            nodeFromView(struct bNode *node, float x, float y, float *rx, float *ry);
371 int             nodeAttachNodeCheck(struct bNode *node, struct bNode *parent);
372 void            nodeAttachNode(struct bNode *node, struct bNode *parent);
373 void            nodeDetachNode(struct bNode *node);
374
375 struct bNode   *nodeFindNodebyName(struct bNodeTree *ntree, const char *name);
376 int             nodeFindNode(struct bNodeTree *ntree, struct bNodeSocket *sock, struct bNode **nodep, int *sockindex, int *in_out);
377
378 struct bNodeLink *nodeFindLink(struct bNodeTree *ntree, struct bNodeSocket *from, struct bNodeSocket *to);
379 int             nodeCountSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
380
381 void            nodeSetActive(struct bNodeTree *ntree, struct bNode *node);
382 struct bNode   *nodeGetActive(struct bNodeTree *ntree);
383 struct bNode   *nodeGetActiveID(struct bNodeTree *ntree, short idtype);
384 int             nodeSetActiveID(struct bNodeTree *ntree, short idtype, struct ID *id);
385 void            nodeClearActive(struct bNodeTree *ntree);
386 void            nodeClearActiveID(struct bNodeTree *ntree, short idtype);
387 struct bNode   *nodeGetActiveTexture(struct bNodeTree *ntree);
388
389 void            nodeUpdate(struct bNodeTree *ntree, struct bNode *node);
390 int             nodeUpdateID(struct bNodeTree *ntree, struct ID *id);
391 void            nodeUpdateInternalLinks(struct bNodeTree *ntree, struct bNode *node);
392
393 void            nodeFreePreview(struct bNode *node);
394
395 int             nodeSocketIsHidden(struct bNodeSocket *sock);
396 void            nodeSocketSetType(struct bNodeSocket *sock, int type);
397
398 /* Node Clipboard */
399 void                   BKE_node_clipboard_init(struct bNodeTree *ntree);
400 void                   BKE_node_clipboard_clear(void);
401 int                    BKE_node_clipboard_validate(void);
402 void                   BKE_node_clipboard_add_node(struct bNode *node);
403 void                   BKE_node_clipboard_add_link(struct bNodeLink *link);
404 const struct ListBase *BKE_node_clipboard_get_nodes(void);
405 const struct ListBase *BKE_node_clipboard_get_links(void);
406 int                    BKE_node_clipboard_get_type(void);
407
408 /* ************** NODE TYPE ACCESS *************** */
409
410 struct bNodeTemplate nodeMakeTemplate(struct bNode *node);
411 int             nodeValid(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
412 const char     *nodeLabel(struct bNode *node);
413 struct bNodeTree *nodeGroupEditGet(struct bNode *node);
414 struct bNodeTree *nodeGroupEditSet(struct bNode *node, int edit);
415 void            nodeGroupEditClear(struct bNode *node);
416
417 /* Init a new node type struct with default values and callbacks */
418 void            node_type_base(struct bNodeTreeType *ttype, struct bNodeType *ntype, int type,
419                                const char *name, short nclass, short flag);
420 void            node_type_socket_templates(struct bNodeType *ntype, struct bNodeSocketTemplate *inputs, struct bNodeSocketTemplate *outputs);
421 void            node_type_size(struct bNodeType *ntype, int width, int minwidth, int maxwidth);
422 void            node_type_init(struct bNodeType *ntype, void (*initfunc)(struct bNodeTree *ntree, struct bNode *node, struct bNodeTemplate *ntemp));
423 void            node_type_valid(struct bNodeType *ntype, int (*validfunc)(struct bNodeTree *ntree, struct bNodeTemplate *ntemp));
424 void            node_type_storage(struct bNodeType *ntype,
425                                   const char *storagename,
426                                   void (*freestoragefunc)(struct bNode *),
427                                   void (*copystoragefunc)(struct bNode *, struct bNode *));
428 void            node_type_label(struct bNodeType *ntype, const char *(*labelfunc)(struct bNode *));
429 void            node_type_template(struct bNodeType *ntype, struct bNodeTemplate (*templatefunc)(struct bNode *));
430 void            node_type_update(struct bNodeType *ntype,
431                                  void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node),
432                                  void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id));
433 void            node_type_tree(struct bNodeType *ntype,
434                                void (*inittreefunc)(struct bNodeTree *),
435                                void (*updatetreefunc)(struct bNodeTree *));
436 void            node_type_group_edit(struct bNodeType *ntype,
437                                      struct bNodeTree *(*group_edit_get)(struct bNode *node),
438                                      struct bNodeTree *(*group_edit_set)(struct bNode *node, int edit),
439                                      void (*group_edit_clear)(struct bNode *node));
440
441 void            node_type_exec(struct bNodeType *ntype, void (*execfunc)(void *data, struct bNode *, struct bNodeStack **,
442                                                                          struct bNodeStack **));
443 void            node_type_exec_new(struct bNodeType *ntype,
444                                    void *(*initexecfunc)(struct bNode *node),
445                                    void (*freeexecfunc)(struct bNode *node, void *nodedata),
446                                    void (*newexecfunc)(void *data, int thread, struct bNode *, void *nodedata,
447                                                        struct bNodeStack **, struct bNodeStack **));
448 void            node_type_internal_links(struct bNodeType *ntype, void (*update_internal_links)(struct bNodeTree *, struct bNode *));
449 void            node_type_gpu(struct bNodeType *ntype, int (*gpufunc)(struct GPUMaterial *mat, struct bNode *node,
450                                                                       struct GPUNodeStack *in, struct GPUNodeStack *out));
451 void            node_type_gpu_ext(struct bNodeType *ntype, int (*gpuextfunc)(struct GPUMaterial *mat, struct bNode *node,
452                                                                              void *nodedata, struct GPUNodeStack *in,
453                                                                              struct GPUNodeStack *out));
454 void            node_type_compatibility(struct bNodeType *ntype, short compatibility);
455
456 /* ************** COMMON NODES *************** */
457
458 #define NODE_GROUP              2
459 #define __NODE_FORLOOP  3       /* deprecated */
460 #define __NODE_WHILELOOP        4       /* deprecated */
461 #define NODE_FRAME              5
462 #define NODE_REROUTE    6
463
464 /* look up a socket on a group node by the internal group socket */
465 struct bNodeSocket *node_group_find_input(struct bNode *gnode, struct bNodeSocket *gsock);
466 struct bNodeSocket *node_group_find_output(struct bNode *gnode, struct bNodeSocket *gsock);
467
468 struct bNodeSocket *node_group_add_socket(struct bNodeTree *ngroup, const char *name, int type, int in_out);
469 struct bNodeSocket *node_group_expose_socket(struct bNodeTree *ngroup, struct bNodeSocket *sock, int in_out);
470 void node_group_expose_all_sockets(struct bNodeTree *ngroup);
471 void node_group_remove_socket(struct bNodeTree *ngroup, struct bNodeSocket *gsock, int in_out);
472 struct bNodeSocket *node_group_add_extern_socket(struct bNodeTree *ntree, ListBase *lb, int in_out, struct bNodeSocket *gsock);
473
474 /* in node_common.c */
475 void register_node_type_frame(struct bNodeTreeType *ttype);
476 void register_node_type_reroute(struct bNodeTreeType *ttype);
477
478 void BKE_node_tree_unlink_id_cb(void *calldata, struct ID *owner_id, struct bNodeTree *ntree);
479
480 /* ************** SHADER NODES *************** */
481
482 struct ShadeInput;
483 struct ShadeResult;
484
485 /* note: types are needed to restore callbacks, don't change values */
486 /* range 1 - 100 is reserved for common nodes */
487 /* using toolbox, we add node groups by assuming the values below don't exceed NODE_GROUP_MENU for now */
488
489 #define SH_NODE_OUTPUT          1
490
491 #define SH_NODE_MATERIAL        100
492 #define SH_NODE_RGB                     101
493 #define SH_NODE_VALUE           102
494 #define SH_NODE_MIX_RGB         103
495 #define SH_NODE_VALTORGB        104
496 #define SH_NODE_RGBTOBW         105
497 #define SH_NODE_TEXTURE         106
498 #define SH_NODE_NORMAL          107
499 #define SH_NODE_GEOMETRY        108
500 #define SH_NODE_MAPPING         109
501 #define SH_NODE_CURVE_VEC       110
502 #define SH_NODE_CURVE_RGB       111
503 #define SH_NODE_CAMERA          114
504 #define SH_NODE_MATH            115
505 #define SH_NODE_VECT_MATH       116
506 #define SH_NODE_SQUEEZE         117
507 #define SH_NODE_MATERIAL_EXT    118
508 #define SH_NODE_INVERT          119
509 #define SH_NODE_SEPRGB          120
510 #define SH_NODE_COMBRGB         121
511 #define SH_NODE_HUE_SAT         122
512 #define NODE_DYNAMIC            123
513
514 #define SH_NODE_OUTPUT_MATERIAL                 124
515 #define SH_NODE_OUTPUT_WORLD                    125
516 #define SH_NODE_OUTPUT_LAMP                             126
517 #define SH_NODE_FRESNEL                                 127
518 #define SH_NODE_MIX_SHADER                              128
519 #define SH_NODE_ATTRIBUTE                               129
520 #define SH_NODE_BACKGROUND                              130
521 #define SH_NODE_BSDF_ANISOTROPIC                131
522 #define SH_NODE_BSDF_DIFFUSE                    132
523 #define SH_NODE_BSDF_GLOSSY                             133
524 #define SH_NODE_BSDF_GLASS                              134
525 #define SH_NODE_BSDF_TRANSLUCENT                137
526 #define SH_NODE_BSDF_TRANSPARENT                138
527 #define SH_NODE_BSDF_VELVET                             139
528 #define SH_NODE_EMISSION                                140
529 #define SH_NODE_NEW_GEOMETRY                    141
530 #define SH_NODE_LIGHT_PATH                              142
531 #define SH_NODE_TEX_IMAGE                               143
532 #define SH_NODE_TEX_SKY                                 145
533 #define SH_NODE_TEX_GRADIENT                    146
534 #define SH_NODE_TEX_VORONOI                             147
535 #define SH_NODE_TEX_MAGIC                               148
536 #define SH_NODE_TEX_WAVE                                149
537 #define SH_NODE_TEX_NOISE                               150
538 #define SH_NODE_TEX_MUSGRAVE                    152
539 #define SH_NODE_TEX_COORD                               155
540 #define SH_NODE_ADD_SHADER                              156
541 #define SH_NODE_TEX_ENVIRONMENT                 157
542 #define SH_NODE_OUTPUT_TEXTURE                  158
543 #define SH_NODE_HOLDOUT                                 159
544 #define SH_NODE_LAYER_WEIGHT                    160
545 #define SH_NODE_VOLUME_TRANSPARENT              161
546 #define SH_NODE_VOLUME_ISOTROPIC                162
547 #define SH_NODE_GAMMA                                   163
548 #define SH_NODE_TEX_CHECKER                             164
549 #define SH_NODE_BRIGHTCONTRAST                  165
550 #define SH_NODE_LIGHT_FALLOFF                   166
551 #define SH_NODE_OBJECT_INFO                             167
552 #define SH_NODE_PARTICLE_INFO           168
553 #define SH_NODE_TEX_BRICK                               169
554 #define SH_NODE_BUMP                                    170
555 #define SH_NODE_SCRIPT                                  171
556 #define SH_NODE_AMBIENT_OCCLUSION               172
557 #define SH_NODE_BSDF_REFRACTION                 173
558 #define SH_NODE_TANGENT                                 174
559 #define SH_NODE_NORMAL_MAP                              175
560 #define SH_NODE_HAIR_INFO                               176
561
562 /* custom defines options for Material node */
563 #define SH_NODE_MAT_DIFF   1
564 #define SH_NODE_MAT_SPEC   2
565 #define SH_NODE_MAT_NEG    4
566 /* custom defines: states for Script node. These are bit indices */
567 #define NODE_DYNAMIC_READY      0 /* 1 */
568 #define NODE_DYNAMIC_LOADED     1 /* 2 */
569 #define NODE_DYNAMIC_NEW        2 /* 4 */
570 #define NODE_DYNAMIC_UPDATED    3 /* 8 */
571 #define NODE_DYNAMIC_ADDEXIST   4 /* 16 */
572 #define NODE_DYNAMIC_ERROR      5 /* 32 */
573 #define NODE_DYNAMIC_REPARSE    6 /* 64 */
574 #define NODE_DYNAMIC_SET        15 /* sign */
575
576 /* API */
577
578 struct bNodeTreeExec *ntreeShaderBeginExecTree(struct bNodeTree *ntree, int use_tree_data);
579 void            ntreeShaderEndExecTree(struct bNodeTreeExec *exec, int use_tree_data);
580 bool            ntreeShaderExecTree(struct bNodeTree *ntree, struct ShadeInput *shi, struct ShadeResult *shr);
581 void            ntreeShaderGetTexcoMode(struct bNodeTree *ntree, int osa, short *texco, int *mode);
582 void            nodeShaderSynchronizeID(struct bNode *node, int copyto);
583
584 /* switch material render loop */
585 extern void (*node_shader_lamp_loop)(struct ShadeInput *, struct ShadeResult *);
586 void            set_node_shader_lamp_loop(void (*lamp_loop_func)(struct ShadeInput *, struct ShadeResult *));
587
588 void            ntreeGPUMaterialNodes(struct bNodeTree *ntree, struct GPUMaterial *mat);
589
590
591 /* ************** COMPOSITE NODES *************** */
592
593 /* output socket defines */
594 #define RRES_OUT_IMAGE                          0
595 #define RRES_OUT_ALPHA                          1
596 #define RRES_OUT_Z                                      2
597 #define RRES_OUT_NORMAL                         3
598 #define RRES_OUT_UV                                     4
599 #define RRES_OUT_VEC                            5
600 #define RRES_OUT_RGBA                           6
601 #define RRES_OUT_DIFF                           7
602 #define RRES_OUT_SPEC                           8
603 #define RRES_OUT_SHADOW                         9
604 #define RRES_OUT_AO                                     10
605 #define RRES_OUT_REFLECT                        11
606 #define RRES_OUT_REFRACT                        12
607 #define RRES_OUT_INDIRECT                       13
608 #define RRES_OUT_INDEXOB                        14
609 #define RRES_OUT_INDEXMA                        15
610 #define RRES_OUT_MIST                           16
611 #define RRES_OUT_EMIT                           17
612 #define RRES_OUT_ENV                            18
613 #define RRES_OUT_DIFF_DIRECT            19
614 #define RRES_OUT_DIFF_INDIRECT          20
615 #define RRES_OUT_DIFF_COLOR                     21
616 #define RRES_OUT_GLOSSY_DIRECT          22
617 #define RRES_OUT_GLOSSY_INDIRECT        23
618 #define RRES_OUT_GLOSSY_COLOR           24
619 #define RRES_OUT_TRANSM_DIRECT          25
620 #define RRES_OUT_TRANSM_INDIRECT        26
621 #define RRES_OUT_TRANSM_COLOR           27
622
623 /* note: types are needed to restore callbacks, don't change values */
624 #define CMP_NODE_VIEWER         201
625 #define CMP_NODE_RGB            202
626 #define CMP_NODE_VALUE          203
627 #define CMP_NODE_MIX_RGB        204
628 #define CMP_NODE_VALTORGB       205
629 #define CMP_NODE_RGBTOBW        206
630 #define CMP_NODE_NORMAL         207
631 #define CMP_NODE_CURVE_VEC      208
632 #define CMP_NODE_CURVE_RGB      209
633 #define CMP_NODE_ALPHAOVER      210
634 #define CMP_NODE_BLUR           211
635 #define CMP_NODE_FILTER         212
636 #define CMP_NODE_MAP_VALUE      213
637 #define CMP_NODE_TIME           214
638 #define CMP_NODE_VECBLUR        215
639 #define CMP_NODE_SEPRGBA        216
640 #define CMP_NODE_SEPHSVA        217
641 #define CMP_NODE_SETALPHA       218
642 #define CMP_NODE_HUE_SAT        219
643 #define CMP_NODE_IMAGE          220
644 #define CMP_NODE_R_LAYERS       221
645 #define CMP_NODE_COMPOSITE      222
646 #define CMP_NODE_OUTPUT_FILE    223
647 #define CMP_NODE_TEXTURE        224
648 #define CMP_NODE_TRANSLATE      225
649 #define CMP_NODE_ZCOMBINE       226
650 #define CMP_NODE_COMBRGBA       227
651 #define CMP_NODE_DILATEERODE    228
652 #define CMP_NODE_ROTATE         229
653 #define CMP_NODE_SCALE          230
654 #define CMP_NODE_SEPYCCA        231
655 #define CMP_NODE_COMBYCCA       232
656 #define CMP_NODE_SEPYUVA        233
657 #define CMP_NODE_COMBYUVA       234
658 #define CMP_NODE_DIFF_MATTE     235
659 #define CMP_NODE_COLOR_SPILL    236
660 #define CMP_NODE_CHROMA_MATTE   237
661 #define CMP_NODE_CHANNEL_MATTE  238
662 #define CMP_NODE_FLIP           239
663 #define CMP_NODE_SPLITVIEWER    240
664 #define CMP_NODE_INDEX_MASK     241
665 #define CMP_NODE_MAP_UV         242
666 #define CMP_NODE_ID_MASK        243
667 #define CMP_NODE_DEFOCUS        244
668 #define CMP_NODE_DISPLACE       245
669 #define CMP_NODE_COMBHSVA       246
670 #define CMP_NODE_MATH           247
671 #define CMP_NODE_LUMA_MATTE     248
672 #define CMP_NODE_BRIGHTCONTRAST 249
673 #define CMP_NODE_GAMMA          250
674 #define CMP_NODE_INVERT         251
675 #define CMP_NODE_NORMALIZE      252
676 #define CMP_NODE_CROP           253
677 #define CMP_NODE_DBLUR          254
678 #define CMP_NODE_BILATERALBLUR  255
679 #define CMP_NODE_PREMULKEY  256
680 #define CMP_NODE_DIST_MATTE     257
681 #define CMP_NODE_VIEW_LEVELS    258
682 #define CMP_NODE_COLOR_MATTE 259
683 #define CMP_NODE_COLORBALANCE 260
684 #define CMP_NODE_HUECORRECT 261
685 #define CMP_NODE_MOVIECLIP      262
686 #define CMP_NODE_STABILIZE2D    263
687 #define CMP_NODE_TRANSFORM      264
688 #define CMP_NODE_MOVIEDISTORTION        265
689 #define CMP_NODE_DOUBLEEDGEMASK    266
690 #define CMP_NODE_OUTPUT_MULTI_FILE__DEPRECATED  267     /* DEPRECATED multi file node has been merged into regular CMP_NODE_OUTPUT_FILE */
691 #define CMP_NODE_MASK           268
692 #define CMP_NODE_KEYINGSCREEN           269
693 #define CMP_NODE_KEYING                 270
694 #define CMP_NODE_TRACKPOS               271
695 #define CMP_NODE_INPAINT    272
696 #define CMP_NODE_DESPECKLE  273
697
698 #define CMP_NODE_GLARE          301
699 #define CMP_NODE_TONEMAP        302
700 #define CMP_NODE_LENSDIST       303
701
702 #define CMP_NODE_COLORCORRECTION 312
703 #define CMP_NODE_MASK_BOX       313
704 #define CMP_NODE_MASK_ELLIPSE   314
705 #define CMP_NODE_BOKEHIMAGE     315
706 #define CMP_NODE_BOKEHBLUR      316
707 #define CMP_NODE_SWITCH         317
708 #define CMP_NODE_PIXELATE       318
709
710 #define CMP_NODE_MAP_RANGE      319
711
712 /* channel toggles */
713 #define CMP_CHAN_RGB            1
714 #define CMP_CHAN_A                      2
715 #define CMP_CHAN_R                      4
716 #define CMP_CHAN_G                      8
717 #define CMP_CHAN_B                      16
718
719 /* filter types */
720 #define CMP_FILT_SOFT           0
721 #define CMP_FILT_SHARP          1
722 #define CMP_FILT_LAPLACE        2
723 #define CMP_FILT_SOBEL          3
724 #define CMP_FILT_PREWITT        4
725 #define CMP_FILT_KIRSCH         5
726 #define CMP_FILT_SHADOW         6
727
728 /* scale node type, in custom1 */
729 #define CMP_SCALE_RELATIVE              0
730 #define CMP_SCALE_ABSOLUTE              1
731 #define CMP_SCALE_SCENEPERCENT  2
732 #define CMP_SCALE_RENDERPERCENT 3
733 /* custom2 */
734 #define CMP_SCALE_RENDERSIZE_FRAME_ASPECT  (1 << 0)
735 #define CMP_SCALE_RENDERSIZE_FRAME_CROP    (1 << 1)
736
737
738 /* API */
739 struct CompBuf;
740 void ntreeCompositExecTree(struct bNodeTree *ntree, struct RenderData *rd, int rendering, int do_previews,
741                            const struct ColorManagedViewSettings *view_settings, const struct ColorManagedDisplaySettings *display_settings);
742 void ntreeCompositTagRender(struct Scene *sce);
743 int ntreeCompositTagAnimated(struct bNodeTree *ntree);
744 void ntreeCompositTagGenerators(struct bNodeTree *ntree);
745 void ntreeCompositForceHidden(struct bNodeTree *ntree, struct Scene *scene);
746 void ntreeCompositClearTags(struct bNodeTree *ntree);
747
748 struct bNodeSocket *ntreeCompositOutputFileAddSocket(struct bNodeTree *ntree, struct bNode *node,
749                                                      const char *name, struct ImageFormatData *im_format);
750 int ntreeCompositOutputFileRemoveActiveSocket(struct bNodeTree *ntree, struct bNode *node);
751 void ntreeCompositOutputFileSetPath(struct bNode *node, struct bNodeSocket *sock, const char *name);
752 void ntreeCompositOutputFileSetLayer(struct bNode *node, struct bNodeSocket *sock, const char *name);
753 /* needed in do_versions */
754 void ntreeCompositOutputFileUniquePath(struct ListBase *list, struct bNodeSocket *sock, const char defname[], char delim);
755 void ntreeCompositOutputFileUniqueLayer(struct ListBase *list, struct bNodeSocket *sock, const char defname[], char delim);
756
757 /* ************** TEXTURE NODES *************** */
758
759 struct TexResult;
760
761 #define TEX_NODE_OUTPUT     401
762 #define TEX_NODE_CHECKER    402
763 #define TEX_NODE_TEXTURE    403
764 #define TEX_NODE_BRICKS     404
765 #define TEX_NODE_MATH       405
766 #define TEX_NODE_MIX_RGB    406
767 #define TEX_NODE_RGBTOBW    407
768 #define TEX_NODE_VALTORGB   408
769 #define TEX_NODE_IMAGE      409
770 #define TEX_NODE_CURVE_RGB  410
771 #define TEX_NODE_INVERT     411
772 #define TEX_NODE_HUE_SAT    412
773 #define TEX_NODE_CURVE_TIME 413
774 #define TEX_NODE_ROTATE     414
775 #define TEX_NODE_VIEWER     415
776 #define TEX_NODE_TRANSLATE  416
777 #define TEX_NODE_COORD      417
778 #define TEX_NODE_DISTANCE   418
779 #define TEX_NODE_COMPOSE    419
780 #define TEX_NODE_DECOMPOSE  420
781 #define TEX_NODE_VALTONOR   421
782 #define TEX_NODE_SCALE      422
783 #define TEX_NODE_AT         423
784
785 /* 501-599 reserved. Use like this: TEX_NODE_PROC + TEX_CLOUDS, etc */
786 #define TEX_NODE_PROC      500
787 #define TEX_NODE_PROC_MAX  600
788
789 /* API */
790 int  ntreeTexTagAnimated(struct bNodeTree *ntree);
791 void ntreeTexCheckCyclics(struct bNodeTree *ntree);
792
793 struct bNodeTreeExec *ntreeTexBeginExecTree(struct bNodeTree *ntree, int use_tree_data);
794 void ntreeTexEndExecTree(struct bNodeTreeExec *exec, int use_tree_data);
795 int ntreeTexExecTree(struct bNodeTree *ntree, struct TexResult *target,
796                      float coord[3], float dxt[3], float dyt[3], int osatex, const short thread,
797                      struct Tex *tex, short which_output, int cfra, int preview, struct ShadeInput *shi, struct MTex *mtex);
798
799
800 /*************************************************/
801
802 void init_nodesystem(void);
803 void free_nodesystem(void);
804
805 void clear_scene_in_nodes(struct Main *bmain, struct Scene *sce);
806
807 #endif