Cleanup: comments (long lines) in blenkernel
[blender.git] / source / blender / blenkernel / BKE_node.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2005 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_NODE_H__
21 #define __BKE_NODE_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 #include "BLI_compiler_compat.h"
28 #include "BLI_ghash.h"
29
30 #include "DNA_listBase.h"
31
32 /* for FOREACH_NODETREE_BEGIN */
33 #include "DNA_light_types.h"
34 #include "DNA_material_types.h"
35 #include "DNA_node_types.h"
36 #include "DNA_scene_types.h"
37 #include "DNA_texture_types.h"
38 #include "DNA_world_types.h"
39 #include "DNA_linestyle_types.h"
40
41 #include "RNA_types.h"
42
43 /* not very important, but the stack solver likes to know a maximum */
44 #define MAX_SOCKET 512
45
46 struct ARegion;
47 struct ColorManagedDisplaySettings;
48 struct ColorManagedViewSettings;
49 struct GPUMaterial;
50 struct GPUNodeStack;
51 struct ID;
52 struct ImBuf;
53 struct ImageFormatData;
54 struct ListBase;
55 struct MTex;
56 struct Main;
57 struct PointerRNA;
58 struct RenderData;
59 struct Scene;
60 struct SpaceNode;
61 struct Tex;
62 struct ViewRender;
63 struct bContext;
64 struct bNode;
65 struct bNodeExecContext;
66 struct bNodeExecData;
67 struct bNodeInstanceHash;
68 struct bNodeLink;
69 struct bNodeSocket;
70 struct bNodeStack;
71 struct bNodeTree;
72 struct bNodeTreeExec;
73 struct bNodeTreeType;
74 struct uiLayout;
75
76 /* -------------------------------------------------------------------- */
77 /** \name Node Type Definitions
78  * \{ */
79
80 /** Compact definition of a node socket.
81  * Can be used to quickly define a list of static sockets for a node,
82  * which are added to each new node of that type.
83  *
84  * \deprecated This struct is used by C nodes to define templates as simple
85  * static struct lists. These are converted to the new template collections
86  * in RNA types automatically.
87  */
88 typedef struct bNodeSocketTemplate {
89   int type, limit;
90   char name[64];                /* MAX_NAME */
91   float val1, val2, val3, val4; /* default alloc value for inputs */
92   float min, max;
93   int subtype; /* would use PropertySubType but this is a bad level include to use RNA */
94   int flag;
95
96   /* after this line is used internal only */
97   struct bNodeSocket *sock; /* used to hold verified socket */
98   char identifier[64];      /* generated from name */
99 } bNodeSocketTemplate;
100
101 /** Defines a socket type.
102  * Defines the appearance and behavior of a socket in the UI.
103  */
104 typedef struct bNodeSocketType {
105   char idname[64]; /* identifier name */
106
107   void (*draw)(struct bContext *C,
108                struct uiLayout *layout,
109                struct PointerRNA *ptr,
110                struct PointerRNA *node_ptr,
111                const char *text);
112   void (*draw_color)(struct bContext *C,
113                      struct PointerRNA *ptr,
114                      struct PointerRNA *node_ptr,
115                      float *r_color);
116
117   void (*interface_draw)(struct bContext *C, struct uiLayout *layout, struct PointerRNA *ptr);
118   void (*interface_draw_color)(struct bContext *C, struct PointerRNA *ptr, float *r_color);
119   void (*interface_register_properties)(struct bNodeTree *ntree,
120                                         struct bNodeSocket *stemp,
121                                         struct StructRNA *data_srna);
122   void (*interface_init_socket)(struct bNodeTree *ntree,
123                                 struct bNodeSocket *stemp,
124                                 struct bNode *node,
125                                 struct bNodeSocket *sock,
126                                 const char *data_path);
127   void (*interface_verify_socket)(struct bNodeTree *ntree,
128                                   struct bNodeSocket *stemp,
129                                   struct bNode *node,
130                                   struct bNodeSocket *sock,
131                                   const char *data_path);
132   void (*interface_from_socket)(struct bNodeTree *ntree,
133                                 struct bNodeSocket *stemp,
134                                 struct bNode *node,
135                                 struct bNodeSocket *sock);
136
137   /* RNA integration */
138   ExtensionRNA ext_socket;
139   ExtensionRNA ext_interface;
140
141   /* for standard socket types in C */
142   int type, subtype;
143 } bNodeSocketType;
144
145 typedef void *(*NodeInitExecFunction)(struct bNodeExecContext *context,
146                                       struct bNode *node,
147                                       bNodeInstanceKey key);
148 typedef void (*NodeFreeExecFunction)(void *nodedata);
149 typedef void (*NodeExecFunction)(void *data,
150                                  int thread,
151                                  struct bNode *,
152                                  struct bNodeExecData *execdata,
153                                  struct bNodeStack **in,
154                                  struct bNodeStack **out);
155 typedef int (*NodeGPUExecFunction)(struct GPUMaterial *mat,
156                                    struct bNode *node,
157                                    struct bNodeExecData *execdata,
158                                    struct GPUNodeStack *in,
159                                    struct GPUNodeStack *out);
160
161 /** Defines a node type.
162  * Initial attributes and constants for a node as well as callback functions
163  * implementing the node behavior.
164  */
165 typedef struct bNodeType {
166   void *next, *prev;
167   short needs_free; /* set for allocated types that need to be freed */
168
169   char idname[64]; /* identifier name */
170   int type;
171
172   char ui_name[64]; /* MAX_NAME */
173   char ui_description[256];
174   int ui_icon;
175
176   float width, minwidth, maxwidth;
177   float height, minheight, maxheight;
178   short nclass, flag;
179
180   /* templates for static sockets */
181   bNodeSocketTemplate *inputs, *outputs;
182
183   char storagename[64]; /* struct name for DNA */
184
185   /* Main draw function for the node */
186   void (*draw_nodetype)(const struct bContext *C,
187                         struct ARegion *ar,
188                         struct SpaceNode *snode,
189                         struct bNodeTree *ntree,
190                         struct bNode *node,
191                         bNodeInstanceKey key);
192   /* Updates the node geometry attributes according to internal state before actual drawing */
193   void (*draw_nodetype_prepare)(const struct bContext *C,
194                                 struct bNodeTree *ntree,
195                                 struct bNode *node);
196
197   /* Draw the option buttons on the node */
198   void (*draw_buttons)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
199   /* Additional parameters in the side panel */
200   void (*draw_buttons_ex)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
201
202   /* Additional drawing on backdrop */
203   void (*draw_backdrop)(
204       struct SpaceNode *snode, struct ImBuf *backdrop, struct bNode *node, int x, int y);
205
206   /**
207    * Optional custom label function for the node header.
208    * \note Used as a fallback when #bNode.label isn't set.
209    */
210   void (*labelfunc)(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
211   /// Optional custom resize handle polling.
212   int (*resize_area_func)(struct bNode *node, int x, int y);
213   /// Optional selection area polling.
214   int (*select_area_func)(struct bNode *node, int x, int y);
215   /// Optional tweak area polling (for grabbing).
216   int (*tweak_area_func)(struct bNode *node, int x, int y);
217
218   /// Called when the node is updated in the editor.
219   void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node);
220   /// Check and update if internal ID data has changed.
221   void (*group_update_func)(struct bNodeTree *ntree, struct bNode *node);
222
223   /// Initialize a new node instance of this type after creation.
224   void (*initfunc)(struct bNodeTree *ntree, struct bNode *node);
225   /// Free the node instance.
226   void (*freefunc)(struct bNode *node);
227   /// Make a copy of the node instance.
228   void (*copyfunc)(struct bNodeTree *dest_ntree, struct bNode *dest_node, struct bNode *src_node);
229
230   /* Registerable API callback versions, called in addition to C callbacks */
231   void (*initfunc_api)(const struct bContext *C, struct PointerRNA *ptr);
232   void (*freefunc_api)(struct PointerRNA *ptr);
233   void (*copyfunc_api)(struct PointerRNA *ptr, struct bNode *src_node);
234
235   /* can this node type be added to a node tree */
236   bool (*poll)(struct bNodeType *ntype, struct bNodeTree *nodetree);
237   /* can this node be added to a node tree */
238   bool (*poll_instance)(struct bNode *node, struct bNodeTree *nodetree);
239
240   /* optional handling of link insertion */
241   void (*insert_link)(struct bNodeTree *ntree, struct bNode *node, struct bNodeLink *link);
242   /* Update the internal links list, for muting and disconnect operators. */
243   void (*update_internal_links)(struct bNodeTree *, struct bNode *node);
244
245   /* **** execution callbacks **** */
246   NodeInitExecFunction initexecfunc;
247   NodeFreeExecFunction freeexecfunc;
248   NodeExecFunction execfunc;
249   /* gpu */
250   NodeGPUExecFunction gpufunc;
251
252   /* RNA integration */
253   ExtensionRNA ext;
254 } bNodeType;
255
256 /* nodetype->nclass, for add-menu and themes */
257 #define NODE_CLASS_INPUT 0
258 #define NODE_CLASS_OUTPUT 1
259 #define NODE_CLASS_OP_COLOR 3
260 #define NODE_CLASS_OP_VECTOR 4
261 #define NODE_CLASS_OP_FILTER 5
262 #define NODE_CLASS_GROUP 6
263 // #define NODE_CLASS_FILE              7
264 #define NODE_CLASS_CONVERTOR 8
265 #define NODE_CLASS_MATTE 9
266 #define NODE_CLASS_DISTORT 10
267 // #define NODE_CLASS_OP_DYNAMIC        11 /* deprecated */
268 #define NODE_CLASS_PATTERN 12
269 #define NODE_CLASS_TEXTURE 13
270 // #define NODE_CLASS_EXECUTION     14
271 // #define NODE_CLASS_GETDATA           15
272 // #define NODE_CLASS_SETDATA           16
273 // #define NODE_CLASS_MATH              17
274 // #define NODE_CLASS_MATH_VECTOR       18
275 // #define NODE_CLASS_MATH_ROTATION 19
276 // #define NODE_CLASS_PARTICLES     25
277 // #define NODE_CLASS_TRANSFORM     30
278 // #define NODE_CLASS_COMBINE           31
279 #define NODE_CLASS_SCRIPT 32
280 #define NODE_CLASS_INTERFACE 33
281 #define NODE_CLASS_SHADER 40
282 #define NODE_CLASS_LAYOUT 100
283
284 /* node resize directions */
285 #define NODE_RESIZE_TOP 1
286 #define NODE_RESIZE_BOTTOM 2
287 #define NODE_RESIZE_RIGHT 4
288 #define NODE_RESIZE_LEFT 8
289
290 typedef enum eNodeSizePreset {
291   NODE_SIZE_DEFAULT,
292   NODE_SIZE_SMALL,
293   NODE_SIZE_MIDDLE,
294   NODE_SIZE_LARGE,
295 } eNodeSizePreset;
296
297 struct bNodeTreeExec;
298
299 typedef void (*bNodeClassCallback)(void *calldata, int nclass, const char *name);
300 typedef struct bNodeTreeType {
301   int type;        /* type identifier */
302   char idname[64]; /* identifier name */
303
304   char ui_name[64];
305   char ui_description[256];
306   int ui_icon;
307
308   /* callbacks */
309   void (*free_cache)(struct bNodeTree *ntree);
310   void (*free_node_cache)(struct bNodeTree *ntree, struct bNode *node);
311   void (*foreach_nodeclass)(struct Scene *scene,
312                             void *calldata,
313                             bNodeClassCallback func); /* iteration over all node classes */
314   /* Check visibility in the node editor */
315   bool (*poll)(const struct bContext *C, struct bNodeTreeType *ntreetype);
316   /* Select a node tree from the context */
317   void (*get_from_context)(const struct bContext *C,
318                            struct bNodeTreeType *ntreetype,
319                            struct bNodeTree **r_ntree,
320                            struct ID **r_id,
321                            struct ID **r_from);
322
323   /* calls allowing threaded composite */
324   void (*localize)(struct bNodeTree *localtree, struct bNodeTree *ntree);
325   void (*local_sync)(struct bNodeTree *localtree, struct bNodeTree *ntree);
326   void (*local_merge)(struct Main *bmain, struct bNodeTree *localtree, struct bNodeTree *ntree);
327
328   /* Tree update. Overrides nodetype->updatetreefunc! */
329   void (*update)(struct bNodeTree *ntree);
330
331   bool (*validate_link)(struct bNodeTree *ntree, struct bNodeLink *link);
332
333   void (*node_add_init)(struct bNodeTree *ntree, struct bNode *bnode);
334
335   /* RNA integration */
336   ExtensionRNA ext;
337 } bNodeTreeType;
338
339 /** \} */
340
341 /* -------------------------------------------------------------------- */
342 /** \name Generic API, Trees
343  * \{ */
344
345 struct bNodeTreeType *ntreeTypeFind(const char *idname);
346 void ntreeTypeAdd(struct bNodeTreeType *nt);
347 void ntreeTypeFreeLink(const struct bNodeTreeType *nt);
348 bool ntreeIsRegistered(struct bNodeTree *ntree);
349 struct GHashIterator *ntreeTypeGetIterator(void);
350
351 /* helper macros for iterating over tree types */
352 #define NODE_TREE_TYPES_BEGIN(ntype) \
353   { \
354     GHashIterator *__node_tree_type_iter__ = ntreeTypeGetIterator(); \
355     for (; !BLI_ghashIterator_done(__node_tree_type_iter__); \
356          BLI_ghashIterator_step(__node_tree_type_iter__)) { \
357       bNodeTreeType *ntype = BLI_ghashIterator_getValue(__node_tree_type_iter__);
358
359 #define NODE_TREE_TYPES_END \
360   } \
361   BLI_ghashIterator_free(__node_tree_type_iter__); \
362   } \
363   (void)0
364
365 void ntreeSetTypes(const struct bContext *C, struct bNodeTree *ntree);
366
367 void ntreeInitDefault(struct bNodeTree *ntree);
368 struct bNodeTree *ntreeAddTree(struct Main *bmain, const char *name, const char *idname);
369
370 /* copy/free funcs, need to manage ID users */
371 void ntreeFreeTree(struct bNodeTree *ntree);
372 /* Free tree which is owned byt another datablock. */
373 void ntreeFreeNestedTree(struct bNodeTree *ntree);
374 void BKE_node_tree_copy_data(struct Main *bmain,
375                              struct bNodeTree *ntree_dst,
376                              const struct bNodeTree *ntree_src,
377                              const int flag);
378 struct bNodeTree *ntreeCopyTree_ex(const struct bNodeTree *ntree,
379                                    struct Main *bmain,
380                                    const bool do_id_user);
381 struct bNodeTree *ntreeCopyTree(struct Main *bmain, const struct bNodeTree *ntree);
382 /* node->id user count */
383 void ntreeUserIncrefID(struct bNodeTree *ntree);
384 void ntreeUserDecrefID(struct bNodeTree *ntree);
385
386 struct bNodeTree *ntreeFromID(const struct ID *id);
387
388 void ntreeMakeLocal(struct Main *bmain,
389                     struct bNodeTree *ntree,
390                     bool id_in_mainlist,
391                     const bool lib_local);
392 void ntreeFreeLocalNode(struct bNodeTree *ntree, struct bNode *node);
393 void ntreeFreeLocalTree(struct bNodeTree *ntree);
394 struct bNode *ntreeFindType(const struct bNodeTree *ntree, int type);
395 bool ntreeHasType(const struct bNodeTree *ntree, int type);
396 bool ntreeHasTree(const struct bNodeTree *ntree, const struct bNodeTree *lookup);
397 void ntreeUpdateTree(struct Main *main, struct bNodeTree *ntree);
398 void ntreeUpdateAllNew(struct Main *main);
399 void ntreeUpdateAllUsers(struct Main *main, struct ID *id);
400
401 void ntreeGetDependencyList(struct bNodeTree *ntree, struct bNode ***deplist, int *totnodes);
402
403 /* XXX old trees handle output flags automatically based on special output
404  * node types and last active selection.
405  * New tree types have a per-output socket flag to indicate the final output to use explicitly.
406  */
407 void ntreeSetOutput(struct bNodeTree *ntree);
408
409 void ntreeFreeCache(struct bNodeTree *ntree);
410
411 int ntreeNodeExists(struct bNodeTree *ntree, struct bNode *testnode);
412 int ntreeOutputExists(struct bNode *node, struct bNodeSocket *testsock);
413 void ntreeNodeFlagSet(const bNodeTree *ntree, const int flag, const bool enable);
414 struct bNodeTree *ntreeLocalize(struct bNodeTree *ntree);
415 void ntreeLocalSync(struct bNodeTree *localtree, struct bNodeTree *ntree);
416 void ntreeLocalMerge(struct Main *bmain, struct bNodeTree *localtree, struct bNodeTree *ntree);
417
418 /** \} */
419
420 /* -------------------------------------------------------------------- */
421 /** \name Node Tree Interface
422  * \{ */
423 struct bNodeSocket *ntreeFindSocketInterface(struct bNodeTree *ntree,
424                                              int in_out,
425                                              const char *identifier);
426 struct bNodeSocket *ntreeAddSocketInterface(struct bNodeTree *ntree,
427                                             int in_out,
428                                             const char *idname,
429                                             const char *name);
430 struct bNodeSocket *ntreeInsertSocketInterface(struct bNodeTree *ntree,
431                                                int in_out,
432                                                const char *idname,
433                                                struct bNodeSocket *next_sock,
434                                                const char *name);
435 struct bNodeSocket *ntreeAddSocketInterfaceFromSocket(struct bNodeTree *ntree,
436                                                       struct bNode *from_node,
437                                                       struct bNodeSocket *from_sock);
438 struct bNodeSocket *ntreeInsertSocketInterfaceFromSocket(struct bNodeTree *ntree,
439                                                          struct bNodeSocket *next_sock,
440                                                          struct bNode *from_node,
441                                                          struct bNodeSocket *from_sock);
442 void ntreeRemoveSocketInterface(struct bNodeTree *ntree, struct bNodeSocket *sock);
443
444 struct StructRNA *ntreeInterfaceTypeGet(struct bNodeTree *ntree, int create);
445 void ntreeInterfaceTypeFree(struct bNodeTree *ntree);
446 void ntreeInterfaceTypeUpdate(struct bNodeTree *ntree);
447
448 /** \} */
449
450 /* -------------------------------------------------------------------- */
451 /** \name Generic API, Nodes
452  * \{ */
453
454 struct bNodeType *nodeTypeFind(const char *idname);
455 void nodeRegisterType(struct bNodeType *ntype);
456 void nodeUnregisterType(struct bNodeType *ntype);
457 bool nodeIsRegistered(struct bNode *node);
458 struct GHashIterator *nodeTypeGetIterator(void);
459
460 /* helper macros for iterating over node types */
461 #define NODE_TYPES_BEGIN(ntype) \
462   { \
463     GHashIterator *__node_type_iter__ = nodeTypeGetIterator(); \
464     for (; !BLI_ghashIterator_done(__node_type_iter__); \
465          BLI_ghashIterator_step(__node_type_iter__)) { \
466       bNodeType *ntype = BLI_ghashIterator_getValue(__node_type_iter__);
467
468 #define NODE_TYPES_END \
469   } \
470   BLI_ghashIterator_free(__node_type_iter__); \
471   } \
472   ((void)0)
473
474 struct bNodeSocketType *nodeSocketTypeFind(const char *idname);
475 void nodeRegisterSocketType(struct bNodeSocketType *stype);
476 void nodeUnregisterSocketType(struct bNodeSocketType *stype);
477 bool nodeSocketIsRegistered(struct bNodeSocket *sock);
478 struct GHashIterator *nodeSocketTypeGetIterator(void);
479 const char *nodeStaticSocketType(int type, int subtype);
480 const char *nodeStaticSocketInterfaceType(int type, int subtype);
481
482 /* helper macros for iterating over node types */
483 #define NODE_SOCKET_TYPES_BEGIN(stype) \
484   { \
485     GHashIterator *__node_socket_type_iter__ = nodeSocketTypeGetIterator(); \
486     for (; !BLI_ghashIterator_done(__node_socket_type_iter__); \
487          BLI_ghashIterator_step(__node_socket_type_iter__)) { \
488       bNodeSocketType *stype = BLI_ghashIterator_getValue(__node_socket_type_iter__);
489
490 #define NODE_SOCKET_TYPES_END \
491   } \
492   BLI_ghashIterator_free(__node_socket_type_iter__); \
493   } \
494   ((void)0)
495
496 struct bNodeSocket *nodeFindSocket(struct bNode *node, int in_out, const char *identifier);
497 struct bNodeSocket *nodeAddSocket(struct bNodeTree *ntree,
498                                   struct bNode *node,
499                                   int in_out,
500                                   const char *idname,
501                                   const char *identifier,
502                                   const char *name);
503 struct bNodeSocket *nodeInsertSocket(struct bNodeTree *ntree,
504                                      struct bNode *node,
505                                      int in_out,
506                                      const char *idname,
507                                      struct bNodeSocket *next_sock,
508                                      const char *identifier,
509                                      const char *name);
510 struct bNodeSocket *nodeAddStaticSocket(struct bNodeTree *ntree,
511                                         struct bNode *node,
512                                         int in_out,
513                                         int type,
514                                         int subtype,
515                                         const char *identifier,
516                                         const char *name);
517 struct bNodeSocket *nodeInsertStaticSocket(struct bNodeTree *ntree,
518                                            struct bNode *node,
519                                            int in_out,
520                                            int type,
521                                            int subtype,
522                                            struct bNodeSocket *next_sock,
523                                            const char *identifier,
524                                            const char *name);
525 void nodeRemoveSocket(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock);
526 void nodeRemoveAllSockets(struct bNodeTree *ntree, struct bNode *node);
527 void nodeModifySocketType(
528     struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock, int type, int subtype);
529
530 struct bNode *nodeAddNode(const struct bContext *C, struct bNodeTree *ntree, const char *idname);
531 struct bNode *nodeAddStaticNode(const struct bContext *C, struct bNodeTree *ntree, int type);
532 void nodeUnlinkNode(struct bNodeTree *ntree, struct bNode *node);
533 void nodeUniqueName(struct bNodeTree *ntree, struct bNode *node);
534
535 /* Delete node, associated animation data and ID user count. */
536 void nodeRemoveNode(struct Main *bmain,
537                     struct bNodeTree *ntree,
538                     struct bNode *node,
539                     bool do_id_user);
540
541 struct bNode *BKE_node_copy_ex(struct bNodeTree *ntree, struct bNode *node_src, const int flag);
542
543 struct bNodeLink *nodeAddLink(struct bNodeTree *ntree,
544                               struct bNode *fromnode,
545                               struct bNodeSocket *fromsock,
546                               struct bNode *tonode,
547                               struct bNodeSocket *tosock);
548 void nodeRemLink(struct bNodeTree *ntree, struct bNodeLink *link);
549 void nodeRemSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
550 bool nodeLinkIsHidden(struct bNodeLink *link);
551 void nodeInternalRelink(struct bNodeTree *ntree, struct bNode *node);
552
553 void nodeToView(struct bNode *node, float x, float y, float *rx, float *ry);
554 void nodeFromView(struct bNode *node, float x, float y, float *rx, float *ry);
555 bool nodeAttachNodeCheck(struct bNode *node, struct bNode *parent);
556 void nodeAttachNode(struct bNode *node, struct bNode *parent);
557 void nodeDetachNode(struct bNode *node);
558
559 void nodePositionRelative(struct bNode *from_node,
560                           struct bNode *to_node,
561                           struct bNodeSocket *from_sock,
562                           struct bNodeSocket *to_sock);
563 void nodePositionPropagate(struct bNode *node);
564
565 struct bNode *nodeFindNodebyName(struct bNodeTree *ntree, const char *name);
566 int nodeFindNode(struct bNodeTree *ntree,
567                  struct bNodeSocket *sock,
568                  struct bNode **nodep,
569                  int *sockindex);
570 struct bNode *nodeFindRootParent(bNode *node);
571
572 bool nodeIsChildOf(const bNode *parent, const bNode *child);
573
574 void nodeChainIter(const bNodeTree *ntree,
575                    const bNode *node_start,
576                    bool (*callback)(bNode *, bNode *, void *, const bool),
577                    void *userdata,
578                    const bool reversed);
579 void nodeParentsIter(bNode *node, bool (*callback)(bNode *, void *), void *userdata);
580
581 struct bNodeLink *nodeFindLink(struct bNodeTree *ntree,
582                                struct bNodeSocket *from,
583                                struct bNodeSocket *to);
584 int nodeCountSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
585
586 void nodeSetSelected(struct bNode *node, bool select);
587 void nodeSetActive(struct bNodeTree *ntree, struct bNode *node);
588 struct bNode *nodeGetActive(struct bNodeTree *ntree);
589 struct bNode *nodeGetActiveID(struct bNodeTree *ntree, short idtype);
590 bool nodeSetActiveID(struct bNodeTree *ntree, short idtype, struct ID *id);
591 void nodeClearActive(struct bNodeTree *ntree);
592 void nodeClearActiveID(struct bNodeTree *ntree, short idtype);
593 struct bNode *nodeGetActiveTexture(struct bNodeTree *ntree);
594
595 void nodeUpdate(struct bNodeTree *ntree, struct bNode *node);
596 bool nodeUpdateID(struct bNodeTree *ntree, struct ID *id);
597 void nodeUpdateInternalLinks(struct bNodeTree *ntree, struct bNode *node);
598
599 int nodeSocketIsHidden(struct bNodeSocket *sock);
600 void ntreeTagUsedSockets(struct bNodeTree *ntree);
601
602 /* Node Clipboard */
603 void BKE_node_clipboard_init(struct bNodeTree *ntree);
604 void BKE_node_clipboard_clear(void);
605 void BKE_node_clipboard_free(void);
606 bool BKE_node_clipboard_validate(void);
607 void BKE_node_clipboard_add_node(struct bNode *node);
608 void BKE_node_clipboard_add_link(struct bNodeLink *link);
609 const struct ListBase *BKE_node_clipboard_get_nodes(void);
610 const struct ListBase *BKE_node_clipboard_get_links(void);
611 int BKE_node_clipboard_get_type(void);
612
613 /* Node Instance Hash */
614 typedef struct bNodeInstanceHash {
615   GHash *ghash; /* XXX should be made a direct member, GHash allocation needs to support it */
616 } bNodeInstanceHash;
617
618 typedef void (*bNodeInstanceValueFP)(void *value);
619
620 extern const bNodeInstanceKey NODE_INSTANCE_KEY_BASE;
621 extern const bNodeInstanceKey NODE_INSTANCE_KEY_NONE;
622
623 bNodeInstanceKey BKE_node_instance_key(bNodeInstanceKey parent_key,
624                                        struct bNodeTree *ntree,
625                                        struct bNode *node);
626
627 bNodeInstanceHash *BKE_node_instance_hash_new(const char *info);
628 void BKE_node_instance_hash_free(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp);
629 void BKE_node_instance_hash_insert(bNodeInstanceHash *hash, bNodeInstanceKey key, void *value);
630 void *BKE_node_instance_hash_lookup(bNodeInstanceHash *hash, bNodeInstanceKey key);
631 int BKE_node_instance_hash_remove(bNodeInstanceHash *hash,
632                                   bNodeInstanceKey key,
633                                   bNodeInstanceValueFP valfreefp);
634 void BKE_node_instance_hash_clear(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp);
635 void *BKE_node_instance_hash_pop(bNodeInstanceHash *hash, bNodeInstanceKey key);
636 int BKE_node_instance_hash_haskey(bNodeInstanceHash *hash, bNodeInstanceKey key);
637 int BKE_node_instance_hash_size(bNodeInstanceHash *hash);
638
639 void BKE_node_instance_hash_clear_tags(bNodeInstanceHash *hash);
640 void BKE_node_instance_hash_tag(bNodeInstanceHash *hash, void *value);
641 bool BKE_node_instance_hash_tag_key(bNodeInstanceHash *hash, bNodeInstanceKey key);
642 void BKE_node_instance_hash_remove_untagged(bNodeInstanceHash *hash,
643                                             bNodeInstanceValueFP valfreefp);
644
645 typedef GHashIterator bNodeInstanceHashIterator;
646
647 BLI_INLINE bNodeInstanceHashIterator *BKE_node_instance_hash_iterator_new(bNodeInstanceHash *hash)
648 {
649   return BLI_ghashIterator_new(hash->ghash);
650 }
651 BLI_INLINE void BKE_node_instance_hash_iterator_init(bNodeInstanceHashIterator *iter,
652                                                      bNodeInstanceHash *hash)
653 {
654   BLI_ghashIterator_init(iter, hash->ghash);
655 }
656 BLI_INLINE void BKE_node_instance_hash_iterator_free(bNodeInstanceHashIterator *iter)
657 {
658   BLI_ghashIterator_free(iter);
659 }
660 BLI_INLINE bNodeInstanceKey
661 BKE_node_instance_hash_iterator_get_key(bNodeInstanceHashIterator *iter)
662 {
663   return *(bNodeInstanceKey *)BLI_ghashIterator_getKey(iter);
664 }
665 BLI_INLINE void *BKE_node_instance_hash_iterator_get_value(bNodeInstanceHashIterator *iter)
666 {
667   return BLI_ghashIterator_getValue(iter);
668 }
669 BLI_INLINE void BKE_node_instance_hash_iterator_step(bNodeInstanceHashIterator *iter)
670 {
671   BLI_ghashIterator_step(iter);
672 }
673 BLI_INLINE bool BKE_node_instance_hash_iterator_done(bNodeInstanceHashIterator *iter)
674 {
675   return BLI_ghashIterator_done(iter);
676 }
677
678 #define NODE_INSTANCE_HASH_ITER(iter_, hash_) \
679   for (BKE_node_instance_hash_iterator_init(&iter_, hash_); \
680        BKE_node_instance_hash_iterator_done(&iter_) == false; \
681        BKE_node_instance_hash_iterator_step(&iter_))
682
683 /* Node Previews */
684
685 int BKE_node_preview_used(struct bNode *node);
686 bNodePreview *BKE_node_preview_verify(
687     struct bNodeInstanceHash *previews, bNodeInstanceKey key, int xsize, int ysize, bool create);
688 bNodePreview *BKE_node_preview_copy(struct bNodePreview *preview);
689 void BKE_node_preview_free(struct bNodePreview *preview);
690 void BKE_node_preview_init_tree(struct bNodeTree *ntree,
691                                 int xsize,
692                                 int ysize,
693                                 int create_previews);
694 void BKE_node_preview_free_tree(struct bNodeTree *ntree);
695 void BKE_node_preview_remove_unused(struct bNodeTree *ntree);
696 void BKE_node_preview_clear(struct bNodePreview *preview);
697 void BKE_node_preview_clear_tree(struct bNodeTree *ntree);
698
699 void BKE_node_preview_sync_tree(struct bNodeTree *to_ntree, struct bNodeTree *from_ntree);
700 void BKE_node_preview_merge_tree(struct bNodeTree *to_ntree,
701                                  struct bNodeTree *from_ntree,
702                                  bool remove_old);
703
704 void BKE_node_preview_set_pixel(
705     struct bNodePreview *preview, const float col[4], int x, int y, bool do_manage);
706
707 /** \} */
708
709 /* -------------------------------------------------------------------- */
710 /** \name Node Type Access
711  * \{ */
712
713 void nodeLabel(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
714
715 int nodeGroupPoll(struct bNodeTree *nodetree, struct bNodeTree *grouptree);
716
717 /* Init a new node type struct with default values and callbacks */
718 void node_type_base(struct bNodeType *ntype, int type, const char *name, short nclass, short flag);
719 void node_type_base_custom(
720     struct bNodeType *ntype, const char *idname, const char *name, short nclass, short flag);
721 void node_type_socket_templates(struct bNodeType *ntype,
722                                 struct bNodeSocketTemplate *inputs,
723                                 struct bNodeSocketTemplate *outputs);
724 void node_type_size(struct bNodeType *ntype, int width, int minwidth, int maxwidth);
725 void node_type_size_preset(struct bNodeType *ntype, eNodeSizePreset size);
726 void node_type_init(struct bNodeType *ntype,
727                     void (*initfunc)(struct bNodeTree *ntree, struct bNode *node));
728 void node_type_storage(struct bNodeType *ntype,
729                        const char *storagename,
730                        void (*freefunc)(struct bNode *node),
731                        void (*copyfunc)(struct bNodeTree *dest_ntree,
732                                         struct bNode *dest_node,
733                                         struct bNode *src_node));
734 void node_type_label(
735     struct bNodeType *ntype,
736     void (*labelfunc)(struct bNodeTree *ntree, struct bNode *, char *label, int maxlen));
737 void node_type_update(struct bNodeType *ntype,
738                       void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node));
739 void node_type_group_update(struct bNodeType *ntype,
740                             void (*group_update_func)(struct bNodeTree *ntree,
741                                                       struct bNode *node));
742
743 void node_type_exec(struct bNodeType *ntype,
744                     NodeInitExecFunction initexecfunc,
745                     NodeFreeExecFunction freeexecfunc,
746                     NodeExecFunction execfunc);
747 void node_type_gpu(struct bNodeType *ntype, NodeGPUExecFunction gpufunc);
748 void node_type_internal_links(struct bNodeType *ntype,
749                               void (*update_internal_links)(struct bNodeTree *, struct bNode *));
750
751 /** \} */
752
753 /* -------------------------------------------------------------------- */
754 /** \name Node Generic Functions
755  * \{ */
756
757 bool BKE_node_is_connected_to_output(struct bNodeTree *ntree, struct bNode *node);
758
759 /* ************** COMMON NODES *************** */
760
761 #define NODE_UNDEFINED -2 /* node type is not registered */
762 #define NODE_CUSTOM -1    /* for dynamically registered custom types */
763 #define NODE_GROUP 2
764 // #define NODE_FORLOOP 3       /* deprecated */
765 // #define NODE_WHILELOOP   4   /* deprecated */
766 #define NODE_FRAME 5
767 #define NODE_REROUTE 6
768 #define NODE_GROUP_INPUT 7
769 #define NODE_GROUP_OUTPUT 8
770 #define NODE_CUSTOM_GROUP 9
771
772 void BKE_node_tree_unlink_id(ID *id, struct bNodeTree *ntree);
773
774 /** \} */
775
776 /* -------------------------------------------------------------------- */
777 /** \name Node Tree Iterator
778  *
779  * Utility macro for visiting every node tree in the library data,
780  * including local bNodeTree blocks in other IDs.
781  * This avoids the need for callback functions and allows executing code
782  * in a single inner code block.
783  *
784  * Variables:
785  *
786  * - nodetree:
787  *   The actual bNodeTree data block.
788  *   Check nodetree->idname or nodetree->typeinfo to use only specific types.
789  *
790  * - id:
791  *   The owner of the bNodeTree data block.
792  *   Same as nodetree if it's a linkable node tree from the library.
793  *
794  * Examples:
795  *
796  * \code{.c}
797  * FOREACH_NODETREE_BEGIN(bmain, nodetree, id) {
798  *     if (id == nodetree)
799  *         printf("This is a linkable node tree");
800  * } FOREACH_NODETREE_END;
801  *
802  * FOREACH_NODETREE_BEGIN(bmain, nodetree, id) {
803  *     if (nodetree->idname == "ShaderNodeTree")
804  *         printf("This is a shader node tree);
805  *     if (GS(id) == ID_MA)
806  *         printf(" and it's owned by a material");
807  * } FOREACH_NODETREE_END;
808  * \endcode
809  *
810  * \{
811  */
812
813 /* should be an opaque type, only for internal use by BKE_node_tree_iter_*** */
814 struct NodeTreeIterStore {
815   bNodeTree *ngroup;
816   Scene *scene;
817   Material *mat;
818   Tex *tex;
819   Light *light;
820   World *world;
821   FreestyleLineStyle *linestyle;
822 };
823
824 void BKE_node_tree_iter_init(struct NodeTreeIterStore *ntreeiter, struct Main *bmain);
825 bool BKE_node_tree_iter_step(struct NodeTreeIterStore *ntreeiter,
826                              struct bNodeTree **r_nodetree,
827                              struct ID **r_id);
828
829 #define FOREACH_NODETREE_BEGIN(bmain, _nodetree, _id) \
830   { \
831     struct NodeTreeIterStore _nstore; \
832     bNodeTree *_nodetree; \
833     ID *_id; \
834     /* avoid compiler warning about unused variables */ \
835     BKE_node_tree_iter_init(&_nstore, bmain); \
836     while (BKE_node_tree_iter_step(&_nstore, &_nodetree, &_id) == true) { \
837       if (_nodetree) {
838
839 #define FOREACH_NODETREE_END \
840   } \
841   } \
842   } \
843   ((void)0)
844 /** \} */
845
846 /* -------------------------------------------------------------------- */
847 /** \name Node Tree
848  */
849
850 void BKE_nodetree_remove_layer_n(struct bNodeTree *ntree,
851                                  struct Scene *scene,
852                                  const int layer_index);
853
854 /* -------------------------------------------------------------------- */
855 /** \name Shader Nodes
856  * \{ */
857
858 /* note: types are needed to restore callbacks, don't change values */
859 /* range 1 - 100 is reserved for common nodes */
860 /* using toolbox, we add node groups by assuming the values below
861  * don't exceed NODE_GROUP_MENU for now. */
862
863 //#define SH_NODE_OUTPUT        1
864
865 //#define SH_NODE_MATERIAL  100
866 #define SH_NODE_RGB 101
867 #define SH_NODE_VALUE 102
868 #define SH_NODE_MIX_RGB 103
869 #define SH_NODE_VALTORGB 104
870 #define SH_NODE_RGBTOBW 105
871 #define SH_NODE_SHADERTORGB 106
872 //#define SH_NODE_TEXTURE       106
873 #define SH_NODE_NORMAL 107
874 //#define SH_NODE_GEOMETRY  108
875 #define SH_NODE_MAPPING 109
876 #define SH_NODE_CURVE_VEC 110
877 #define SH_NODE_CURVE_RGB 111
878 #define SH_NODE_CAMERA 114
879 #define SH_NODE_MATH 115
880 #define SH_NODE_VECT_MATH 116
881 #define SH_NODE_SQUEEZE 117
882 //#define SH_NODE_MATERIAL_EXT  118
883 #define SH_NODE_INVERT 119
884 #define SH_NODE_SEPRGB 120
885 #define SH_NODE_COMBRGB 121
886 #define SH_NODE_HUE_SAT 122
887 #define NODE_DYNAMIC 123
888
889 #define SH_NODE_OUTPUT_MATERIAL 124
890 #define SH_NODE_OUTPUT_WORLD 125
891 #define SH_NODE_OUTPUT_LIGHT 126
892 #define SH_NODE_FRESNEL 127
893 #define SH_NODE_MIX_SHADER 128
894 #define SH_NODE_ATTRIBUTE 129
895 #define SH_NODE_BACKGROUND 130
896 #define SH_NODE_BSDF_ANISOTROPIC 131
897 #define SH_NODE_BSDF_DIFFUSE 132
898 #define SH_NODE_BSDF_GLOSSY 133
899 #define SH_NODE_BSDF_GLASS 134
900 #define SH_NODE_BSDF_TRANSLUCENT 137
901 #define SH_NODE_BSDF_TRANSPARENT 138
902 #define SH_NODE_BSDF_VELVET 139
903 #define SH_NODE_EMISSION 140
904 #define SH_NODE_NEW_GEOMETRY 141
905 #define SH_NODE_LIGHT_PATH 142
906 #define SH_NODE_TEX_IMAGE 143
907 #define SH_NODE_TEX_SKY 145
908 #define SH_NODE_TEX_GRADIENT 146
909 #define SH_NODE_TEX_VORONOI 147
910 #define SH_NODE_TEX_MAGIC 148
911 #define SH_NODE_TEX_WAVE 149
912 #define SH_NODE_TEX_NOISE 150
913 #define SH_NODE_TEX_MUSGRAVE 152
914 #define SH_NODE_TEX_COORD 155
915 #define SH_NODE_ADD_SHADER 156
916 #define SH_NODE_TEX_ENVIRONMENT 157
917 #define SH_NODE_OUTPUT_TEXTURE 158
918 #define SH_NODE_HOLDOUT 159
919 #define SH_NODE_LAYER_WEIGHT 160
920 #define SH_NODE_VOLUME_ABSORPTION 161
921 #define SH_NODE_VOLUME_SCATTER 162
922 #define SH_NODE_GAMMA 163
923 #define SH_NODE_TEX_CHECKER 164
924 #define SH_NODE_BRIGHTCONTRAST 165
925 #define SH_NODE_LIGHT_FALLOFF 166
926 #define SH_NODE_OBJECT_INFO 167
927 #define SH_NODE_PARTICLE_INFO 168
928 #define SH_NODE_TEX_BRICK 169
929 #define SH_NODE_BUMP 170
930 #define SH_NODE_SCRIPT 171
931 #define SH_NODE_AMBIENT_OCCLUSION 172
932 #define SH_NODE_BSDF_REFRACTION 173
933 #define SH_NODE_TANGENT 174
934 #define SH_NODE_NORMAL_MAP 175
935 #define SH_NODE_HAIR_INFO 176
936 #define SH_NODE_SUBSURFACE_SCATTERING 177
937 #define SH_NODE_WIREFRAME 178
938 #define SH_NODE_BSDF_TOON 179
939 #define SH_NODE_WAVELENGTH 180
940 #define SH_NODE_BLACKBODY 181
941 #define SH_NODE_VECT_TRANSFORM 182
942 #define SH_NODE_SEPHSV 183
943 #define SH_NODE_COMBHSV 184
944 #define SH_NODE_BSDF_HAIR 185
945 #define SH_NODE_LAMP 186
946 #define SH_NODE_UVMAP 187
947 #define SH_NODE_SEPXYZ 188
948 #define SH_NODE_COMBXYZ 189
949 #define SH_NODE_OUTPUT_LINESTYLE 190
950 #define SH_NODE_UVALONGSTROKE 191
951 #define SH_NODE_TEX_POINTDENSITY 192
952 #define SH_NODE_BSDF_PRINCIPLED 193
953 #define SH_NODE_TEX_IES 194
954 #define SH_NODE_EEVEE_SPECULAR 195
955 #define SH_NODE_BEVEL 197
956 #define SH_NODE_DISPLACEMENT 198
957 #define SH_NODE_VECTOR_DISPLACEMENT 199
958 #define SH_NODE_VOLUME_PRINCIPLED 200
959 /* 201..700 occupied by other node types, continue from 701 */
960 #define SH_NODE_BSDF_HAIR_PRINCIPLED 701
961
962 /* custom defines options for Material node */
963 #define SH_NODE_MAT_DIFF 1
964 #define SH_NODE_MAT_SPEC 2
965 #define SH_NODE_MAT_NEG 4
966
967 /* API */
968
969 struct bNodeTreeExec *ntreeShaderBeginExecTree(struct bNodeTree *ntree);
970 void ntreeShaderEndExecTree(struct bNodeTreeExec *exec);
971 bool ntreeShaderExecTree(struct bNodeTree *ntree, int thread);
972 struct bNode *ntreeShaderOutputNode(struct bNodeTree *ntree, int target);
973
974 void ntreeGPUMaterialNodes(struct bNodeTree *localtree,
975                            struct GPUMaterial *mat,
976                            bool *has_surface_output,
977                            bool *has_volume_output);
978
979 /** \} */
980
981 /* -------------------------------------------------------------------- */
982 /** \name Composite Nodes
983  * \{ */
984
985 /* output socket defines */
986 #define RRES_OUT_IMAGE 0
987 #define RRES_OUT_ALPHA 1
988 #define RRES_OUT_Z 2
989 #define RRES_OUT_NORMAL 3
990 #define RRES_OUT_UV 4
991 #define RRES_OUT_VEC 5
992 #define RRES_OUT_RGBA 6
993 #define RRES_OUT_DIFF 7
994 #define RRES_OUT_SPEC 8
995 #define RRES_OUT_SHADOW 9
996 #define RRES_OUT_AO 10
997 #define RRES_OUT_REFLECT 11
998 #define RRES_OUT_REFRACT 12
999 #define RRES_OUT_INDIRECT 13
1000 #define RRES_OUT_INDEXOB 14
1001 #define RRES_OUT_INDEXMA 15
1002 #define RRES_OUT_MIST 16
1003 #define RRES_OUT_EMIT 17
1004 #define RRES_OUT_ENV 18
1005 #define RRES_OUT_DIFF_DIRECT 19
1006 #define RRES_OUT_DIFF_INDIRECT 20
1007 #define RRES_OUT_DIFF_COLOR 21
1008 #define RRES_OUT_GLOSSY_DIRECT 22
1009 #define RRES_OUT_GLOSSY_INDIRECT 23
1010 #define RRES_OUT_GLOSSY_COLOR 24
1011 #define RRES_OUT_TRANSM_DIRECT 25
1012 #define RRES_OUT_TRANSM_INDIRECT 26
1013 #define RRES_OUT_TRANSM_COLOR 27
1014 #define RRES_OUT_SUBSURFACE_DIRECT 28
1015 #define RRES_OUT_SUBSURFACE_INDIRECT 29
1016 #define RRES_OUT_SUBSURFACE_COLOR 30
1017 #define RRES_OUT_DEBUG 31
1018
1019 /* note: types are needed to restore callbacks, don't change values */
1020 #define CMP_NODE_VIEWER 201
1021 #define CMP_NODE_RGB 202
1022 #define CMP_NODE_VALUE 203
1023 #define CMP_NODE_MIX_RGB 204
1024 #define CMP_NODE_VALTORGB 205
1025 #define CMP_NODE_RGBTOBW 206
1026 #define CMP_NODE_NORMAL 207
1027 #define CMP_NODE_CURVE_VEC 208
1028 #define CMP_NODE_CURVE_RGB 209
1029 #define CMP_NODE_ALPHAOVER 210
1030 #define CMP_NODE_BLUR 211
1031 #define CMP_NODE_FILTER 212
1032 #define CMP_NODE_MAP_VALUE 213
1033 #define CMP_NODE_TIME 214
1034 #define CMP_NODE_VECBLUR 215
1035 #define CMP_NODE_SEPRGBA 216
1036 #define CMP_NODE_SEPHSVA 217
1037 #define CMP_NODE_SETALPHA 218
1038 #define CMP_NODE_HUE_SAT 219
1039 #define CMP_NODE_IMAGE 220
1040 #define CMP_NODE_R_LAYERS 221
1041 #define CMP_NODE_COMPOSITE 222
1042 #define CMP_NODE_OUTPUT_FILE 223
1043 #define CMP_NODE_TEXTURE 224
1044 #define CMP_NODE_TRANSLATE 225
1045 #define CMP_NODE_ZCOMBINE 226
1046 #define CMP_NODE_COMBRGBA 227
1047 #define CMP_NODE_DILATEERODE 228
1048 #define CMP_NODE_ROTATE 229
1049 #define CMP_NODE_SCALE 230
1050 #define CMP_NODE_SEPYCCA 231
1051 #define CMP_NODE_COMBYCCA 232
1052 #define CMP_NODE_SEPYUVA 233
1053 #define CMP_NODE_COMBYUVA 234
1054 #define CMP_NODE_DIFF_MATTE 235
1055 #define CMP_NODE_COLOR_SPILL 236
1056 #define CMP_NODE_CHROMA_MATTE 237
1057 #define CMP_NODE_CHANNEL_MATTE 238
1058 #define CMP_NODE_FLIP 239
1059 #define CMP_NODE_SPLITVIEWER 240
1060 // #define CMP_NODE_INDEX_MASK  241
1061 #define CMP_NODE_MAP_UV 242
1062 #define CMP_NODE_ID_MASK 243
1063 #define CMP_NODE_DEFOCUS 244
1064 #define CMP_NODE_DISPLACE 245
1065 #define CMP_NODE_COMBHSVA 246
1066 #define CMP_NODE_MATH 247
1067 #define CMP_NODE_LUMA_MATTE 248
1068 #define CMP_NODE_BRIGHTCONTRAST 249
1069 #define CMP_NODE_GAMMA 250
1070 #define CMP_NODE_INVERT 251
1071 #define CMP_NODE_NORMALIZE 252
1072 #define CMP_NODE_CROP 253
1073 #define CMP_NODE_DBLUR 254
1074 #define CMP_NODE_BILATERALBLUR 255
1075 #define CMP_NODE_PREMULKEY 256
1076 #define CMP_NODE_DIST_MATTE 257
1077 #define CMP_NODE_VIEW_LEVELS 258
1078 #define CMP_NODE_COLOR_MATTE 259
1079 #define CMP_NODE_COLORBALANCE 260
1080 #define CMP_NODE_HUECORRECT 261
1081 #define CMP_NODE_MOVIECLIP 262
1082 #define CMP_NODE_STABILIZE2D 263
1083 #define CMP_NODE_TRANSFORM 264
1084 #define CMP_NODE_MOVIEDISTORTION 265
1085 #define CMP_NODE_DOUBLEEDGEMASK 266
1086 #define CMP_NODE_OUTPUT_MULTI_FILE__DEPRECATED \
1087   267 /* DEPRECATED multi file node has been merged into regular CMP_NODE_OUTPUT_FILE */
1088 #define CMP_NODE_MASK 268
1089 #define CMP_NODE_KEYINGSCREEN 269
1090 #define CMP_NODE_KEYING 270
1091 #define CMP_NODE_TRACKPOS 271
1092 #define CMP_NODE_INPAINT 272
1093 #define CMP_NODE_DESPECKLE 273
1094
1095 #define CMP_NODE_GLARE 301
1096 #define CMP_NODE_TONEMAP 302
1097 #define CMP_NODE_LENSDIST 303
1098 #define CMP_NODE_SUNBEAMS 304
1099
1100 #define CMP_NODE_COLORCORRECTION 312
1101 #define CMP_NODE_MASK_BOX 313
1102 #define CMP_NODE_MASK_ELLIPSE 314
1103 #define CMP_NODE_BOKEHIMAGE 315
1104 #define CMP_NODE_BOKEHBLUR 316
1105 #define CMP_NODE_SWITCH 317
1106 #define CMP_NODE_PIXELATE 318
1107
1108 #define CMP_NODE_MAP_RANGE 319
1109 #define CMP_NODE_PLANETRACKDEFORM 320
1110 #define CMP_NODE_CORNERPIN 321
1111 #define CMP_NODE_SWITCH_VIEW 322
1112 #define CMP_NODE_CRYPTOMATTE 323
1113
1114 /* channel toggles */
1115 #define CMP_CHAN_RGB 1
1116 #define CMP_CHAN_A 2
1117
1118 /* filter types */
1119 #define CMP_FILT_SOFT 0
1120 #define CMP_FILT_SHARP 1
1121 #define CMP_FILT_LAPLACE 2
1122 #define CMP_FILT_SOBEL 3
1123 #define CMP_FILT_PREWITT 4
1124 #define CMP_FILT_KIRSCH 5
1125 #define CMP_FILT_SHADOW 6
1126
1127 /* scale node type, in custom1 */
1128 #define CMP_SCALE_RELATIVE 0
1129 #define CMP_SCALE_ABSOLUTE 1
1130 #define CMP_SCALE_SCENEPERCENT 2
1131 #define CMP_SCALE_RENDERPERCENT 3
1132 /* custom2 */
1133 #define CMP_SCALE_RENDERSIZE_FRAME_ASPECT (1 << 0)
1134 #define CMP_SCALE_RENDERSIZE_FRAME_CROP (1 << 1)
1135
1136 /* track position node, in custom1 */
1137 #define CMP_TRACKPOS_ABSOLUTE 0
1138 #define CMP_TRACKPOS_RELATIVE_START 1
1139 #define CMP_TRACKPOS_RELATIVE_FRAME 2
1140 #define CMP_TRACKPOS_ABSOLUTE_FRAME 3
1141
1142 /* API */
1143 void ntreeCompositExecTree(struct Scene *scene,
1144                            struct bNodeTree *ntree,
1145                            struct RenderData *rd,
1146                            int rendering,
1147                            int do_previews,
1148                            const struct ColorManagedViewSettings *view_settings,
1149                            const struct ColorManagedDisplaySettings *display_settings,
1150                            const char *view_name);
1151 void ntreeCompositTagRender(struct Scene *sce);
1152 void ntreeCompositUpdateRLayers(struct bNodeTree *ntree);
1153 void ntreeCompositRegisterPass(struct bNodeTree *ntree,
1154                                struct Scene *scene,
1155                                struct ViewLayer *view_layer,
1156                                const char *name,
1157                                int type);
1158 void ntreeCompositClearTags(struct bNodeTree *ntree);
1159
1160 struct bNodeSocket *ntreeCompositOutputFileAddSocket(struct bNodeTree *ntree,
1161                                                      struct bNode *node,
1162                                                      const char *name,
1163                                                      struct ImageFormatData *im_format);
1164 int ntreeCompositOutputFileRemoveActiveSocket(struct bNodeTree *ntree, struct bNode *node);
1165 void ntreeCompositOutputFileSetPath(struct bNode *node,
1166                                     struct bNodeSocket *sock,
1167                                     const char *name);
1168 void ntreeCompositOutputFileSetLayer(struct bNode *node,
1169                                      struct bNodeSocket *sock,
1170                                      const char *name);
1171 /* needed in do_versions */
1172 void ntreeCompositOutputFileUniquePath(struct ListBase *list,
1173                                        struct bNodeSocket *sock,
1174                                        const char defname[],
1175                                        char delim);
1176 void ntreeCompositOutputFileUniqueLayer(struct ListBase *list,
1177                                         struct bNodeSocket *sock,
1178                                         const char defname[],
1179                                         char delim);
1180
1181 void ntreeCompositColorBalanceSyncFromLGG(bNodeTree *ntree, bNode *node);
1182 void ntreeCompositColorBalanceSyncFromCDL(bNodeTree *ntree, bNode *node);
1183
1184 void ntreeCompositCryptomatteSyncFromAdd(bNodeTree *ntree, bNode *node);
1185 void ntreeCompositCryptomatteSyncFromRemove(bNodeTree *ntree, bNode *node);
1186 struct bNodeSocket *ntreeCompositCryptomatteAddSocket(struct bNodeTree *ntree, struct bNode *node);
1187 int ntreeCompositCryptomatteRemoveSocket(struct bNodeTree *ntree, struct bNode *node);
1188
1189 /** \} */
1190
1191 /* -------------------------------------------------------------------- */
1192 /** \name Texture Nodes
1193  * \{ */
1194
1195 struct TexResult;
1196
1197 #define TEX_NODE_OUTPUT 401
1198 #define TEX_NODE_CHECKER 402
1199 #define TEX_NODE_TEXTURE 403
1200 #define TEX_NODE_BRICKS 404
1201 #define TEX_NODE_MATH 405
1202 #define TEX_NODE_MIX_RGB 406
1203 #define TEX_NODE_RGBTOBW 407
1204 #define TEX_NODE_VALTORGB 408
1205 #define TEX_NODE_IMAGE 409
1206 #define TEX_NODE_CURVE_RGB 410
1207 #define TEX_NODE_INVERT 411
1208 #define TEX_NODE_HUE_SAT 412
1209 #define TEX_NODE_CURVE_TIME 413
1210 #define TEX_NODE_ROTATE 414
1211 #define TEX_NODE_VIEWER 415
1212 #define TEX_NODE_TRANSLATE 416
1213 #define TEX_NODE_COORD 417
1214 #define TEX_NODE_DISTANCE 418
1215 #define TEX_NODE_COMPOSE 419
1216 #define TEX_NODE_DECOMPOSE 420
1217 #define TEX_NODE_VALTONOR 421
1218 #define TEX_NODE_SCALE 422
1219 #define TEX_NODE_AT 423
1220
1221 /* 501-599 reserved. Use like this: TEX_NODE_PROC + TEX_CLOUDS, etc */
1222 #define TEX_NODE_PROC 500
1223 #define TEX_NODE_PROC_MAX 600
1224
1225 /* API */
1226 void ntreeTexCheckCyclics(struct bNodeTree *ntree);
1227
1228 struct bNodeTreeExec *ntreeTexBeginExecTree(struct bNodeTree *ntree);
1229 void ntreeTexEndExecTree(struct bNodeTreeExec *exec);
1230 int ntreeTexExecTree(struct bNodeTree *ntree,
1231                      struct TexResult *target,
1232                      float coord[3],
1233                      float dxt[3],
1234                      float dyt[3],
1235                      int osatex,
1236                      const short thread,
1237                      struct Tex *tex,
1238                      short which_output,
1239                      int cfra,
1240                      int preview,
1241                      struct MTex *mtex);
1242 /** \} */
1243
1244 void init_nodesystem(void);
1245 void free_nodesystem(void);
1246
1247 /* -------------------------------------------------------------------- */
1248 /* evaluation support, */
1249
1250 struct Depsgraph;
1251
1252 void BKE_nodetree_shading_params_eval(struct Depsgraph *depsgraph,
1253                                       struct bNodeTree *ntree_dst,
1254                                       const struct bNodeTree *ntree_src);
1255
1256 extern struct bNodeType NodeTypeUndefined;
1257 extern struct bNodeSocketType NodeSocketTypeUndefined;
1258
1259 #endif /* __BKE_NODE_H__ */