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