4bbd1e2097335e2577816607d3f87ece041726a7
[blender.git] / source / blender / makesdna / DNA_node_types.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, Xavier Thomas
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_node_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_NODE_TYPES_H__
33 #define __DNA_NODE_TYPES_H__
34
35 #include "DNA_ID.h"
36 #include "DNA_vec_types.h"
37 #include "DNA_listBase.h"
38 #include "DNA_texture_types.h"
39 #include "DNA_scene_types.h"
40
41 struct ID;
42 struct ListBase;
43 struct SpaceNode;
44 struct bNodeLink;
45 struct bNodeType;
46 struct bNodeTreeExec;
47 struct AnimData;
48 struct bGPdata;
49 struct uiBlock;
50 struct Image;
51
52 #define NODE_MAXSTR 64
53
54 typedef struct bNodeStack {
55         float vec[4];
56         float min, max;
57         void *data;
58         short hasinput;                 /* when input has link, tagged before executing */
59         short hasoutput;                /* when output is linked, tagged before executing */
60         short datatype;                 /* type of data pointer */
61         short sockettype;               /* type of socket stack comes from, to remap linking different sockets */
62         short is_copy;                  /* data is a copy of external data (no freeing) */
63         short external;                 /* data is used by external nodes (no freeing) */
64         short pad[2];
65 } bNodeStack;
66
67 /* ns->datatype, shadetree only */
68 #define NS_OSA_VECTORS          1
69 #define NS_OSA_VALUES           2
70
71 /* node socket/node socket type -b conversion rules */
72 #define NS_CR_CENTER            0
73 #define NS_CR_NONE                      1
74 #define NS_CR_FIT_WIDTH         2
75 #define NS_CR_FIT_HEIGHT        3
76 #define NS_CR_FIT                       4
77 #define NS_CR_STRETCH           5
78
79 typedef struct bNodeSocket {
80         struct bNodeSocket *next, *prev, *new_sock;
81         
82         char name[64];  /* MAX_NAME */
83         
84         void *storage;                          /* custom storage */
85         
86         short type, flag;
87         short limit;                            /* max. number of links */
88         short pad1;
89         
90         float locx, locy;
91         
92         void *default_value;            /* default input value used for unlinked sockets */
93         
94         /* execution data */
95         short stack_index;                      /* local stack index */
96         /* XXX deprecated, kept for forward compatibility */
97         short stack_type  DNA_DEPRECATED;
98         int resizemode;                         /* compositor resize mode of the socket */
99         void *cache;                            /* cached data from execution */
100         
101         /* internal data to retrieve relations and groups */
102         int own_index;                          /* group socket identifiers, to find matching pairs after reading files */
103         /* XXX deprecated, only used for restoring old group node links */
104         int to_index  DNA_DEPRECATED;
105         struct bNodeSocket *groupsock;
106         
107         struct bNodeLink *link;         /* a link pointer, set in ntreeUpdateTree */
108
109         /* XXX deprecated, socket input values are stored in default_value now. kept for forward compatibility */
110         bNodeStack ns  DNA_DEPRECATED;  /* custom data for inputs, only UI writes in this */
111 } bNodeSocket;
112
113 /* sock->type */
114 #define SOCK_FLOAT                      0
115 #define SOCK_VECTOR                     1
116 #define SOCK_RGBA                       2
117 #define SOCK_SHADER                     3
118 #define SOCK_BOOLEAN            4
119 #define SOCK_MESH                       5
120 #define SOCK_INT                        6
121 #define NUM_SOCKET_TYPES        7       /* must be last! */
122
123 /* socket side (input/output) */
124 #define SOCK_IN         1
125 #define SOCK_OUT        2
126
127 /* sock->flag, first bit is select */
128         /* hidden is user defined, to hide unused */
129 #define SOCK_HIDDEN                             2
130         /* only used now for groups... */
131 #define SOCK_IN_USE                             4       /* XXX deprecated */
132         /* unavailable is for dynamic sockets */
133 #define SOCK_UNAVAIL                    8
134         /* dynamic socket (can be modified by user) */
135 #define SOCK_DYNAMIC                    16
136         /* group socket should not be exposed */
137 #define SOCK_INTERNAL                   32
138         /* socket collapsed in UI */
139 #define SOCK_COLLAPSED                  64
140         /* hide socket value, if it gets auto default */
141 #define SOCK_HIDE_VALUE                 128
142         /* socket hidden automatically, to distinguish from manually hidden */
143         /* DEPRECATED, only kept here to avoid reusing the flag */
144 #define SOCK_AUTO_HIDDEN__DEPRECATED    256
145
146 typedef struct bNodePreview {
147         unsigned char *rect;
148         short xsize, ysize;
149         int pad;
150 } bNodePreview;
151
152 /* limit data in bNode to what we want to see saved? */
153 typedef struct bNode {
154         struct bNode *next, *prev, *new_node;
155         
156         char name[64];  /* MAX_NAME */
157         short type, flag;
158         short done, level;              /* both for dependency and sorting */
159         short lasty, menunr;    /* lasty: check preview render status, menunr: browse ID blocks */
160         short stack_index;              /* for groupnode, offset in global caller stack */
161         short nr;                               /* number of this node in list, used for UI exec events */
162         
163         ListBase inputs, outputs;
164         struct bNode *parent;   /* parent node */
165         struct ID *id;                  /* optional link to libdata */
166         void *storage;                  /* custom data, must be struct, for storage in file */
167         
168         float locx, locy;               /* root offset for drawing */
169         float width, height;    /* node custom width and height */
170         float miniwidth;                /* node width if hidden */
171         
172         int update;                             /* update flags */
173         
174         char label[64];                 /* custom user-defined label, MAX_NAME */
175         short custom1, custom2; /* to be abused for buttons */
176         float custom3, custom4;
177         
178         short need_exec, exec;  /* need_exec is set as UI execution event, exec is flag during exec */
179         void *threaddata;               /* optional extra storage for use in thread (read only then!) */
180         
181         rctf totr;                              /* entire boundbox */
182         rctf butr;                              /* optional buttons area */
183         rctf prvr;                              /* optional preview area */
184         bNodePreview *preview;  /* optional preview image */
185         struct uiBlock *block;  /* runtime during drawing */
186         
187         struct bNodeType *typeinfo;     /* lookup of callbacks and defaults */
188 } bNode;
189
190 /* node->flag */
191 #define NODE_SELECT                     1
192 #define NODE_OPTIONS            2
193 #define NODE_PREVIEW            4
194 #define NODE_HIDDEN                     8
195 #define NODE_ACTIVE                     16
196 #define NODE_ACTIVE_ID          32
197 #define NODE_DO_OUTPUT          64
198 #define NODE_GROUP_EDIT         128
199         /* free test flag, undefined */
200 #define NODE_TEST                       256
201         /* node is disabled */
202 #define NODE_MUTED                      512
203 #define NODE_CUSTOM_NAME        1024    /* deprecated! */
204         /* group node types: use const outputs by default */
205 #define NODE_CONST_OUTPUT       (1<<11)
206         /* node is always behind others */
207 #define NODE_BACKGROUND         (1<<12)
208         /* automatic flag for nodes included in transforms */
209 #define NODE_TRANSFORM          (1<<13)
210         /* node is active texture */
211 #define NODE_ACTIVE_TEXTURE     (1<<14)
212
213 /* node->update */
214 /* XXX NODE_UPDATE is a generic update flag. More fine-grained updates
215  * might be used in the future, but currently all work the same way.
216  */
217 #define NODE_UPDATE                     0xFFFF  /* generic update flag (includes all others) */
218 #define NODE_UPDATE_ID          1               /* associated id data block has changed */
219
220 typedef struct bNodeLink {
221         struct bNodeLink *next, *prev;
222         
223         bNode *fromnode, *tonode;
224         bNodeSocket *fromsock, *tosock;
225         
226         int flag;
227         int pad;
228 } bNodeLink;
229
230 /* link->flag */
231 #define NODE_LINKFLAG_HILITE    1               /* link has been successfully validated */
232 #define NODE_LINK_VALID                 2
233
234 /* tree->edit_quality/tree->render_quality */
235 #define NTREE_QUALITY_HIGH    0
236 #define NTREE_QUALITY_MEDIUM  1
237 #define NTREE_QUALITY_LOW     2
238
239 /* the basis for a Node tree, all links and nodes reside internal here */
240 /* only re-usable node trees are in the library though, materials and textures allocate own tree struct */
241 typedef struct bNodeTree {
242         ID id;
243         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */ 
244         
245         struct bGPdata *gpd;            /* grease pencil data */
246         
247         ListBase nodes, links;
248         
249         int type, init;                                 /* set init on fileread */
250         int cur_index;                                  /* sockets in groups have unique identifiers, adding new sockets always 
251                                                                          * will increase this counter */
252         int flag;
253         int update;                                             /* update flags */
254         
255         int nodetype;                                   /* specific node type this tree is used for */
256
257         short edit_quality;                             /* Quality setting when editing */
258         short render_quality;                           /* Quality setting when rendering */
259         int chunksize;                                  /* tile size for compositor engine */
260         
261         ListBase inputs, outputs;               /* external sockets for group nodes */
262         
263         /* execution data */
264         /* XXX It would be preferable to completely move this data out of the underlying node tree,
265          * so node tree execution could finally run independent of the tree itself. This would allow node trees
266          * to be merely linked by other data (materials, textures, etc.), as ID data is supposed to.
267          * Execution data is generated from the tree once at execution start and can then be used
268          * as long as necessary, even while the tree is being modified.
269          */
270         struct bNodeTreeExec *execdata;
271         
272         /* callbacks */
273         void (*progress)(void *, float progress);
274         void (*stats_draw)(void *, char *str);
275         int (*test_break)(void *);
276         void *tbh, *prh, *sdh;
277         
278 } bNodeTree;
279
280 /* ntree->type, index */
281 #define NTREE_SHADER            0
282 #define NTREE_COMPOSIT          1
283 #define NTREE_TEXTURE           2
284 #define NUM_NTREE_TYPES         3
285
286 /* ntree->init, flag */
287 #define NTREE_TYPE_INIT         1
288
289 /* ntree->flag */
290 #define NTREE_DS_EXPAND         1       /* for animation editors */
291 #define NTREE_COM_OPENCL        2       /* use opencl */
292 /* XXX not nice, but needed as a temporary flags
293  * for group updates after library linking.
294  */
295 #define NTREE_DO_VERSIONS_GROUP_EXPOSE  1024
296
297 /* ntree->update */
298 #define NTREE_UPDATE                    0xFFFF  /* generic update flag (includes all others) */
299 #define NTREE_UPDATE_LINKS              1               /* links have been added or removed */
300 #define NTREE_UPDATE_NODES              2               /* nodes or sockets have been added or removed */
301 #define NTREE_UPDATE_GROUP_IN   16              /* group inputs have changed */
302 #define NTREE_UPDATE_GROUP_OUT  32              /* group outputs have changed */
303 #define NTREE_UPDATE_GROUP              48              /* group has changed (generic flag including all other group flags) */
304
305
306 /* socket value structs for input buttons */
307
308 typedef struct bNodeSocketValueInt {
309         int subtype;                            /* RNA subtype */
310         int value;
311         int min, max;
312 } bNodeSocketValueInt;
313
314 typedef struct bNodeSocketValueFloat {
315         int subtype;                            /* RNA subtype */
316         float value;
317         float min, max;
318 } bNodeSocketValueFloat;
319
320 typedef struct bNodeSocketValueBoolean {
321         char value;
322         char pad[3];
323 } bNodeSocketValueBoolean;
324
325 typedef struct bNodeSocketValueVector {
326         int subtype;                            /* RNA subtype */
327         float value[3];
328         float min, max;
329 } bNodeSocketValueVector;
330
331 typedef struct bNodeSocketValueRGBA {
332         float value[4];
333 } bNodeSocketValueRGBA;
334
335
336 /* data structs, for node->storage */
337
338 #define CMP_NODE_MASKTYPE_ADD           0
339 #define CMP_NODE_MASKTYPE_SUBTRACT      1
340 #define CMP_NODE_MASKTYPE_MULTIPLY      2
341 #define CMP_NODE_MASKTYPE_NOT           3
342
343 #define CMP_NODE_LENSFLARE_GHOST   1
344 #define CMP_NODE_LENSFLARE_GLOW    2
345 #define CMP_NODE_LENSFLARE_CIRCLE  4
346 #define CMP_NODE_LENSFLARE_STREAKS 8
347
348 /* this one has been replaced with ImageUser, keep it for do_versions() */
349 typedef struct NodeImageAnim {
350         int frames, sfra, nr;
351         char cyclic, movie;
352         short pad;
353 } NodeImageAnim;
354
355 typedef struct ColorCorrectionData {
356         float saturation;
357         float contrast;
358         float gamma;
359         float gain;
360         float lift;
361         int pad;
362 } ColorCorrectionData;
363
364 typedef struct NodeColorCorrection {
365         ColorCorrectionData master;
366         ColorCorrectionData shadows;
367         ColorCorrectionData midtones;
368         ColorCorrectionData highlights;
369         float startmidtones;
370         float endmidtones;
371 } NodeColorCorrection;
372
373 typedef struct NodeBokehImage {
374         float angle;
375         int flaps;
376         float rounding;
377         float catadioptric;
378         float lensshift;
379 } NodeBokehImage;
380
381 typedef struct NodeBoxMask {
382         float x;
383         float y;
384         float rotation;
385         float height;
386         float width;
387         int pad;
388 } NodeBoxMask;
389
390 typedef struct NodeEllipseMask {
391         float x;
392         float y;
393         float rotation;
394         float height;
395         float width;
396         int pad;
397 } NodeEllipseMask;
398
399 /* layer info for image node outputs */
400 typedef struct NodeImageLayer {
401         /* index in the Image->layers->passes lists */
402         int pass_index;
403         /* render pass flag, in case this is an original render pass */
404         int pass_flag;
405 } NodeImageLayer;
406
407 typedef struct NodeBlurData {
408         short sizex, sizey;
409         short samples, maxspeed, minspeed, relative, aspect;
410         short curved;
411         float fac, percentx, percenty;
412         short filtertype;
413         char bokeh, gamma;
414         int image_in_width, image_in_height; /* needed for absolute/relative conversions */
415 } NodeBlurData;
416
417 typedef struct NodeDBlurData {
418         float center_x, center_y, distance, angle, spin, zoom;
419         short iter;
420         char wrap, pad;
421 } NodeDBlurData;
422
423 typedef struct NodeBilateralBlurData {
424         float sigma_color, sigma_space;
425         short iter, pad;
426 } NodeBilateralBlurData;
427
428 typedef struct NodeHueSat {
429         float hue, sat, val;
430 } NodeHueSat;
431
432 typedef struct NodeImageFile {
433         char name[1024]; /* 1024 = FILE_MAX */
434         struct ImageFormatData im_format;
435         int sfra, efra;
436 } NodeImageFile;
437
438 /* XXX first struct fields should match NodeImageFile to ensure forward compatibility */
439 typedef struct NodeImageMultiFile {
440         char base_path[1024];   /* 1024 = FILE_MAX */
441         ImageFormatData format;
442         int sfra DNA_DEPRECATED, efra DNA_DEPRECATED;   /* XXX old frame rand values from NodeImageFile for forward compatibility */
443         int active_input;               /* selected input in details view list */
444         int pad;
445 } NodeImageMultiFile;
446 typedef struct NodeImageMultiFileSocket {
447         /* single layer file output */
448         short use_render_format  DNA_DEPRECATED;
449         short use_node_format;  /* use overall node image format */
450         int pad1;
451         char path[1024];                /* 1024 = FILE_MAX */
452         ImageFormatData format;
453         
454         /* multilayer output */
455         char layer[30];         /* EXR_TOT_MAXNAME-2 ('.' and channel char are appended) */
456         char pad2[2];
457 } NodeImageMultiFileSocket;
458
459 typedef struct NodeChroma {
460         float t1, t2, t3;
461         float fsize, fstrength, falpha;
462         float key[4];
463         short algorithm, channel;
464 } NodeChroma;
465
466 typedef struct NodeTwoXYs {
467         short x1, x2, y1, y2;
468         float fac_x1, fac_x2, fac_y1, fac_y2;
469 } NodeTwoXYs;
470
471 typedef struct NodeTwoFloats {
472         float x, y;
473 } NodeTwoFloats;
474
475 typedef struct NodeGeometry {
476         char uvname[64];        /* MAX_CUSTOMDATA_LAYER_NAME */
477         char colname[64];
478 } NodeGeometry;
479
480 typedef struct NodeVertexCol {
481         char name[64];
482 } NodeVertexCol;
483
484 /* qdn: Defocus blur node */
485 typedef struct NodeDefocus {
486         char bktype, pad_c1, preview, gamco;
487         short samples, no_zbuf;
488         float fstop, maxblur, bthresh, scale;
489         float rotation, pad_f1;
490 } NodeDefocus;
491
492 typedef struct NodeScriptDict {
493         void *dict; /* for PyObject *dict */
494         void *node; /* for BPy_Node *node */
495 } NodeScriptDict;
496
497 /* qdn: glare node */
498 typedef struct NodeGlare {
499         char quality, type, iter;
500         char angle, pad_c1, size, pad[2];
501         float colmod, mix, threshold, fade;
502         float angle_ofs, pad_f1;
503 } NodeGlare;
504
505 /* qdn: tonemap node */
506 typedef struct NodeTonemap {
507         float key, offset, gamma;
508         float f, m, a, c;
509         int type;
510 } NodeTonemap;
511
512 /* qdn: lens distortion node */
513 typedef struct NodeLensDist {
514         short jit, proj, fit, pad;
515 } NodeLensDist;
516
517 typedef struct NodeColorBalance {
518         /* for processing */
519         float slope[3];
520         float offset[3];
521         float power[3];
522         
523         /* for ui representation */
524         float lift[3];
525         float gamma[3];
526         float gain[3];
527
528         /* temp storage for inverted lift */
529         float lift_lgg[3];
530         float gamma_inv[3];
531 } NodeColorBalance;
532
533 typedef struct NodeColorspill {
534         short limchan, unspill;
535         float limscale;
536         float uspillr, uspillg, uspillb;
537 } NodeColorspill;
538
539 typedef struct NodeTexBase {
540         TexMapping tex_mapping;
541         ColorMapping color_mapping;
542 } NodeTexBase;
543
544 typedef struct NodeTexSky {
545         NodeTexBase base;
546         float sun_direction[3];
547         float turbidity;
548 } NodeTexSky;
549
550 typedef struct NodeTexImage {
551         NodeTexBase base;
552         int color_space, pad;
553 } NodeTexImage;
554
555 typedef struct NodeTexChecker {
556         NodeTexBase base;
557 } NodeTexChecker;
558
559 typedef struct NodeTexEnvironment {
560         NodeTexBase base;
561         int color_space, projection;
562 } NodeTexEnvironment;
563
564 typedef struct NodeTexGradient {
565         NodeTexBase base;
566         int gradient_type;
567         int pad;
568 } NodeTexGradient;
569
570 typedef struct NodeTexNoise {
571         NodeTexBase base;
572 } NodeTexNoise;
573
574 typedef struct NodeTexVoronoi {
575         NodeTexBase base;
576         int coloring;
577         int pad;
578 } NodeTexVoronoi;
579
580 typedef struct NodeTexMusgrave {
581         NodeTexBase base;
582         int musgrave_type;
583         int pad;
584 } NodeTexMusgrave;
585
586 typedef struct NodeTexWave {
587         NodeTexBase base;
588         int wave_type;
589         int pad;
590 } NodeTexWave;
591
592 typedef struct NodeTexMagic {
593         NodeTexBase base;
594         int depth;
595         int pad;
596 } NodeTexMagic;
597
598 typedef struct NodeShaderAttribute {
599         char name[64];
600 } NodeShaderAttribute;
601
602 /* TEX_output */
603 typedef struct TexNodeOutput {
604         char name[64];
605 } TexNodeOutput;
606
607 /* comp channel matte */
608 #define CMP_NODE_CHANNEL_MATTE_CS_RGB   1
609 #define CMP_NODE_CHANNEL_MATTE_CS_HSV   2
610 #define CMP_NODE_CHANNEL_MATTE_CS_YUV   3
611 #define CMP_NODE_CHANNEL_MATTE_CS_YCC   4
612
613 /* glossy distributions */
614 #define SHD_GLOSSY_BECKMANN     0
615 #define SHD_GLOSSY_SHARP        1
616 #define SHD_GLOSSY_GGX          2
617
618 /* blend texture */
619 #define SHD_BLEND_LINEAR                        0
620 #define SHD_BLEND_QUADRATIC                     1
621 #define SHD_BLEND_EASING                        2
622 #define SHD_BLEND_DIAGONAL                      3
623 #define SHD_BLEND_RADIAL                        4
624 #define SHD_BLEND_QUADRATIC_SPHERE      5
625 #define SHD_BLEND_SPHERICAL                     6
626
627 /* noise basis for textures */
628 #define SHD_NOISE_PERLIN                        0
629 #define SHD_NOISE_VORONOI_F1            1
630 #define SHD_NOISE_VORONOI_F2            2
631 #define SHD_NOISE_VORONOI_F3            3
632 #define SHD_NOISE_VORONOI_F4            4
633 #define SHD_NOISE_VORONOI_F2_F1         5
634 #define SHD_NOISE_VORONOI_CRACKLE       6
635 #define SHD_NOISE_CELL_NOISE            7
636
637 #define SHD_NOISE_SOFT  0
638 #define SHD_NOISE_HARD  1
639
640 /* voronoi texture */
641 #define SHD_VORONOI_DISTANCE_SQUARED    0
642 #define SHD_VORONOI_ACTUAL_DISTANCE             1
643 #define SHD_VORONOI_MANHATTAN                   2
644 #define SHD_VORONOI_CHEBYCHEV                   3
645 #define SHD_VORONOI_MINKOVSKY_H                 4
646 #define SHD_VORONOI_MINKOVSKY_4                 5
647 #define SHD_VORONOI_MINKOVSKY                   6
648
649 #define SHD_VORONOI_INTENSITY   0
650 #define SHD_VORONOI_CELLS               1
651
652 /* musgrave texture */
653 #define SHD_MUSGRAVE_MULTIFRACTAL                       0
654 #define SHD_MUSGRAVE_FBM                                        1
655 #define SHD_MUSGRAVE_HYBRID_MULTIFRACTAL        2
656 #define SHD_MUSGRAVE_RIDGED_MULTIFRACTAL        3
657 #define SHD_MUSGRAVE_HETERO_TERRAIN                     4
658
659 /* wave texture */
660 #define SHD_WAVE_BANDS          0
661 #define SHD_WAVE_RINGS          1
662
663 #define SHD_WAVE_SINE   0
664 #define SHD_WAVE_SAW    1
665 #define SHD_WAVE_TRI    2
666
667 /* image/environment texture */
668 #define SHD_COLORSPACE_NONE             0
669 #define SHD_COLORSPACE_COLOR    1
670
671 /* environment texture */
672 #define SHD_PROJ_EQUIRECTANGULAR        0
673 #define SHD_PROJ_MIRROR_BALL            1
674
675 /* blur node */
676 #define CMP_NODE_BLUR_ASPECT_NONE               0
677 #define CMP_NODE_BLUR_ASPECT_Y                  1
678 #define CMP_NODE_BLUR_ASPECT_X                  2
679
680 #endif