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 "BLI_utildefines.h"
  36 #include "BLI_ghash.h"
  37
  38 #include "DNA_listBase.h"
  39
  40 /* for FOREACH_NODETREE */
  41 #include "DNA_lamp_types.h"
  42 #include "DNA_material_types.h"
  43 #include "DNA_node_types.h"
  44 #include "DNA_scene_types.h"
  45 #include "DNA_texture_types.h"
  46 #include "DNA_world_types.h"
  47
  48 #include "RNA_types.h"
  49
  50 /* not very important, but the stack solver likes to know a maximum */
  51 #define MAX_SOCKET      64
  52
  53 struct bContext;
  54 struct bNode;
  55 struct bNodeLink;
  56 struct bNodeSocket;
  57 struct bNodeStack;
  58 struct bNodeTree;
  59 struct bNodeTreeType;
  60 struct bNodeTreeExec;
  61 struct bNodeExecContext;
  62 struct bNodeExecData;
  63 struct GPUMaterial;
  64 struct GPUNode;
  65 struct GPUNodeStack;
  66 struct ID;
  67 struct ImBuf;
  68 struct ImageFormatData;
  69 struct ListBase;
  70 struct Main;
  71 struct uiBlock;
  72 struct uiLayout;
  73 struct MTex;
  74 struct PointerRNA;
  75 struct rctf;
  76 struct RenderData;
  77 struct Scene;
  78 struct Tex;
  79 struct SpaceNode;
  80 struct ARegion;
  81 struct Object;
  82 struct ColorManagedViewSettings;
  83 struct ColorManagedDisplaySettings;
  84 struct bNodeInstanceHash;
  85
  86
  87 /* ************** NODE TYPE DEFINITIONS ***** */
  88
  89 /** Compact definition of a node socket.
  90  * Can be used to quickly define a list of static sockets for a node,
  91  * which are added to each new node of that type.
  92  *
  93  * \deprecated This struct is used by C nodes to define templates as simple
  94  * static struct lists. These are converted to the new template collections
  95  * in RNA types automatically.
  96  */
  97 typedef struct bNodeSocketTemplate {
  98         int type, limit;
  99         char name[64];  /* MAX_NAME */
 100         float val1, val2, val3, val4;   /* default alloc value for inputs */
 101         float min, max;
 102         int subtype;  /* would use PropertySubType but this is a bad level include to use RNA */
 103         int flag;
 104
 105         /* after this line is used internal only */
 106         struct bNodeSocket *sock;               /* used to hold verified socket */
 107         char identifier[64];                    /* generated from name */
 108 } bNodeSocketTemplate;
 109
 110 /** Defines a socket type.
 111  * Defines the appearance and behavior of a socket in the UI.
 112  */
 113 typedef struct bNodeSocketType {
 114         char idname[64];                                /* identifier name */
 115
 116         void (*draw)(struct bContext *C, struct uiLayout *layout, struct PointerRNA *ptr, struct PointerRNA *node_ptr, const char *text);
 117         void (*draw_color)(struct bContext *C, struct PointerRNA *ptr, struct PointerRNA *node_ptr, float *r_color);
 118
 119         void (*interface_draw)(struct bContext *C, struct uiLayout *layout, struct PointerRNA *ptr);
 120         void (*interface_draw_color)(struct bContext *C, struct PointerRNA *ptr, float *r_color);
 121         void (*interface_register_properties)(struct bNodeTree *ntree, struct bNodeSocket *stemp, struct StructRNA *data_srna);
 122         void (*interface_init_socket)(struct bNodeTree *ntree, struct bNodeSocket *stemp, struct bNode *node, struct bNodeSocket *sock, const char *data_path);
 123         void (*interface_verify_socket)(struct bNodeTree *ntree, struct bNodeSocket *stemp, struct bNode *node, struct bNodeSocket *sock, const char *data_path);
 124         void (*interface_from_socket)(struct bNodeTree *ntree, struct bNodeSocket *stemp, struct bNode *node, struct bNodeSocket *sock);
 125
 126         /* RNA integration */
 127         ExtensionRNA ext_socket;
 128         ExtensionRNA ext_interface;
 129
 130         /* for standard socket types in C */
 131         int type, subtype;
 132 } bNodeSocketType;
 133
 134 typedef void (*NodeSocketDrawFunction)(struct bContext *C, struct uiLayout *layout, struct PointerRNA *ptr, struct PointerRNA *node_ptr);
 135
 136 typedef void *(*NodeInitExecFunction)(struct bNodeExecContext *context, struct bNode *node, bNodeInstanceKey key);
 137 typedef void (*NodeFreeExecFunction)(struct bNode *node, void *nodedata);
 138 typedef void (*NodeExecFunction)(void *data, int thread, struct bNode *, struct bNodeExecData *execdata, struct bNodeStack **in, struct bNodeStack **out);
 139 typedef int (*NodeGPUExecFunction)(struct GPUMaterial *mat, struct bNode *node, struct bNodeExecData *execdata, struct GPUNodeStack *in, struct GPUNodeStack *out);
 140
 141 /** Defines a node type.
 142  * Initial attributes and constants for a node as well as callback functions
 143  * implementing the node behavior.
 144  */
 145 typedef struct bNodeType {
 146         void *next, *prev;
 147         short needs_free;               /* set for allocated types that need to be freed */
 148
 149         char idname[64];                                /* identifier name */
 150         int type;
 151
 152         char ui_name[64];       /* MAX_NAME */
 153         char ui_description[256];
 154         int ui_icon;
 155
 156         float width, minwidth, maxwidth;
 157         float height, minheight, maxheight;
 158         short nclass, flag, compatibility;
 159
 160         /* templates for static sockets */
 161         bNodeSocketTemplate *inputs, *outputs;
 162
 163         char storagename[64];                   /* struct name for DNA */
 164
 165         /* Main draw function for the node */
 166         void (*draw_nodetype)(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode,
 167                          struct bNodeTree *ntree, struct bNode *node, bNodeInstanceKey key);
 168         /* Updates the node geometry attributes according to internal state before actual drawing */
 169         void (*draw_nodetype_prepare)(const struct bContext *C, struct bNodeTree *ntree, struct bNode *node);
 170
 171         /* Draw the option buttons on the node */
 172         void (*draw_buttons)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
 173         /* Additional parameters in the side panel */
 174         void (*draw_buttons_ex)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
 175
 176         /* Additional drawing on backdrop */
 177         void (*draw_backdrop)(struct SpaceNode *snode, struct ImBuf *backdrop, struct bNode *node, int x, int y);
 178
 179         /* Draw a node socket. Default draws the input value button. */
 180         /* XXX deprecated, only used for the OutputFile node,
 181          * should be removed at some point.
 182          */
 183         NodeSocketDrawFunction draw_input;
 184         NodeSocketDrawFunction draw_output;
 185
 186         /// Optional custom label function for the node header.
 187         const char *(*labelfunc)(struct bNode *);
 188         /// Optional custom resize handle polling.
 189         int (*resize_area_func)(struct bNode *node, int x, int y);
 190         /// Optional selection area polling.
 191         int (*select_area_func)(struct bNode *node, int x, int y);
 192         /// Optional tweak area polling (for grabbing).
 193         int (*tweak_area_func)(struct bNode *node, int x, int y);
 194
 195         /// Called when the node is updated in the editor.
 196         void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node);
 197         /// Check and update if internal ID data has changed.
 198         void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id);
 199
 200         /// Initialize a new node instance of this type after creation.
 201         void (*initfunc)(struct bNodeTree *ntree, struct bNode *node);
 202         /// Free the node instance.
 203         void (*freefunc)(struct bNode *node);
 204         /// Make a copy of the node instance.
 205         void (*copyfunc)(struct bNodeTree *dest_ntree, struct bNode *dest_node, struct bNode *src_node);
 206
 207         /* Registerable API callback versions, called in addition to C callbacks */
 208         void (*initfunc_api)(const struct bContext *C, struct PointerRNA *ptr);
 209         void (*freefunc_api)(struct PointerRNA *ptr);
 210         void (*copyfunc_api)(struct PointerRNA *ptr, struct bNode *src_node);
 211
 212         /* can this node type be added to a node tree */
 213         int (*poll)(struct bNodeType *ntype, struct bNodeTree *nodetree);
 214         /* can this node be added to a node tree */
 215         int (*poll_instance)(struct bNode *node, struct bNodeTree *nodetree);
 216
 217         /* Update the internal links list, for muting and disconnect operators. */
 218         void (*update_internal_links)(struct bNodeTree *, struct bNode *node);
 219
 220         /* **** execution callbacks **** */
 221         NodeInitExecFunction initexecfunc;
 222         NodeFreeExecFunction freeexecfunc;
 223         NodeExecFunction execfunc;
 224         /* gpu */
 225         NodeGPUExecFunction gpufunc;
 226
 227         /* RNA integration */
 228         ExtensionRNA ext;
 229 } bNodeType;
 230
 231 /* node->exec, now in use for composites (#define for break is same as ready yes) */
 232 #define NODE_PROCESSING 1
 233 #define NODE_READY              2
 234 #define NODE_BREAK              2
 235 #define NODE_FINISHED   4
 236 #define NODE_FREEBUFS   8
 237 #define NODE_SKIPPED    16
 238
 239 /* sim_exec return value */
 240 #define NODE_EXEC_FINISHED      0
 241 #define NODE_EXEC_SUSPEND       1
 242
 243 /* nodetype->nclass, for add-menu and themes */
 244 #define NODE_CLASS_INPUT                        0
 245 #define NODE_CLASS_OUTPUT                       1
 246 #define NODE_CLASS_OP_COLOR                     3
 247 #define NODE_CLASS_OP_VECTOR            4
 248 #define NODE_CLASS_OP_FILTER            5
 249 #define NODE_CLASS_GROUP                        6
 250 #define NODE_CLASS_FILE                         7
 251 #define NODE_CLASS_CONVERTOR            8
 252 #define NODE_CLASS_MATTE                        9
 253 #define NODE_CLASS_DISTORT                      10
 254 #define NODE_CLASS_OP_DYNAMIC           11 /* deprecated */
 255 #define NODE_CLASS_PATTERN                      12
 256 #define NODE_CLASS_TEXTURE                      13
 257 #define NODE_CLASS_EXECUTION            14
 258 #define NODE_CLASS_GETDATA                      15
 259 #define NODE_CLASS_SETDATA                      16
 260 #define NODE_CLASS_MATH                         17
 261 #define NODE_CLASS_MATH_VECTOR          18
 262 #define NODE_CLASS_MATH_ROTATION        19
 263 #define NODE_CLASS_PARTICLES            25
 264 #define NODE_CLASS_TRANSFORM            30
 265 #define NODE_CLASS_COMBINE                      31
 266 #define NODE_CLASS_SCRIPT                       32
 267 #define NODE_CLASS_INTERFACE            33
 268 #define NODE_CLASS_SHADER                       40
 269 #define NODE_CLASS_LAYOUT                       100
 270
 271 /* nodetype->compatibility */
 272 #define NODE_OLD_SHADING        1
 273 #define NODE_NEW_SHADING        2
 274
 275 /* node resize directions */
 276 #define NODE_RESIZE_TOP         1
 277 #define NODE_RESIZE_BOTTOM      2
 278 #define NODE_RESIZE_RIGHT       4
 279 #define NODE_RESIZE_LEFT        8
 280
 281 typedef enum eNodeSizePreset {
 282         NODE_SIZE_DEFAULT,
 283         NODE_SIZE_SMALL,
 284         NODE_SIZE_MIDDLE,
 285         NODE_SIZE_LARGE
 286 } eNodeSizePreset;
 287
 288 struct bNodeTreeExec;
 289
 290 typedef void (*bNodeClassCallback)(void *calldata, int nclass, const char *name);
 291 typedef struct bNodeTreeType {
 292         int type;                                               /* type identifier */
 293         char idname[64];                                /* identifier name */
 294
 295         char ui_name[64];
 296         char ui_description[256];
 297         int ui_icon;
 298
 299         /* callbacks */
 300         void (*free_cache)(struct bNodeTree *ntree);
 301         void (*free_node_cache)(struct bNodeTree *ntree, struct bNode *node);
 302         void (*foreach_nodeclass)(struct Scene *scene, void *calldata, bNodeClassCallback func);        /* iteration over all node classes */
 303         /* Check visibility in the node editor */
 304         int (*poll)(const struct bContext *C, struct bNodeTreeType *ntreetype);
 305         /* Select a node tree from the context */
 306         void (*get_from_context)(const struct bContext *C, struct bNodeTreeType *ntreetype,
 307                                  struct bNodeTree **r_ntree, struct ID **r_id, struct ID **r_from);
 308
 309         /* calls allowing threaded composite */
 310         void (*localize)(struct bNodeTree *localtree, struct bNodeTree *ntree);
 311         void (*local_sync)(struct bNodeTree *localtree, struct bNodeTree *ntree);
 312         void (*local_merge)(struct bNodeTree *localtree, struct bNodeTree *ntree);
 313
 314         /* Tree update. Overrides nodetype->updatetreefunc! */
 315         void (*update)(struct bNodeTree *ntree);
 316
 317         int (*validate_link)(struct bNodeTree *ntree, struct bNodeLink *link);
 318
 319         /* RNA integration */
 320         ExtensionRNA ext;
 321 } bNodeTreeType;
 322
 323
 324 /* ************** GENERIC API, TREES *************** */
 325
 326 struct bNodeTreeType *ntreeTypeFind(const char *idname);
 327 void ntreeTypeAdd(struct bNodeTreeType *nt);
 328 void ntreeTypeFreeLink(struct bNodeTreeType *nt);
 329 bool ntreeIsRegistered(struct bNodeTree *ntree);
 330 struct GHashIterator *ntreeTypeGetIterator(void);
 331
 332 /* helper macros for iterating over tree types */
 333 #define NODE_TREE_TYPES_BEGIN(ntype) \
 334 { \
 335         GHashIterator *__node_tree_type_iter__ = ntreeTypeGetIterator(); \
 336         for (; !BLI_ghashIterator_done(__node_tree_type_iter__); BLI_ghashIterator_step(__node_tree_type_iter__)) { \
 337                 bNodeTreeType *ntype = BLI_ghashIterator_getValue(__node_tree_type_iter__);
 338
 339 #define NODE_TREE_TYPES_END \
 340         } \
 341         BLI_ghashIterator_free(__node_tree_type_iter__); \
 342 } (void)0
 343
 344 void ntreeSetTypes(const struct bContext *C, struct bNodeTree *ntree);
 345
 346 struct bNodeTree *ntreeAddTree(struct Main *bmain, const char *name, const char *idname);
 347
 348 /* copy/free funcs, need to manage ID users */
 349 void              ntreeFreeTree_ex(struct bNodeTree *ntree, const short do_id_user);
 350 void              ntreeFreeTree(struct bNodeTree *ntree);
 351 struct bNodeTree *ntreeCopyTree_ex(struct bNodeTree *ntree, const short do_id_user);
 352 struct bNodeTree *ntreeCopyTree(struct bNodeTree *ntree);
 353 void              ntreeSwitchID_ex(struct bNodeTree *ntree, struct ID *sce_from, struct ID *sce_to, const short do_id_user);
 354 void              ntreeSwitchID(struct bNodeTree *ntree, struct ID *sce_from, struct ID *sce_to);
 355 /* node->id user count */
 356 void              ntreeUserIncrefID(struct bNodeTree *ntree);
 357 void              ntreeUserDecrefID(struct bNodeTree *ntree);
 358
 359
 360 struct bNodeTree *ntreeFromID(struct ID *id);
 361
 362 void              ntreeMakeLocal(struct bNodeTree *ntree);
 363 int               ntreeHasType(struct bNodeTree *ntree, int type);
 364 void              ntreeUpdateTree(struct Main *main, struct bNodeTree *ntree);
 365 /* XXX Currently each tree update call does call to ntreeVerifyNodes too.
 366  * Some day this should be replaced by a decent depsgraph automatism!
 367  */
 368 void              ntreeVerifyNodes(struct Main *main, struct ID *id);
 369
 370 void              ntreeGetDependencyList(struct bNodeTree *ntree, struct bNode ***deplist, int *totnodes);
 371
 372 /* XXX old trees handle output flags automatically based on special output node types and last active selection.
 373  * new tree types have a per-output socket flag to indicate the final output to use explicitly.
 374  */
 375 void            ntreeSetOutput(struct bNodeTree *ntree);
 376
 377 void            ntreeFreeCache(struct bNodeTree *ntree);
 378
 379 int             ntreeNodeExists(struct bNodeTree *ntree, struct bNode *testnode);
 380 int             ntreeOutputExists(struct bNode *node, struct bNodeSocket *testsock);
 381 struct bNodeTree *ntreeLocalize(struct bNodeTree *ntree);
 382 void            ntreeLocalSync(struct bNodeTree *localtree, struct bNodeTree *ntree);
 383 void            ntreeLocalMerge(struct bNodeTree *localtree, struct bNodeTree *ntree);
 384
 385 /* ************** NODE TREE INTERFACE *************** */
 386
 387 struct bNodeSocket *ntreeFindSocketInterface(struct bNodeTree *ntree, int in_out, const char *identifier);
 388 struct bNodeSocket *ntreeAddSocketInterface(struct bNodeTree *ntree, int in_out, const char *idname, const char *name);
 389 struct bNodeSocket *ntreeInsertSocketInterface(struct bNodeTree *ntree, int in_out, const char *idname,
 390                                                struct bNodeSocket *next_sock, const char *name);
 391 struct bNodeSocket *ntreeAddSocketInterfaceFromSocket(struct bNodeTree *ntree, struct bNode *from_node, struct bNodeSocket *from_sock);
 392 struct bNodeSocket *ntreeInsertSocketInterfaceFromSocket(struct bNodeTree *ntree, struct bNodeSocket *next_sock,
 393                                                          struct bNode *from_node, struct bNodeSocket *from_sock);
 394 void            ntreeRemoveSocketInterface(struct bNodeTree *ntree, struct bNodeSocket *sock);
 395
 396 struct StructRNA *ntreeInterfaceTypeGet(struct bNodeTree *ntree, int create);
 397 void ntreeInterfaceTypeFree(struct bNodeTree *ntree);
 398 void ntreeInterfaceTypeUpdate(struct bNodeTree *ntree);
 399
 400 /* ************** GENERIC API, NODES *************** */
 401
 402 struct bNodeType *nodeTypeFind(const char *idname);
 403 void                    nodeRegisterType(struct bNodeType *ntype);
 404 void                    nodeUnregisterType(struct bNodeType *ntype);
 405 bool                    nodeIsRegistered(struct bNode *node);
 406 struct GHashIterator *nodeTypeGetIterator(void);
 407
 408 /* helper macros for iterating over node types */
 409 #define NODE_TYPES_BEGIN(ntype) \
 410 { \
 411         GHashIterator *__node_type_iter__ = nodeTypeGetIterator(); \
 412         for (; !BLI_ghashIterator_done(__node_type_iter__); BLI_ghashIterator_step(__node_type_iter__)) { \
 413                 bNodeType *ntype = BLI_ghashIterator_getValue(__node_type_iter__);
 414
 415 #define NODE_TYPES_END \
 416         } \
 417         BLI_ghashIterator_free(__node_type_iter__); \
 418 }
 419
 420 struct bNodeSocketType *nodeSocketTypeFind(const char *idname);
 421 void                    nodeRegisterSocketType(struct bNodeSocketType *stype);
 422 void                    nodeUnregisterSocketType(struct bNodeSocketType *stype);
 423 bool                    nodeSocketIsRegistered(struct bNodeSocket *sock);
 424 struct GHashIterator *nodeSocketTypeGetIterator(void);
 425 const char *    nodeStaticSocketType(int type, int subtype);
 426 const char *    nodeStaticSocketInterfaceType(int type, int subtype);
 427
 428 /* helper macros for iterating over node types */
 429 #define NODE_SOCKET_TYPES_BEGIN(stype) \
 430 { \
 431         GHashIterator *__node_socket_type_iter__ = nodeSocketTypeGetIterator(); \
 432         for (; !BLI_ghashIterator_done(__node_socket_type_iter__); BLI_ghashIterator_step(__node_socket_type_iter__)) { \
 433                 bNodeSocketType *stype = BLI_ghashIterator_getValue(__node_socket_type_iter__);
 434
 435 #define NODE_SOCKET_TYPES_END \
 436         } \
 437         BLI_ghashIterator_free(__node_socket_type_iter__); \
 438 }
 439
 440 struct bNodeSocket *nodeFindSocket(struct bNode *node, int in_out, const char *identifier);
 441 struct bNodeSocket *nodeAddSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, const char *idname,
 442                                   const char *identifier, const char *name);
 443 struct bNodeSocket *nodeInsertSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, const char *idname,
 444                                      struct bNodeSocket *next_sock, const char *identifier, const char *name);
 445 struct bNodeSocket *nodeAddStaticSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, int type, int subtype,
 446                                         const char *identifier, const char *name);
 447 struct bNodeSocket *nodeInsertStaticSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, int type, int subtype,
 448                                            struct bNodeSocket *next_sock, const char *identifier, const char *name);
 449 void nodeRemoveSocket(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock);
 450 void nodeRemoveAllSockets(struct bNodeTree *ntree, struct bNode *node);
 451
 452 struct bNode    *nodeAddNode(const struct bContext *C, struct bNodeTree *ntree, const char *idname);
 453 struct bNode    *nodeAddStaticNode(const struct bContext *C, struct bNodeTree *ntree, int type);
 454 void            nodeUnlinkNode(struct bNodeTree *ntree, struct bNode *node);
 455 void            nodeUniqueName(struct bNodeTree *ntree, struct bNode *node);
 456
 457 void            nodeFreeNode(struct bNodeTree *ntree, struct bNode *node);
 458 struct bNode    *nodeCopyNode(struct bNodeTree *ntree, struct bNode *node);
 459
 460 struct bNodeLink *nodeAddLink(struct bNodeTree *ntree, struct bNode *fromnode, struct bNodeSocket *fromsock, struct bNode *tonode, struct bNodeSocket *tosock);
 461 void            nodeRemLink(struct bNodeTree *ntree, struct bNodeLink *link);
 462 void            nodeRemSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
 463 int             nodeLinkIsHidden(struct bNodeLink *link);
 464 void            nodeInternalRelink(struct bNodeTree *ntree, struct bNode *node);
 465
 466 void            nodeToView(struct bNode *node, float x, float y, float *rx, float *ry);
 467 void            nodeFromView(struct bNode *node, float x, float y, float *rx, float *ry);
 468 int             nodeAttachNodeCheck(struct bNode *node, struct bNode *parent);
 469 void            nodeAttachNode(struct bNode *node, struct bNode *parent);
 470 void            nodeDetachNode(struct bNode *node);
 471
 472 struct bNode   *nodeFindNodebyName(struct bNodeTree *ntree, const char *name);
 473 int             nodeFindNode(struct bNodeTree *ntree, struct bNodeSocket *sock, struct bNode **nodep, int *sockindex);
 474
 475 struct bNodeLink *nodeFindLink(struct bNodeTree *ntree, struct bNodeSocket *from, struct bNodeSocket *to);
 476 int             nodeCountSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
 477
 478 void                    nodeSetSelected(struct bNode *node, int select);
 479 void            nodeSetActive(struct bNodeTree *ntree, struct bNode *node);
 480 struct bNode   *nodeGetActive(struct bNodeTree *ntree);
 481 struct bNode   *nodeGetActiveID(struct bNodeTree *ntree, short idtype);
 482 bool            nodeSetActiveID(struct bNodeTree *ntree, short idtype, struct ID *id);
 483 void            nodeClearActive(struct bNodeTree *ntree);
 484 void            nodeClearActiveID(struct bNodeTree *ntree, short idtype);
 485 struct bNode   *nodeGetActiveTexture(struct bNodeTree *ntree);
 486
 487 void            nodeUpdate(struct bNodeTree *ntree, struct bNode *node);
 488 int             nodeUpdateID(struct bNodeTree *ntree, struct ID *id);
 489 void            nodeUpdateInternalLinks(struct bNodeTree *ntree, struct bNode *node);
 490 void            nodeSynchronizeID(struct bNode *node, bool copy_to_id);
 491
 492 int             nodeSocketIsHidden(struct bNodeSocket *sock);
 493
 494 /* Node Clipboard */
 495 void                   BKE_node_clipboard_init(struct bNodeTree *ntree);
 496 void                   BKE_node_clipboard_clear(void);
 497 int                    BKE_node_clipboard_validate(void);
 498 void                   BKE_node_clipboard_add_node(struct bNode *node);
 499 void                   BKE_node_clipboard_add_link(struct bNodeLink *link);
 500 const struct ListBase *BKE_node_clipboard_get_nodes(void);
 501 const struct ListBase *BKE_node_clipboard_get_links(void);
 502 int                    BKE_node_clipboard_get_type(void);
 503
 504 /* Node Instance Hash */
 505 typedef struct bNodeInstanceHash
 506 {
 507          GHash *ghash;  /* XXX should be made a direct member, GHash allocation needs to support it */
 508 } bNodeInstanceHash;
 509
 510 typedef void (*bNodeInstanceValueFP)(void *value);
 511
 512 extern const bNodeInstanceKey NODE_INSTANCE_KEY_BASE;
 513 extern const bNodeInstanceKey NODE_INSTANCE_KEY_NONE;
 514
 515 bNodeInstanceKey       BKE_node_instance_key(bNodeInstanceKey parent_key, struct bNodeTree *ntree, struct bNode *node);
 516
 517 bNodeInstanceHash     *BKE_node_instance_hash_new(const char *info);
 518 void                   BKE_node_instance_hash_free(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp);
 519 void                   BKE_node_instance_hash_insert(bNodeInstanceHash *hash, bNodeInstanceKey key, void *value);
 520 void                  *BKE_node_instance_hash_lookup(bNodeInstanceHash *hash, bNodeInstanceKey key);
 521 int                    BKE_node_instance_hash_remove(bNodeInstanceHash *hash, bNodeInstanceKey key, bNodeInstanceValueFP valfreefp);
 522 void                   BKE_node_instance_hash_clear(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp);
 523 void                  *BKE_node_instance_hash_pop(bNodeInstanceHash *hash, bNodeInstanceKey key);
 524 int                    BKE_node_instance_hash_haskey(bNodeInstanceHash *hash, bNodeInstanceKey key);
 525 int                    BKE_node_instance_hash_size(bNodeInstanceHash *hash);
 526
 527 void                   BKE_node_instance_hash_clear_tags(bNodeInstanceHash *hash);
 528 void                   BKE_node_instance_hash_tag(bNodeInstanceHash *hash, void *value);
 529 int                    BKE_node_instance_hash_tag_key(bNodeInstanceHash *hash, bNodeInstanceKey key);
 530 void                   BKE_node_instance_hash_remove_untagged(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp);
 531
 532 typedef GHashIterator bNodeInstanceHashIterator;
 533
 534 BLI_INLINE bNodeInstanceHashIterator *BKE_node_instance_hash_iterator_new(bNodeInstanceHash *hash) { return BLI_ghashIterator_new(hash->ghash); }
 535 BLI_INLINE void                       BKE_node_instance_hash_iterator_init(bNodeInstanceHashIterator *iter, bNodeInstanceHash *hash) { BLI_ghashIterator_init(iter, hash->ghash); }
 536 BLI_INLINE void                       BKE_node_instance_hash_iterator_free(bNodeInstanceHashIterator *iter) { BLI_ghashIterator_free(iter); }
 537 BLI_INLINE bNodeInstanceKey           BKE_node_instance_hash_iterator_get_key(bNodeInstanceHashIterator *iter) { return *(bNodeInstanceKey *)BLI_ghashIterator_getKey(iter); }
 538 BLI_INLINE void                      *BKE_node_instance_hash_iterator_get_value(bNodeInstanceHashIterator *iter) { return BLI_ghashIterator_getValue(iter); }
 539 BLI_INLINE void                       BKE_node_instance_hash_iterator_step(bNodeInstanceHashIterator *iter) { BLI_ghashIterator_step(iter); }
 540 BLI_INLINE bool                       BKE_node_instance_hash_iterator_done(bNodeInstanceHashIterator *iter) { return BLI_ghashIterator_done(iter); }
 541
 542 #define NODE_INSTANCE_HASH_ITER(iter_, hash_) \
 543         for (BKE_node_instance_hash_iterator_init(&iter_, hash_); \
 544              BKE_node_instance_hash_iterator_done(&iter_) == false; \
 545              BKE_node_instance_hash_iterator_step(&iter_))
 546
 547
 548 /* Node Previews */
 549
 550 int             BKE_node_preview_used(struct bNode *node);
 551 bNodePreview   *BKE_node_preview_verify(struct bNodeInstanceHash *previews, bNodeInstanceKey key, int xsize, int ysize, int create);
 552 bNodePreview   *BKE_node_preview_copy(struct bNodePreview *preview);
 553 void            BKE_node_preview_free(struct bNodePreview *preview);
 554 void            BKE_node_preview_init_tree(struct bNodeTree *ntree, int xsize, int ysize, int create_previews);
 555 void            BKE_node_preview_free_tree(struct bNodeTree *ntree);
 556 void            BKE_node_preview_remove_unused(struct bNodeTree *ntree);
 557 void            BKE_node_preview_clear(struct bNodePreview *preview);
 558 void            BKE_node_preview_clear_tree(struct bNodeTree *ntree);
 559
 560 void            BKE_node_preview_sync_tree(struct bNodeTree *to_ntree, struct bNodeTree *from_ntree);
 561 void            BKE_node_preview_merge_tree(struct bNodeTree *to_ntree, struct bNodeTree *from_ntree, bool remove_old);
 562
 563 void            BKE_node_preview_set_pixel(struct bNodePreview *preview, const float col[4], int x, int y, int do_manage);
 564
 565
 566 /* ************** NODE TYPE ACCESS *************** */
 567
 568 const char     *nodeLabel(struct bNode *node);
 569
 570 int                             nodeGroupPoll(struct bNodeTree *nodetree, struct bNodeTree *grouptree);
 571
 572 /* Init a new node type struct with default values and callbacks */
 573 void            node_type_base(struct bNodeType *ntype, int type, const char *name, short nclass, short flag);
 574 void            node_type_base_custom(struct bNodeType *ntype, const char *idname, const char *name, short nclass, short flag);
 575 void            node_type_socket_templates(struct bNodeType *ntype, struct bNodeSocketTemplate *inputs, struct bNodeSocketTemplate *outputs);
 576 void            node_type_size(struct bNodeType *ntype, int width, int minwidth, int maxwidth);
 577 void            node_type_size_preset(struct bNodeType *ntype, eNodeSizePreset size);
 578 void            node_type_init(struct bNodeType *ntype, void (*initfunc)(struct bNodeTree *ntree, struct bNode *node));
 579 void            node_type_storage(struct bNodeType *ntype,
 580                                   const char *storagename,
 581                                   void (*freefunc)(struct bNode *node),
 582                                   void (*copyfunc)(struct bNodeTree *dest_ntree, struct bNode *dest_node, struct bNode *src_node));
 583 void            node_type_label(struct bNodeType *ntype, const char *(*labelfunc)(struct bNode *));
 584 void            node_type_update(struct bNodeType *ntype,
 585                                  void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node),
 586                                  void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id));
 587
 588 void            node_type_exec(struct bNodeType *ntype, NodeInitExecFunction initexecfunc, NodeFreeExecFunction freeexecfunc, NodeExecFunction execfunc);
 589 void            node_type_gpu(struct bNodeType *ntype, NodeGPUExecFunction gpufunc);
 590 void            node_type_internal_links(struct bNodeType *ntype, void (*update_internal_links)(struct bNodeTree *, struct bNode *));
 591 void            node_type_compatibility(struct bNodeType *ntype, short compatibility);
 592
 593 /* ************** COMMON NODES *************** */
 594
 595 #define NODE_UNDEFINED  -2              /* node type is not registered */
 596 #define NODE_CUSTOM             -1              /* for dynamically registered custom types */
 597 #define NODE_GROUP              2
 598 #define __NODE_FORLOOP  3               /* deprecated */
 599 #define __NODE_WHILELOOP        4       /* deprecated */
 600 #define NODE_FRAME              5
 601 #define NODE_REROUTE    6
 602 #define NODE_GROUP_INPUT        7
 603 #define NODE_GROUP_OUTPUT       8
 604
 605 void BKE_node_tree_unlink_id(ID *id, struct bNodeTree *ntree);
 606
 607 /* Utility macro for visiting every node tree in the library data, including local bNodeTree blocks in other IDs.
 608  * This avoids the need for callback functions and allows executing code in a single inner code block.
 609  *
 610  * Variables:
 611  *
 612  *   nodetree:  The actual bNodeTree data block.
 613  *              Check nodetree->idname or nodetree->typeinfo to use only specific types.
 614  *
 615  *   id:        The owner of the bNodeTree data block.
 616  *              Same as nodetree if it's a linkable node tree from the library.
 617  *
 618  * Examples:
 619  *
 620  * FOREACH_NODETREE(bmain, nodetree) {
 621  *     if (id == nodetree)
 622  *         printf("This is a linkable node tree");
 623  * } FOREACH_NODETREE_END
 624  *
 625  * FOREACH_NODETREE(bmain, nodetree) {
 626  *     if (nodetree->idname == "ShaderNodeTree")
 627  *         printf("This is a shader node tree);
 628  *     if (GS(id) == ID_MA)
 629  *         printf(" and it's owned by a material");
 630  * } FOREACH_NODETREE_END
 631  */
 632
 633 /* should be an opaque type, only for internal use by BKE_node_tree_iter_*** */
 634 struct NodeTreeIterStore {
 635         bNodeTree *ngroup;
 636         Scene *scene;
 637         Material *mat;
 638         Tex *tex;
 639         Lamp *lamp;
 640         World *world;
 641 };
 642
 643 void BKE_node_tree_iter_init(struct NodeTreeIterStore *ntreeiter, struct Main *bmain);
 644 bool BKE_node_tree_iter_step(struct NodeTreeIterStore *ntreeiter,
 645                              struct bNodeTree **r_nodetree, struct ID **r_id);
 646
 647 #define FOREACH_NODETREE(bmain, _nodetree, _id) \
 648 { \
 649         struct NodeTreeIterStore _nstore; \
 650         bNodeTree *_nodetree; \
 651         ID *_id; \
 652         /* avoid compiler warning about unused variables */ \
 653         BKE_node_tree_iter_init(&_nstore, bmain); \
 654         while (BKE_node_tree_iter_step(&_nstore, &_nodetree, &_id) == true) { \
 655                 if (_nodetree) {
 656
 657 #define FOREACH_NODETREE_END \
 658                 } \
 659         } \
 660 }
 661
 662 /* ************** SHADER NODES *************** */
 663
 664 struct ShadeInput;
 665 struct ShadeResult;
 666
 667 /* note: types are needed to restore callbacks, don't change values */
 668 /* range 1 - 100 is reserved for common nodes */
 669 /* using toolbox, we add node groups by assuming the values below don't exceed NODE_GROUP_MENU for now */
 670
 671 #define SH_NODE_OUTPUT          1
 672
 673 #define SH_NODE_MATERIAL        100
 674 #define SH_NODE_RGB                     101
 675 #define SH_NODE_VALUE           102
 676 #define SH_NODE_MIX_RGB         103
 677 #define SH_NODE_VALTORGB        104
 678 #define SH_NODE_RGBTOBW         105
 679 #define SH_NODE_TEXTURE         106
 680 #define SH_NODE_NORMAL          107
 681 #define SH_NODE_GEOMETRY        108
 682 #define SH_NODE_MAPPING         109
 683 #define SH_NODE_CURVE_VEC       110
 684 #define SH_NODE_CURVE_RGB       111
 685 #define SH_NODE_CAMERA          114
 686 #define SH_NODE_MATH            115
 687 #define SH_NODE_VECT_MATH       116
 688 #define SH_NODE_SQUEEZE         117
 689 #define SH_NODE_MATERIAL_EXT    118
 690 #define SH_NODE_INVERT          119
 691 #define SH_NODE_SEPRGB          120
 692 #define SH_NODE_COMBRGB         121
 693 #define SH_NODE_HUE_SAT         122
 694 #define NODE_DYNAMIC            123
 695
 696 #define SH_NODE_OUTPUT_MATERIAL                 124
 697 #define SH_NODE_OUTPUT_WORLD                    125
 698 #define SH_NODE_OUTPUT_LAMP                             126
 699 #define SH_NODE_FRESNEL                                 127
 700 #define SH_NODE_MIX_SHADER                              128
 701 #define SH_NODE_ATTRIBUTE                               129
 702 #define SH_NODE_BACKGROUND                              130
 703 #define SH_NODE_BSDF_ANISOTROPIC                131
 704 #define SH_NODE_BSDF_DIFFUSE                    132
 705 #define SH_NODE_BSDF_GLOSSY                             133
 706 #define SH_NODE_BSDF_GLASS                              134
 707 #define SH_NODE_BSDF_TRANSLUCENT                137
 708 #define SH_NODE_BSDF_TRANSPARENT                138
 709 #define SH_NODE_BSDF_VELVET                             139
 710 #define SH_NODE_EMISSION                                140
 711 #define SH_NODE_NEW_GEOMETRY                    141
 712 #define SH_NODE_LIGHT_PATH                              142
 713 #define SH_NODE_TEX_IMAGE                               143
 714 #define SH_NODE_TEX_SKY                                 145
 715 #define SH_NODE_TEX_GRADIENT                    146
 716 #define SH_NODE_TEX_VORONOI                             147
 717 #define SH_NODE_TEX_MAGIC                               148
 718 #define SH_NODE_TEX_WAVE                                149
 719 #define SH_NODE_TEX_NOISE                               150
 720 #define SH_NODE_TEX_MUSGRAVE                    152
 721 #define SH_NODE_TEX_COORD                               155
 722 #define SH_NODE_ADD_SHADER                              156
 723 #define SH_NODE_TEX_ENVIRONMENT                 157
 724 #define SH_NODE_OUTPUT_TEXTURE                  158
 725 #define SH_NODE_HOLDOUT                                 159
 726 #define SH_NODE_LAYER_WEIGHT                    160
 727 #define SH_NODE_VOLUME_TRANSPARENT              161
 728 #define SH_NODE_VOLUME_ISOTROPIC                162
 729 #define SH_NODE_GAMMA                                   163
 730 #define SH_NODE_TEX_CHECKER                             164
 731 #define SH_NODE_BRIGHTCONTRAST                  165
 732 #define SH_NODE_LIGHT_FALLOFF                   166
 733 #define SH_NODE_OBJECT_INFO                             167
 734 #define SH_NODE_PARTICLE_INFO           168
 735 #define SH_NODE_TEX_BRICK                               169
 736 #define SH_NODE_BUMP                                    170
 737 #define SH_NODE_SCRIPT                                  171
 738 #define SH_NODE_AMBIENT_OCCLUSION               172
 739 #define SH_NODE_BSDF_REFRACTION                 173
 740 #define SH_NODE_TANGENT                                 174
 741 #define SH_NODE_NORMAL_MAP                              175
 742 #define SH_NODE_HAIR_INFO                               176
 743 #define SH_NODE_SUBSURFACE_SCATTERING   177
 744 #define SH_NODE_WIREFRAME                               178
 745 #define SH_NODE_BSDF_TOON                               179
 746 #define SH_NODE_WAVELENGTH                              180
 747 #define SH_NODE_BLACKBODY                               181
 748 #define SH_NODE_VECT_TRANSFORM                  182
 749 #define SH_NODE_SEPHSV                                  183
 750 #define SH_NODE_COMBHSV                                 184
 751 #define SH_NODE_BSDF_HAIR                               185
 752
 753 /* custom defines options for Material node */
 754 #define SH_NODE_MAT_DIFF   1
 755 #define SH_NODE_MAT_SPEC   2
 756 #define SH_NODE_MAT_NEG    4
 757 /* custom defines: states for Script node. These are bit indices */
 758 #define NODE_DYNAMIC_READY      0 /* 1 */
 759 #define NODE_DYNAMIC_LOADED     1 /* 2 */
 760 #define NODE_DYNAMIC_NEW        2 /* 4 */
 761 #define NODE_DYNAMIC_UPDATED    3 /* 8 */
 762 #define NODE_DYNAMIC_ADDEXIST   4 /* 16 */
 763 #define NODE_DYNAMIC_ERROR      5 /* 32 */
 764 #define NODE_DYNAMIC_REPARSE    6 /* 64 */
 765 #define NODE_DYNAMIC_SET        15 /* sign */
 766
 767 /* API */
 768
 769 struct bNodeTreeExec *ntreeShaderBeginExecTree(struct bNodeTree *ntree);
 770 void            ntreeShaderEndExecTree(struct bNodeTreeExec *exec);
 771 bool            ntreeShaderExecTree(struct bNodeTree *ntree, struct ShadeInput *shi, struct ShadeResult *shr);
 772 void            ntreeShaderGetTexcoMode(struct bNodeTree *ntree, int osa, short *texco, int *mode);
 773
 774 /* switch material render loop */
 775 extern void (*node_shader_lamp_loop)(struct ShadeInput *, struct ShadeResult *);
 776 void            set_node_shader_lamp_loop(void (*lamp_loop_func)(struct ShadeInput *, struct ShadeResult *));
 777
 778 void            ntreeGPUMaterialNodes(struct bNodeTree *ntree, struct GPUMaterial *mat);
 779
 780
 781 /* ************** COMPOSITE NODES *************** */
 782
 783 /* output socket defines */
 784 #define RRES_OUT_IMAGE                                  0
 785 #define RRES_OUT_ALPHA                                  1
 786 #define RRES_OUT_Z                                              2
 787 #define RRES_OUT_NORMAL                                 3
 788 #define RRES_OUT_UV                                             4
 789 #define RRES_OUT_VEC                                    5
 790 #define RRES_OUT_RGBA                                   6
 791 #define RRES_OUT_DIFF                                   7
 792 #define RRES_OUT_SPEC                                   8
 793 #define RRES_OUT_SHADOW                                 9
 794 #define RRES_OUT_AO                                             10
 795 #define RRES_OUT_REFLECT                                11
 796 #define RRES_OUT_REFRACT                                12
 797 #define RRES_OUT_INDIRECT                               13
 798 #define RRES_OUT_INDEXOB                                14
 799 #define RRES_OUT_INDEXMA                                15
 800 #define RRES_OUT_MIST                                   16
 801 #define RRES_OUT_EMIT                                   17
 802 #define RRES_OUT_ENV                                    18
 803 #define RRES_OUT_DIFF_DIRECT                    19
 804 #define RRES_OUT_DIFF_INDIRECT                  20
 805 #define RRES_OUT_DIFF_COLOR                             21
 806 #define RRES_OUT_GLOSSY_DIRECT                  22
 807 #define RRES_OUT_GLOSSY_INDIRECT                23
 808 #define RRES_OUT_GLOSSY_COLOR                   24
 809 #define RRES_OUT_TRANSM_DIRECT                  25
 810 #define RRES_OUT_TRANSM_INDIRECT                26
 811 #define RRES_OUT_TRANSM_COLOR                   27
 812 #define RRES_OUT_SUBSURFACE_DIRECT              28
 813 #define RRES_OUT_SUBSURFACE_INDIRECT    29
 814 #define RRES_OUT_SUBSURFACE_COLOR               30
 815
 816 /* note: types are needed to restore callbacks, don't change values */
 817 #define CMP_NODE_VIEWER         201
 818 #define CMP_NODE_RGB            202
 819 #define CMP_NODE_VALUE          203
 820 #define CMP_NODE_MIX_RGB        204
 821 #define CMP_NODE_VALTORGB       205
 822 #define CMP_NODE_RGBTOBW        206
 823 #define CMP_NODE_NORMAL         207
 824 #define CMP_NODE_CURVE_VEC      208
 825 #define CMP_NODE_CURVE_RGB      209
 826 #define CMP_NODE_ALPHAOVER      210
 827 #define CMP_NODE_BLUR           211
 828 #define CMP_NODE_FILTER         212
 829 #define CMP_NODE_MAP_VALUE      213
 830 #define CMP_NODE_TIME           214
 831 #define CMP_NODE_VECBLUR        215
 832 #define CMP_NODE_SEPRGBA        216
 833 #define CMP_NODE_SEPHSVA        217
 834 #define CMP_NODE_SETALPHA       218
 835 #define CMP_NODE_HUE_SAT        219
 836 #define CMP_NODE_IMAGE          220
 837 #define CMP_NODE_R_LAYERS       221
 838 #define CMP_NODE_COMPOSITE      222
 839 #define CMP_NODE_OUTPUT_FILE    223
 840 #define CMP_NODE_TEXTURE        224
 841 #define CMP_NODE_TRANSLATE      225
 842 #define CMP_NODE_ZCOMBINE       226
 843 #define CMP_NODE_COMBRGBA       227
 844 #define CMP_NODE_DILATEERODE    228
 845 #define CMP_NODE_ROTATE         229
 846 #define CMP_NODE_SCALE          230
 847 #define CMP_NODE_SEPYCCA        231
 848 #define CMP_NODE_COMBYCCA       232
 849 #define CMP_NODE_SEPYUVA        233
 850 #define CMP_NODE_COMBYUVA       234
 851 #define CMP_NODE_DIFF_MATTE     235
 852 #define CMP_NODE_COLOR_SPILL    236
 853 #define CMP_NODE_CHROMA_MATTE   237
 854 #define CMP_NODE_CHANNEL_MATTE  238
 855 #define CMP_NODE_FLIP           239
 856 #define CMP_NODE_SPLITVIEWER    240
 857 #define CMP_NODE_INDEX_MASK     241
 858 #define CMP_NODE_MAP_UV         242
 859 #define CMP_NODE_ID_MASK        243
 860 #define CMP_NODE_DEFOCUS        244
 861 #define CMP_NODE_DISPLACE       245
 862 #define CMP_NODE_COMBHSVA       246
 863 #define CMP_NODE_MATH           247
 864 #define CMP_NODE_LUMA_MATTE     248
 865 #define CMP_NODE_BRIGHTCONTRAST 249
 866 #define CMP_NODE_GAMMA          250
 867 #define CMP_NODE_INVERT         251
 868 #define CMP_NODE_NORMALIZE      252
 869 #define CMP_NODE_CROP           253
 870 #define CMP_NODE_DBLUR          254
 871 #define CMP_NODE_BILATERALBLUR  255
 872 #define CMP_NODE_PREMULKEY  256
 873 #define CMP_NODE_DIST_MATTE     257
 874 #define CMP_NODE_VIEW_LEVELS    258
 875 #define CMP_NODE_COLOR_MATTE 259
 876 #define CMP_NODE_COLORBALANCE 260
 877 #define CMP_NODE_HUECORRECT 261
 878 #define CMP_NODE_MOVIECLIP      262
 879 #define CMP_NODE_STABILIZE2D    263
 880 #define CMP_NODE_TRANSFORM      264
 881 #define CMP_NODE_MOVIEDISTORTION        265
 882 #define CMP_NODE_DOUBLEEDGEMASK    266
 883 #define CMP_NODE_OUTPUT_MULTI_FILE__DEPRECATED  267     /* DEPRECATED multi file node has been merged into regular CMP_NODE_OUTPUT_FILE */
 884 #define CMP_NODE_MASK           268
 885 #define CMP_NODE_KEYINGSCREEN           269
 886 #define CMP_NODE_KEYING                 270
 887 #define CMP_NODE_TRACKPOS               271
 888 #define CMP_NODE_INPAINT    272
 889 #define CMP_NODE_DESPECKLE  273
 890
 891 #define CMP_NODE_GLARE          301
 892 #define CMP_NODE_TONEMAP        302
 893 #define CMP_NODE_LENSDIST       303
 894
 895 #define CMP_NODE_COLORCORRECTION 312
 896 #define CMP_NODE_MASK_BOX       313
 897 #define CMP_NODE_MASK_ELLIPSE   314
 898 #define CMP_NODE_BOKEHIMAGE     315
 899 #define CMP_NODE_BOKEHBLUR      316
 900 #define CMP_NODE_SWITCH         317
 901 #define CMP_NODE_PIXELATE       318
 902
 903 #define CMP_NODE_MAP_RANGE      319
 904 #define CMP_NODE_PLANETRACKDEFORM       320
 905
 906 /* channel toggles */
 907 #define CMP_CHAN_RGB            1
 908 #define CMP_CHAN_A                      2
 909 #define CMP_CHAN_R                      4
 910 #define CMP_CHAN_G                      8
 911 #define CMP_CHAN_B                      16
 912
 913 /* filter types */
 914 #define CMP_FILT_SOFT           0
 915 #define CMP_FILT_SHARP          1
 916 #define CMP_FILT_LAPLACE        2
 917 #define CMP_FILT_SOBEL          3
 918 #define CMP_FILT_PREWITT        4
 919 #define CMP_FILT_KIRSCH         5
 920 #define CMP_FILT_SHADOW         6
 921
 922 /* scale node type, in custom1 */
 923 #define CMP_SCALE_RELATIVE              0
 924 #define CMP_SCALE_ABSOLUTE              1
 925 #define CMP_SCALE_SCENEPERCENT  2
 926 #define CMP_SCALE_RENDERPERCENT 3
 927 /* custom2 */
 928 #define CMP_SCALE_RENDERSIZE_FRAME_ASPECT  (1 << 0)
 929 #define CMP_SCALE_RENDERSIZE_FRAME_CROP    (1 << 1)
 930
 931 /* track position node, in custom1 */
 932 #define CMP_TRACKPOS_ABSOLUTE                   0
 933 #define CMP_TRACKPOS_RELATIVE_START     1
 934 #define CMP_TRACKPOS_RELATIVE_FRAME     2
 935 #define CMP_TRACKPOS_ABSOLUTE_FRAME     3
 936
 937 /* API */
 938 struct CompBuf;
 939 void ntreeCompositExecTree(struct bNodeTree *ntree, struct RenderData *rd, int rendering, int do_previews,
 940                            const struct ColorManagedViewSettings *view_settings, const struct ColorManagedDisplaySettings *display_settings);
 941 void ntreeCompositTagRender(struct Scene *sce);
 942 int ntreeCompositTagAnimated(struct bNodeTree *ntree);
 943 void ntreeCompositTagGenerators(struct bNodeTree *ntree);
 944 void ntreeCompositForceHidden(struct bNodeTree *ntree);
 945 void ntreeCompositClearTags(struct bNodeTree *ntree);
 946
 947 struct bNodeSocket *ntreeCompositOutputFileAddSocket(struct bNodeTree *ntree, struct bNode *node,
 948                                                      const char *name, struct ImageFormatData *im_format);
 949 int ntreeCompositOutputFileRemoveActiveSocket(struct bNodeTree *ntree, struct bNode *node);
 950 void ntreeCompositOutputFileSetPath(struct bNode *node, struct bNodeSocket *sock, const char *name);
 951 void ntreeCompositOutputFileSetLayer(struct bNode *node, struct bNodeSocket *sock, const char *name);
 952 /* needed in do_versions */
 953 void ntreeCompositOutputFileUniquePath(struct ListBase *list, struct bNodeSocket *sock, const char defname[], char delim);
 954 void ntreeCompositOutputFileUniqueLayer(struct ListBase *list, struct bNodeSocket *sock, const char defname[], char delim);
 955
 956 /* ************** TEXTURE NODES *************** */
 957
 958 struct TexResult;
 959
 960 #define TEX_NODE_OUTPUT     401
 961 #define TEX_NODE_CHECKER    402
 962 #define TEX_NODE_TEXTURE    403
 963 #define TEX_NODE_BRICKS     404
 964 #define TEX_NODE_MATH       405
 965 #define TEX_NODE_MIX_RGB    406
 966 #define TEX_NODE_RGBTOBW    407
 967 #define TEX_NODE_VALTORGB   408
 968 #define TEX_NODE_IMAGE      409
 969 #define TEX_NODE_CURVE_RGB  410
 970 #define TEX_NODE_INVERT     411
 971 #define TEX_NODE_HUE_SAT    412
 972 #define TEX_NODE_CURVE_TIME 413
 973 #define TEX_NODE_ROTATE     414
 974 #define TEX_NODE_VIEWER     415
 975 #define TEX_NODE_TRANSLATE  416
 976 #define TEX_NODE_COORD      417
 977 #define TEX_NODE_DISTANCE   418
 978 #define TEX_NODE_COMPOSE    419
 979 #define TEX_NODE_DECOMPOSE  420
 980 #define TEX_NODE_VALTONOR   421
 981 #define TEX_NODE_SCALE      422
 982 #define TEX_NODE_AT         423
 983
 984 /* 501-599 reserved. Use like this: TEX_NODE_PROC + TEX_CLOUDS, etc */
 985 #define TEX_NODE_PROC      500
 986 #define TEX_NODE_PROC_MAX  600
 987
 988 /* API */
 989 int  ntreeTexTagAnimated(struct bNodeTree *ntree);
 990 void ntreeTexCheckCyclics(struct bNodeTree *ntree);
 991
 992 struct bNodeTreeExec *ntreeTexBeginExecTree(struct bNodeTree *ntree);
 993 void ntreeTexEndExecTree(struct bNodeTreeExec *exec);
 994 int ntreeTexExecTree(struct bNodeTree *ntree, struct TexResult *target,
 995                      float coord[3], float dxt[3], float dyt[3], int osatex, const short thread,
 996                      struct Tex *tex, short which_output, int cfra, int preview, struct ShadeInput *shi, struct MTex *mtex);
 997
 998
 999 /*************************************************/
1000
1001 void init_nodesystem(void);
1002 void free_nodesystem(void);
1003
1004 void clear_scene_in_nodes(struct Main *bmain, struct Scene *sce);
1005
1006 #endif