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