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