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