e625545e6ddc5024b4deffa03e7e4d177cc63918
[blender-staging.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 "DNA_listBase.h"
36
37 #include "RNA_types.h"
38
39 /* not very important, but the stack solver likes to know a maximum */
40 #define MAX_SOCKET      64
41
42 struct bContext;
43 struct bNode;
44 struct bNodeLink;
45 struct bNodeSocket;
46 struct bNodeStack;
47 struct bNodeTree;
48 struct bNodeTreeExec;
49 struct GPUMaterial;
50 struct GPUNode;
51 struct GPUNodeStack;
52 struct ID;
53 struct ImageFormatData;
54 struct ListBase;
55 struct Main;
56 struct uiBlock;
57 struct uiLayout;
58 struct MTex;
59 struct PointerRNA;
60 struct rctf;
61 struct RenderData;
62 struct Scene;
63 struct Tex;
64 struct SpaceNode;
65 struct ARegion;
66 struct Object;
67
68 /* ************** NODE TYPE DEFINITIONS ***** */
69
70 /** Compact definition of a node socket.
71  * Can be used to quickly define a list of static sockets for a node,
72  * which are added to each new node of that type. 
73  *
74  * \deprecated New nodes should add default sockets in the initialization
75  * function instead. This struct is mostly kept for old nodes and should
76  * be removed some time.
77  */
78 typedef struct bNodeSocketTemplate {
79         int type, limit;
80         char name[64];  /* MAX_NAME */
81         float val1, val2, val3, val4;   /* default alloc value for inputs */
82         float min, max;
83         PropertySubType subtype;
84         int flag;
85         
86         /* after this line is used internal only */
87         struct bNodeSocket *sock;               /* used to hold verified socket */
88 } bNodeSocketTemplate;
89
90 typedef void (*NodeSocketButtonFunction)(const struct bContext *C, struct uiBlock *block, 
91                                                                                  struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock,
92                                                                                  const char *name, int x, int y, int width);
93
94 /** Defines a socket type.
95  * Defines the appearance and behavior of a socket in the UI.
96  */
97 typedef struct bNodeSocketType {
98         int type;
99         char ui_name[64];       /* MAX_NAME */
100         char ui_description[128];
101         int ui_icon;
102         char ui_color[4];
103         
104         const char *value_structname;
105         int value_structsize;
106         
107         NodeSocketButtonFunction buttonfunc;
108 } bNodeSocketType;
109
110 /** Template for creating a node.
111  * Stored required parameters to make a new node of a specific type.
112  */
113 typedef struct bNodeTemplate {
114         int type;
115         
116         struct Main *main;
117         struct Scene *scene;
118         struct bNodeTree *ngroup;       /* group tree */
119 } bNodeTemplate;
120
121 /** Defines a node type.
122  * Initial attributes and constants for a node as well as callback functions
123  * implementing the node behavior.
124  */
125 typedef struct bNodeType {
126         void *next,*prev;
127         short needs_free;               /* set for allocated types that need to be freed */
128         
129         int type;
130         char name[64];  /* MAX_NAME */
131         float width, minwidth, maxwidth;
132         float height, minheight, maxheight;
133         short nclass, flag, compatibility;
134         
135         /* templates for static sockets */
136         bNodeSocketTemplate *inputs, *outputs;
137         
138         char storagename[64];                   /* struct name for DNA */
139         
140         /// Main draw function for the node.
141         void (*drawfunc)(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode, struct bNodeTree *ntree, struct bNode *node);
142         /// Updates the node geometry attributes according to internal state before actual drawing.
143         void (*drawupdatefunc)(const struct bContext *C, struct bNodeTree *ntree, struct bNode *node);
144         /// Draw the option buttons on the node.
145         void (*uifunc)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
146         /// Additional parameters in the side panel.
147         void (*uifuncbut)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
148         /// Optional custom label function for the node header.
149         const char *(*labelfunc)(struct bNode *);
150         /// Optional custom resize handle polling.
151         int (*resize_area_func)(struct bNode *node, int x, int y);
152         
153         /// Called when the node is updated in the editor.
154         void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node);
155         /// Check and update if internal ID data has changed.
156         void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id);
157         
158         /// Initialize a new node instance of this type after creation.
159         void (*initfunc)(struct bNodeTree *ntree, struct bNode *node, struct bNodeTemplate *ntemp);
160         /// Free the custom storage data.
161         void (*freestoragefunc)(struct bNode *node);
162         /// Make a copy of the custom storage data.
163         void (*copystoragefunc)(struct bNode *node, struct bNode *target);
164         
165         /// Create a template from an existing node.
166         struct bNodeTemplate (*templatefunc)(struct bNode *);
167         /** If a node can be made from the template in the given node tree.
168          * \example Node groups can not be created inside their own node tree.
169          */
170         int (*validfunc)(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
171         
172         /// Initialize a node tree associated to this node type.
173         void (*inittreefunc)(struct bNodeTree *ntree);
174         /// Update a node tree associated to this node type.
175         void (*updatetreefunc)(struct bNodeTree *ntree);
176         
177         /* group edit callbacks for operators */
178         /* XXX this is going to be changed as required by the UI */
179         struct bNodeTree *(*group_edit_get)(struct bNode *node);
180         struct bNodeTree *(*group_edit_set)(struct bNode *node, int edit);
181         void (*group_edit_clear)(struct bNode *node);
182         
183         
184         /* **** execution callbacks **** */
185         void *(*initexecfunc)(struct bNode *node);
186         void (*freeexecfunc)(struct bNode *node, void *nodedata);
187         void (*execfunc)(void *data, struct bNode *, struct bNodeStack **, struct bNodeStack **);
188         /* XXX this alternative exec function has been added to avoid changing all node types.
189          * when a final generic version of execution code is defined, this will be changed anyway
190          */
191         void (*newexecfunc)(void *data, int thread, struct bNode *, void *nodedata, struct bNodeStack **, struct bNodeStack **);
192         /* This is the muting callback.
193          * XXX Mimics the newexecfunc signature... Not sure all of this will be useful, we will see.
194          */
195         void (*mutefunc)(void *data, int thread, struct bNode *, void *nodedata, struct bNodeStack **, struct bNodeStack **);
196         /* And the muting util.
197          * Returns links as a ListBase, as pairs of bNodeStack* if in/out bNodeStacks were provided,
198          * else as pairs of bNodeSocket* if node tree was provided.
199          */
200         ListBase (*mutelinksfunc)(struct bNodeTree *, struct bNode *, struct bNodeStack **, struct bNodeStack **,
201                                   struct GPUNodeStack *, struct GPUNodeStack *);
202         /* gpu */
203         int (*gpufunc)(struct GPUMaterial *mat, struct bNode *node, struct GPUNodeStack *in, struct GPUNodeStack *out);
204         /* extended gpu function */
205         int (*gpuextfunc)(struct GPUMaterial *mat, struct bNode *node, void *nodedata, struct GPUNodeStack *in, struct GPUNodeStack *out);
206         /* This is the muting gpu callback.
207          * XXX Mimics the gpuextfunc signature... Not sure all of this will be useful, we will see.
208          */
209         int (*gpumutefunc)(struct GPUMaterial *, struct bNode *, void *, struct GPUNodeStack *, struct GPUNodeStack *);
210 } bNodeType;
211
212 /* node->exec, now in use for composites (#define for break is same as ready yes) */
213 #define NODE_PROCESSING 1
214 #define NODE_READY              2
215 #define NODE_BREAK              2
216 #define NODE_FINISHED   4
217 #define NODE_FREEBUFS   8
218 #define NODE_SKIPPED    16
219
220 /* sim_exec return value */
221 #define NODE_EXEC_FINISHED      0
222 #define NODE_EXEC_SUSPEND       1
223
224 /* nodetype->nclass, for add-menu and themes */
225 #define NODE_CLASS_INPUT                        0
226 #define NODE_CLASS_OUTPUT                       1
227 #define NODE_CLASS_OP_COLOR                     3
228 #define NODE_CLASS_OP_VECTOR            4
229 #define NODE_CLASS_OP_FILTER            5
230 #define NODE_CLASS_GROUP                        6
231 #define NODE_CLASS_FILE                         7
232 #define NODE_CLASS_CONVERTOR            8
233 #define NODE_CLASS_MATTE                        9
234 #define NODE_CLASS_DISTORT                      10
235 #define NODE_CLASS_OP_DYNAMIC           11
236 #define NODE_CLASS_PATTERN                      12
237 #define NODE_CLASS_TEXTURE                      13
238 #define NODE_CLASS_EXECUTION            14
239 #define NODE_CLASS_GETDATA                      15
240 #define NODE_CLASS_SETDATA                      16
241 #define NODE_CLASS_MATH                         17
242 #define NODE_CLASS_MATH_VECTOR          18
243 #define NODE_CLASS_MATH_ROTATION        19
244 #define NODE_CLASS_PARTICLES            25
245 #define NODE_CLASS_TRANSFORM            30
246 #define NODE_CLASS_COMBINE                      31
247 #define NODE_CLASS_SHADER                       40
248 #define NODE_CLASS_LAYOUT                       100
249
250 /* nodetype->compatibility */
251 #define NODE_OLD_SHADING        1
252 #define NODE_NEW_SHADING        2
253
254 /* enum values for input/output */
255 #define SOCK_IN         1
256 #define SOCK_OUT        2
257
258 struct bNodeTreeExec;
259
260 typedef void (*bNodeTreeCallback)(void *calldata, struct ID *owner_id, struct bNodeTree *ntree);
261 typedef void (*bNodeClassCallback)(void *calldata, int nclass, const char *name);
262 typedef struct bNodeTreeType
263 {
264         int type;                                               /* type identifier */
265         char idname[64];                                /* id name for RNA identification */
266         
267         ListBase node_types;                    /* type definitions */
268         
269         /* callbacks */
270         void (*free_cache)(struct bNodeTree *ntree);
271         void (*free_node_cache)(struct bNodeTree *ntree, struct bNode *node);
272         void (*foreach_nodetree)(struct Main *main, void *calldata, bNodeTreeCallback func);            /* iteration over all node trees */
273         void (*foreach_nodeclass)(struct Scene *scene, void *calldata, bNodeClassCallback func);        /* iteration over all node classes */
274
275         /* calls allowing threaded composite */
276         void (*localize)(struct bNodeTree *localtree, struct bNodeTree *ntree);
277         void (*local_sync)(struct bNodeTree *localtree, struct bNodeTree *ntree);
278         void (*local_merge)(struct bNodeTree *localtree, struct bNodeTree *ntree);
279
280         /* Tree update. Overrides nodetype->updatetreefunc! */
281         void (*update)(struct bNodeTree *ntree);
282         /* Node update. Overrides nodetype->updatefunc! */
283         void (*update_node)(struct bNodeTree *ntree, struct bNode *node);
284         
285         int (*validate_link)(struct bNodeTree *ntree, struct bNodeLink *link);
286
287         /* Default muting pointers. */
288         void (*mutefunc)(void *data, int thread, struct bNode *, void *nodedata, struct bNodeStack **, struct bNodeStack **);
289         ListBase (*mutelinksfunc)(struct bNodeTree *, struct bNode *, struct bNodeStack **, struct bNodeStack **,
290                                   struct GPUNodeStack *, struct GPUNodeStack *);
291         /* gpu */
292         int (*gpumutefunc)(struct GPUMaterial *, struct bNode *, void *, struct GPUNodeStack *, struct GPUNodeStack *);
293 } bNodeTreeType;
294
295 /* ************** GENERIC API, TREES *************** */
296
297 struct bNodeTreeType *ntreeGetType(int type);
298 struct bNodeType *ntreeGetNodeType(struct bNodeTree *ntree);
299 struct bNodeSocketType *ntreeGetSocketType(int type);
300
301 struct bNodeTree *ntreeAddTree(const char *name, int type, int nodetype);
302 void                    ntreeInitTypes(struct bNodeTree *ntree);
303
304 void                    ntreeFreeTree(struct bNodeTree *ntree);
305 struct bNodeTree *ntreeCopyTree(struct bNodeTree *ntree);
306 void                    ntreeSwitchID(struct bNodeTree *ntree, struct ID *sce_from, struct ID *sce_to);
307 void                    ntreeMakeLocal(struct bNodeTree *ntree);
308 int                             ntreeHasType(struct bNodeTree *ntree, int type);
309
310 void                    ntreeUpdateTree(struct bNodeTree *ntree);
311 /* XXX Currently each tree update call does call to ntreeVerifyNodes too.
312  * Some day this should be replaced by a decent depsgraph automatism!
313  */
314 void                    ntreeVerifyNodes(struct Main *main, struct ID *id);
315
316 void                    ntreeGetDependencyList(struct bNodeTree *ntree, struct bNode ***deplist, int *totnodes);
317
318 /* XXX old trees handle output flags automatically based on special output node types and last active selection.
319  * new tree types have a per-output socket flag to indicate the final output to use explicitly.
320  */
321 void                    ntreeSetOutput(struct bNodeTree *ntree);
322 void                    ntreeInitPreview(struct bNodeTree *, int xsize, int ysize);
323 void                    ntreeClearPreview(struct bNodeTree *ntree);
324
325 void                    ntreeFreeCache(struct bNodeTree *ntree);
326
327 int                             ntreeNodeExists(struct bNodeTree *ntree, struct bNode *testnode);
328 int                             ntreeOutputExists(struct bNode *node, struct bNodeSocket *testsock);
329 struct bNodeTree *ntreeLocalize(struct bNodeTree *ntree);
330 void                    ntreeLocalSync(struct bNodeTree *localtree, struct bNodeTree *ntree);
331 void                    ntreeLocalMerge(struct bNodeTree *localtree, struct bNodeTree *ntree);
332
333 /* ************** GENERIC API, NODES *************** */
334
335 struct bNodeSocket *nodeAddSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, const char *name, int type);
336 struct bNodeSocket *nodeInsertSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, struct bNodeSocket *next_sock, const char *name, int type);
337 void nodeRemoveSocket(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock);
338 void nodeRemoveAllSockets(struct bNodeTree *ntree, struct bNode *node);
339
340 void                    nodeAddToPreview(struct bNode *, float *, int, int, int);
341
342 struct bNode    *nodeAddNode(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
343 void                    nodeUnlinkNode(struct bNodeTree *ntree, struct bNode *node);
344 void                    nodeUniqueName(struct bNodeTree *ntree, struct bNode *node);
345
346 void                    nodeRegisterType(struct bNodeTreeType *ttype, struct bNodeType *ntype);
347 void                    nodeMakeDynamicType(struct bNode *node);
348 int                             nodeDynamicUnlinkText(struct ID *txtid);
349
350 void                    nodeFreeNode(struct bNodeTree *ntree, struct bNode *node);
351 struct bNode    *nodeCopyNode(struct bNodeTree *ntree, struct bNode *node);
352
353 struct bNodeLink *nodeAddLink(struct bNodeTree *ntree, struct bNode *fromnode, struct bNodeSocket *fromsock, struct bNode *tonode, struct bNodeSocket *tosock);
354 void                    nodeRemLink(struct bNodeTree *ntree, struct bNodeLink *link);
355 void                    nodeRemSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
356
357 void                    nodeSpaceCoords(struct bNode *node, float *locx, float *locy);
358 void                    nodeAttachNode(struct bNode *node, struct bNode *parent);
359 void                    nodeDetachNode(struct bNode *node);
360
361 struct bNode    *nodeFindNodebyName(struct bNodeTree *ntree, const char *name);
362 int                             nodeFindNode(struct bNodeTree *ntree, struct bNodeSocket *sock, struct bNode **nodep, int *sockindex, int *in_out);
363
364 struct bNodeLink *nodeFindLink(struct bNodeTree *ntree, struct bNodeSocket *from, struct bNodeSocket *to);
365 int                             nodeCountSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
366
367 void                    nodeSetActive(struct bNodeTree *ntree, struct bNode *node);
368 struct bNode    *nodeGetActive(struct bNodeTree *ntree);
369 struct bNode    *nodeGetActiveID(struct bNodeTree *ntree, short idtype);
370 int                             nodeSetActiveID(struct bNodeTree *ntree, short idtype, struct ID *id);
371 void                    nodeClearActiveID(struct bNodeTree *ntree, short idtype);
372 struct bNode    *nodeGetActiveTexture(struct bNodeTree *ntree);
373
374 void                    nodeUpdate(struct bNodeTree *ntree, struct bNode *node);
375 int                             nodeUpdateID(struct bNodeTree *ntree, struct ID *id);
376
377 void                    nodeFreePreview(struct bNode *node);
378
379 int                             nodeSocketIsHidden(struct bNodeSocket *sock);
380
381 /* ************** NODE TYPE ACCESS *************** */
382
383 struct bNodeTemplate nodeMakeTemplate(struct bNode *node);
384 int                             nodeValid(struct bNodeTree *ntree, struct bNodeTemplate *ntemp);
385 const char*             nodeLabel(struct bNode *node);
386 struct bNodeTree *nodeGroupEditGet(struct bNode *node);
387 struct bNodeTree *nodeGroupEditSet(struct bNode *node, int edit);
388 void                    nodeGroupEditClear(struct bNode *node);
389
390 /* Init a new node type struct with default values and callbacks */
391 void                    node_type_base(struct bNodeTreeType *ttype, struct bNodeType *ntype, int type,
392                                const char *name, short nclass, short flag);
393 void                    node_type_socket_templates(struct bNodeType *ntype, struct bNodeSocketTemplate *inputs, struct bNodeSocketTemplate *outputs);
394 void                    node_type_size(struct bNodeType *ntype, int width, int minwidth, int maxwidth);
395 void                    node_type_init(struct bNodeType *ntype, void (*initfunc)(struct bNodeTree *ntree, struct bNode *node, struct bNodeTemplate *ntemp));
396 void                    node_type_valid(struct bNodeType *ntype, int (*validfunc)(struct bNodeTree *ntree, struct bNodeTemplate *ntemp));
397 void                    node_type_storage(struct bNodeType *ntype,
398                                                                   const char *storagename,
399                                                                   void (*freestoragefunc)(struct bNode *),
400                                                                   void (*copystoragefunc)(struct bNode *, struct bNode *));
401 void                    node_type_label(struct bNodeType *ntype, const char *(*labelfunc)(struct bNode *));
402 void                    node_type_template(struct bNodeType *ntype, struct bNodeTemplate (*templatefunc)(struct bNode *));
403 void                    node_type_update(struct bNodeType *ntype,
404                                                                  void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node),
405                                                                  void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id));
406 void                    node_type_tree(struct bNodeType *ntype,
407                                                            void (*inittreefunc)(struct bNodeTree *),
408                                                            void (*updatetreefunc)(struct bNodeTree *));
409 void                    node_type_group_edit(struct bNodeType *ntype,
410                                                                          struct bNodeTree *(*group_edit_get)(struct bNode *node),
411                                                                          struct bNodeTree *(*group_edit_set)(struct bNode *node, int edit),
412                                                                          void (*group_edit_clear)(struct bNode *node));
413
414 void                    node_type_exec(struct bNodeType *ntype, void (*execfunc)(void *data, struct bNode *, struct bNodeStack **,
415                                                                          struct bNodeStack **));
416 void                    node_type_exec_new(struct bNodeType *ntype,
417                                                                    void *(*initexecfunc)(struct bNode *node),
418                                                                    void (*freeexecfunc)(struct bNode *node, void *nodedata),
419                                                                    void (*newexecfunc)(void *data, int thread, struct bNode *, void *nodedata,
420                                                                                        struct bNodeStack **, struct bNodeStack **));
421 void                    node_type_mute(struct bNodeType *ntype,
422                                void (*mutefunc)(void *data, int thread, struct bNode *, void *nodedata,
423                                                 struct bNodeStack **, struct bNodeStack **),
424                                ListBase (*mutelinksfunc)(struct bNodeTree *, struct bNode *, struct bNodeStack **,
425                                                          struct bNodeStack **, struct GPUNodeStack*, struct GPUNodeStack*));
426 void                    node_type_gpu(struct bNodeType *ntype, int (*gpufunc)(struct GPUMaterial *mat, struct bNode *node,
427                                                                       struct GPUNodeStack *in, struct GPUNodeStack *out));
428 void                    node_type_gpu_ext(struct bNodeType *ntype, int (*gpuextfunc)(struct GPUMaterial *mat, struct bNode *node,
429                                                                              void *nodedata, struct GPUNodeStack *in,
430                                                                              struct GPUNodeStack *out));
431 void                    node_type_gpu_mute(struct bNodeType *ntype, int (*gpumutefunc)(struct GPUMaterial *, struct bNode *, void *,
432                                                                                struct GPUNodeStack *, struct GPUNodeStack *));
433 void                    node_type_compatibility(struct bNodeType *ntype, short compatibility);
434
435 /* ************** COMMON NODES *************** */
436
437 #define NODE_GROUP              2
438 #define NODE_FORLOOP    3
439 #define NODE_WHILELOOP  4
440 #define NODE_FRAME              5
441 #define NODE_GROUP_MENU         10000
442 #define NODE_DYNAMIC_MENU       20000
443
444 /* look up a socket on a group node by the internal group socket */
445 struct bNodeSocket *node_group_find_input(struct bNode *gnode, struct bNodeSocket *gsock);
446 struct bNodeSocket *node_group_find_output(struct bNode *gnode, struct bNodeSocket *gsock);
447
448 struct bNodeSocket *node_group_add_socket(struct bNodeTree *ngroup, const char *name, int type, int in_out);
449 struct bNodeSocket *node_group_expose_socket(struct bNodeTree *ngroup, struct bNodeSocket *sock, int in_out);
450 void node_group_expose_all_sockets(struct bNodeTree *ngroup);
451 void node_group_remove_socket(struct bNodeTree *ngroup, struct bNodeSocket *gsock, int in_out);
452
453 struct bNode    *node_group_make_from_selected(struct bNodeTree *ntree);
454 int                             node_group_ungroup(struct bNodeTree *ntree, struct bNode *gnode);
455
456 /* in node_common.c */
457 void register_node_type_frame(struct bNodeTreeType *ttype);
458
459 /* ************** SHADER NODES *************** */
460
461 struct ShadeInput;
462 struct ShadeResult;
463
464 /* note: types are needed to restore callbacks, don't change values */
465 /* range 1 - 100 is reserved for common nodes */
466 /* using toolbox, we add node groups by assuming the values below don't exceed NODE_GROUP_MENU for now */
467
468 #define SH_NODE_OUTPUT          1
469
470 #define SH_NODE_MATERIAL        100
471 #define SH_NODE_RGB                     101
472 #define SH_NODE_VALUE           102
473 #define SH_NODE_MIX_RGB         103
474 #define SH_NODE_VALTORGB        104
475 #define SH_NODE_RGBTOBW         105
476 #define SH_NODE_TEXTURE         106
477 #define SH_NODE_NORMAL          107
478 #define SH_NODE_GEOMETRY        108
479 #define SH_NODE_MAPPING         109
480 #define SH_NODE_CURVE_VEC       110
481 #define SH_NODE_CURVE_RGB       111
482 #define SH_NODE_CAMERA          114
483 #define SH_NODE_MATH            115
484 #define SH_NODE_VECT_MATH       116
485 #define SH_NODE_SQUEEZE         117
486 #define SH_NODE_MATERIAL_EXT    118
487 #define SH_NODE_INVERT          119
488 #define SH_NODE_SEPRGB          120
489 #define SH_NODE_COMBRGB         121
490 #define SH_NODE_HUE_SAT         122
491 #define NODE_DYNAMIC            123
492
493 #define SH_NODE_OUTPUT_MATERIAL                 124
494 #define SH_NODE_OUTPUT_WORLD                    125
495 #define SH_NODE_OUTPUT_LAMP                             126
496 #define SH_NODE_FRESNEL                                 127
497 #define SH_NODE_MIX_SHADER                              128
498 #define SH_NODE_ATTRIBUTE                               129
499 #define SH_NODE_BACKGROUND                              130
500 #define SH_NODE_BSDF_ANISOTROPIC                131
501 #define SH_NODE_BSDF_DIFFUSE                    132
502 #define SH_NODE_BSDF_GLOSSY                             133
503 #define SH_NODE_BSDF_GLASS                              134
504 #define SH_NODE_BSDF_TRANSLUCENT                137
505 #define SH_NODE_BSDF_TRANSPARENT                138
506 #define SH_NODE_BSDF_VELVET                             139
507 #define SH_NODE_EMISSION                                140
508 #define SH_NODE_NEW_GEOMETRY                    141
509 #define SH_NODE_LIGHT_PATH                              142
510 #define SH_NODE_TEX_IMAGE                               143
511 #define SH_NODE_TEX_SKY                                 145
512 #define SH_NODE_TEX_GRADIENT                    146
513 #define SH_NODE_TEX_VORONOI                             147
514 #define SH_NODE_TEX_MAGIC                               148
515 #define SH_NODE_TEX_WAVE                                149
516 #define SH_NODE_TEX_NOISE                               150
517 #define SH_NODE_TEX_MUSGRAVE                    152
518 #define SH_NODE_TEX_COORD                               155
519 #define SH_NODE_ADD_SHADER                              156
520 #define SH_NODE_TEX_ENVIRONMENT                 157
521 #define SH_NODE_OUTPUT_TEXTURE                  158
522 #define SH_NODE_HOLDOUT                                 159
523 #define SH_NODE_LAYER_WEIGHT                    160
524 #define SH_NODE_VOLUME_TRANSPARENT              161
525 #define SH_NODE_VOLUME_ISOTROPIC                162
526 #define SH_NODE_GAMMA                           163
527 #define SH_NODE_TEX_CHECKER                     164
528 #define SH_NODE_BRIGHTCONTRAST                  165
529
530 /* custom defines options for Material node */
531 #define SH_NODE_MAT_DIFF   1
532 #define SH_NODE_MAT_SPEC   2
533 #define SH_NODE_MAT_NEG    4
534 /* custom defines: states for Script node. These are bit indices */
535 #define NODE_DYNAMIC_READY      0 /* 1 */
536 #define NODE_DYNAMIC_LOADED     1 /* 2 */
537 #define NODE_DYNAMIC_NEW        2 /* 4 */
538 #define NODE_DYNAMIC_UPDATED    3 /* 8 */
539 #define NODE_DYNAMIC_ADDEXIST   4 /* 16 */
540 #define NODE_DYNAMIC_ERROR      5 /* 32 */
541 #define NODE_DYNAMIC_REPARSE    6 /* 64 */
542 #define NODE_DYNAMIC_SET        15 /* sign */
543
544 /* API */
545
546 struct bNodeTreeExec *ntreeShaderBeginExecTree(struct bNodeTree *ntree, int use_tree_data);
547 void                    ntreeShaderEndExecTree(struct bNodeTreeExec *exec, int use_tree_data);
548 void                    ntreeShaderExecTree(struct bNodeTree *ntree, struct ShadeInput *shi, struct ShadeResult *shr);
549 void                    ntreeShaderGetTexcoMode(struct bNodeTree *ntree, int osa, short *texco, int *mode);
550 void                    nodeShaderSynchronizeID(struct bNode *node, int copyto);
551
552                                 /* switch material render loop */
553 extern void (*node_shader_lamp_loop)(struct ShadeInput *, struct ShadeResult *);
554 void                    set_node_shader_lamp_loop(void (*lamp_loop_func)(struct ShadeInput *, struct ShadeResult *));
555
556 void                    ntreeGPUMaterialNodes(struct bNodeTree *ntree, struct GPUMaterial *mat);
557
558
559 /* ************** COMPOSITE NODES *************** */
560
561 /* output socket defines */
562 #define RRES_OUT_IMAGE                          0
563 #define RRES_OUT_ALPHA                          1
564 #define RRES_OUT_Z                                      2
565 #define RRES_OUT_NORMAL                         3
566 #define RRES_OUT_UV                                     4
567 #define RRES_OUT_VEC                            5
568 #define RRES_OUT_RGBA                           6
569 #define RRES_OUT_DIFF                           7
570 #define RRES_OUT_SPEC                           8
571 #define RRES_OUT_SHADOW                         9
572 #define RRES_OUT_AO                                     10
573 #define RRES_OUT_REFLECT                        11
574 #define RRES_OUT_REFRACT                        12
575 #define RRES_OUT_INDIRECT                       13
576 #define RRES_OUT_INDEXOB                        14
577 #define RRES_OUT_INDEXMA                        15
578 #define RRES_OUT_MIST                           16
579 #define RRES_OUT_EMIT                           17
580 #define RRES_OUT_ENV                            18
581 #define RRES_OUT_DIFF_DIRECT            19
582 #define RRES_OUT_DIFF_INDIRECT          20
583 #define RRES_OUT_DIFF_COLOR                     21
584 #define RRES_OUT_GLOSSY_DIRECT          22
585 #define RRES_OUT_GLOSSY_INDIRECT        23
586 #define RRES_OUT_GLOSSY_COLOR           24
587 #define RRES_OUT_TRANSM_DIRECT          25
588 #define RRES_OUT_TRANSM_INDIRECT        26
589 #define RRES_OUT_TRANSM_COLOR           27
590
591 /* note: types are needed to restore callbacks, don't change values */
592 #define CMP_NODE_VIEWER         201
593 #define CMP_NODE_RGB            202
594 #define CMP_NODE_VALUE          203
595 #define CMP_NODE_MIX_RGB        204
596 #define CMP_NODE_VALTORGB       205
597 #define CMP_NODE_RGBTOBW        206
598 #define CMP_NODE_NORMAL         207
599 #define CMP_NODE_CURVE_VEC      208
600 #define CMP_NODE_CURVE_RGB      209
601 #define CMP_NODE_ALPHAOVER      210
602 #define CMP_NODE_BLUR           211
603 #define CMP_NODE_FILTER         212
604 #define CMP_NODE_MAP_VALUE      213
605 #define CMP_NODE_TIME           214
606 #define CMP_NODE_VECBLUR        215
607 #define CMP_NODE_SEPRGBA        216
608 #define CMP_NODE_SEPHSVA        217
609 #define CMP_NODE_SETALPHA       218
610 #define CMP_NODE_HUE_SAT        219
611 #define CMP_NODE_IMAGE          220
612 #define CMP_NODE_R_LAYERS       221
613 #define CMP_NODE_COMPOSITE      222
614 #define CMP_NODE_OUTPUT_FILE    223
615 #define CMP_NODE_TEXTURE        224
616 #define CMP_NODE_TRANSLATE      225
617 #define CMP_NODE_ZCOMBINE       226
618 #define CMP_NODE_COMBRGBA       227
619 #define CMP_NODE_DILATEERODE    228
620 #define CMP_NODE_ROTATE         229
621 #define CMP_NODE_SCALE          230
622 #define CMP_NODE_SEPYCCA        231
623 #define CMP_NODE_COMBYCCA       232
624 #define CMP_NODE_SEPYUVA        233
625 #define CMP_NODE_COMBYUVA       234
626 #define CMP_NODE_DIFF_MATTE     235
627 #define CMP_NODE_COLOR_SPILL    236
628 #define CMP_NODE_CHROMA_MATTE   237
629 #define CMP_NODE_CHANNEL_MATTE  238
630 #define CMP_NODE_FLIP           239
631 #define CMP_NODE_SPLITVIEWER    240
632 #define CMP_NODE_INDEX_MASK     241
633 #define CMP_NODE_MAP_UV         242
634 #define CMP_NODE_ID_MASK        243
635 #define CMP_NODE_DEFOCUS        244
636 #define CMP_NODE_DISPLACE       245
637 #define CMP_NODE_COMBHSVA       246
638 #define CMP_NODE_MATH           247
639 #define CMP_NODE_LUMA_MATTE     248
640 #define CMP_NODE_BRIGHTCONTRAST 249
641 #define CMP_NODE_GAMMA          250
642 #define CMP_NODE_INVERT         251
643 #define CMP_NODE_NORMALIZE      252
644 #define CMP_NODE_CROP           253
645 #define CMP_NODE_DBLUR          254
646 #define CMP_NODE_BILATERALBLUR  255
647 #define CMP_NODE_PREMULKEY  256
648 #define CMP_NODE_DIST_MATTE     257
649 #define CMP_NODE_VIEW_LEVELS    258
650 #define CMP_NODE_COLOR_MATTE 259
651 #define CMP_NODE_COLORBALANCE 260
652 #define CMP_NODE_HUECORRECT 261
653 #define CMP_NODE_MOVIECLIP      262
654 #define CMP_NODE_STABILIZE2D    263
655 #define CMP_NODE_TRANSFORM      264
656 #define CMP_NODE_MOVIEDISTORTION        265
657 #define CMP_NODE_DOUBLEEDGEMASK    266
658 #define CMP_NODE_OUTPUT_MULTI_FILE      267
659
660 #define CMP_NODE_GLARE          301
661 #define CMP_NODE_TONEMAP        302
662 #define CMP_NODE_LENSDIST       303
663
664 /* channel toggles */
665 #define CMP_CHAN_RGB            1
666 #define CMP_CHAN_A                      2
667 #define CMP_CHAN_R                      4
668 #define CMP_CHAN_G                      8
669 #define CMP_CHAN_B                      16
670
671 /* filter types */
672 #define CMP_FILT_SOFT           0
673 #define CMP_FILT_SHARP          1
674 #define CMP_FILT_LAPLACE        2
675 #define CMP_FILT_SOBEL          3
676 #define CMP_FILT_PREWITT        4
677 #define CMP_FILT_KIRSCH         5
678 #define CMP_FILT_SHADOW         6
679
680 /* scale node type, in custom1 */
681 #define CMP_SCALE_RELATIVE              0
682 #define CMP_SCALE_ABSOLUTE              1
683 #define CMP_SCALE_SCENEPERCENT  2
684 #define CMP_SCALE_RENDERPERCENT 3
685
686
687 /* API */
688 struct CompBuf;
689 struct bNodeTreeExec *ntreeCompositBeginExecTree(struct bNodeTree *ntree, int use_tree_data);
690 void ntreeCompositEndExecTree(struct bNodeTreeExec *exec, int use_tree_data);
691 void ntreeCompositExecTree(struct bNodeTree *ntree, struct RenderData *rd, int do_previews);
692 void ntreeCompositTagRender(struct Scene *sce);
693 int ntreeCompositTagAnimated(struct bNodeTree *ntree);
694 void ntreeCompositTagGenerators(struct bNodeTree *ntree);
695 void ntreeCompositForceHidden(struct bNodeTree *ntree, struct Scene *scene);
696 void ntreeCompositClearTags(struct bNodeTree *ntree);
697
698 void ntreeCompositOutputMultiFileAddSocket(struct bNodeTree *ntree, struct bNode *node, struct ImageFormatData *im_format);
699 int ntreeCompositOutputMultiFileRemoveActiveSocket(struct bNodeTree *ntree, struct bNode *node);
700
701 /* ************** TEXTURE NODES *************** */
702
703 struct TexResult;
704
705 #define TEX_NODE_OUTPUT     401
706 #define TEX_NODE_CHECKER    402
707 #define TEX_NODE_TEXTURE    403
708 #define TEX_NODE_BRICKS     404
709 #define TEX_NODE_MATH       405
710 #define TEX_NODE_MIX_RGB    406
711 #define TEX_NODE_RGBTOBW    407
712 #define TEX_NODE_VALTORGB   408
713 #define TEX_NODE_IMAGE      409
714 #define TEX_NODE_CURVE_RGB  410
715 #define TEX_NODE_INVERT     411
716 #define TEX_NODE_HUE_SAT    412
717 #define TEX_NODE_CURVE_TIME 413
718 #define TEX_NODE_ROTATE     414
719 #define TEX_NODE_VIEWER     415
720 #define TEX_NODE_TRANSLATE  416
721 #define TEX_NODE_COORD      417
722 #define TEX_NODE_DISTANCE   418
723 #define TEX_NODE_COMPOSE    419
724 #define TEX_NODE_DECOMPOSE  420
725 #define TEX_NODE_VALTONOR   421
726 #define TEX_NODE_SCALE      422
727 #define TEX_NODE_AT         423
728
729 /* 501-599 reserved. Use like this: TEX_NODE_PROC + TEX_CLOUDS, etc */
730 #define TEX_NODE_PROC      500
731 #define TEX_NODE_PROC_MAX  600
732
733 /* API */
734 int  ntreeTexTagAnimated(struct bNodeTree *ntree);
735 void ntreeTexSetPreviewFlag(int);
736 void ntreeTexCheckCyclics(struct bNodeTree *ntree);
737 char* ntreeTexOutputMenu(struct bNodeTree *ntree);
738
739 struct bNodeTreeExec *ntreeTexBeginExecTree(struct bNodeTree *ntree, int use_tree_data);
740 void ntreeTexEndExecTree(struct bNodeTreeExec *exec, int use_tree_data);
741 int ntreeTexExecTree(struct bNodeTree *ntree, struct TexResult *target, float *coord, float *dxt, float *dyt, int osatex, short thread, struct Tex *tex, short which_output, int cfra, int preview, struct ShadeInput *shi, struct MTex *mtex);
742
743
744 /*************************************************/
745
746 void init_nodesystem(void);
747 void free_nodesystem(void);
748
749 void clear_scene_in_nodes(struct Main *bmain, struct Scene *sce);
750
751 #endif