soc-2008-mxcurioni: implemented (without testing) StrokeShader, Stroke and MediumType...
[blender.git] / source / blender / makesdna / DNA_space_types.h
1 /**
2  * blenlib/DNA_space_types.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef DNA_SPACE_TYPES_H
32 #define DNA_SPACE_TYPES_H
33
34 #include "DNA_listBase.h"
35 #include "DNA_vec_types.h"
36 #include "DNA_oops_types.h"             /* for TreeStoreElem */
37 #include "DNA_image_types.h"    /* ImageUser */
38 /* Hum ... Not really nice... but needed for spacebuts. */
39 #include "DNA_view2d_types.h"
40
41 struct Ipo;
42 struct ID;
43 struct Text;
44 struct Script;
45 struct ImBuf;
46 struct Image;
47 struct SpaceIpo;
48 struct BlendHandle;
49 struct RenderInfo;
50 struct bNodeTree;
51 struct uiBlock;
52 struct FileList;
53
54         /**
55          * The base structure all the other spaces
56          * are derived (implicitly) from. Would be
57          * good to make this explicit.
58          */
59 typedef struct SpaceLink SpaceLink;
60 struct SpaceLink {
61         SpaceLink *next, *prev;
62         int spacetype;
63         float blockscale;
64         struct ScrArea *area;
65         short blockhandler[8];
66 };
67
68 typedef struct SpaceInfo {
69         SpaceLink *next, *prev;
70         int spacetype;
71         float blockscale;
72         struct ScrArea *area;
73
74         short blockhandler[8];
75 } SpaceInfo;
76
77 typedef struct SpaceIpo {
78         SpaceLink *next, *prev;
79         int spacetype;
80         float blockscale;
81         struct ScrArea *area;
82
83         short blockhandler[8];
84         
85         unsigned int rowbut, pad2; 
86         View2D v2d;
87         
88         void *editipo;
89         ListBase ipokey;
90         
91         /* the ipo context we need to store */
92         struct Ipo *ipo;
93         struct ID *from;
94         char actname[32], constname[32], bonename[32];
95
96         short totipo, pin;
97         short butofs, channel;
98         short showkey, blocktype;
99         short menunr, lock;
100         int flag;
101         float median[3];
102         rctf tot;
103 } SpaceIpo;
104
105 typedef struct SpaceButs {
106         SpaceLink *next, *prev;
107         int spacetype;
108         float blockscale;
109         struct ScrArea *area;
110         struct RenderInfo *ri;
111
112         short blockhandler[8];
113
114         short cursens, curact;
115         short align, tabo;              /* align for panels, tab is old tab */
116         View2D v2d;
117         
118         short mainb, menunr;    /* texnr and menunr have to remain shorts */
119         short pin, mainbo;      
120         void *lockpoin;
121         
122         short texnr;
123         char texfrom, showgroup;
124         
125         short modeltype;
126         short scriptblock;
127         short scaflag;
128         short re_align;
129         
130         short oldkeypress;              /* for keeping track of the sub tab key cycling */
131         char pad, flag;
132         
133         char texact, tab[7];    /* storing tabs for each context */
134                 
135 } SpaceButs;
136
137 typedef struct SpaceSeq {
138         SpaceLink *next, *prev;
139         int spacetype;
140         float blockscale;
141         struct ScrArea *area;
142
143         short blockhandler[8];
144
145         View2D v2d;
146         
147         float xof, yof; /* offset for drawing the image preview */
148         short mainb, pad;
149         short chanshown;
150         short zebra;
151         int flag;
152         float zoom;
153 } SpaceSeq;
154
155 typedef struct SpaceFile {
156         SpaceLink *next, *prev;
157         int spacetype;
158         float blockscale;
159         struct ScrArea *area;
160         
161         short blockhandler[8];
162
163         struct direntry *filelist;
164         int totfile;
165         
166         char title[24];
167         char dir[240];
168         char file[80];
169         
170         short type, ofs, flag, sort;
171         short maxnamelen, collums, f_fp, pad1;
172         int pad2;
173         char fp_str[8];
174
175         struct BlendHandle *libfiledata;
176         
177         unsigned short retval;          /* event */
178         short menu, act, ipotype;
179         
180         /* one day we'll add unions to dna */
181         void (*returnfunc)(char *);
182         void (*returnfunc_event)(unsigned short);
183         void (*returnfunc_args)(char *, void *, void *);
184         
185         void *arg1, *arg2;
186         short *menup;   /* pointer to menu result or ID browsing */
187         char *pupmenu;  /* optional menu in header */
188 } SpaceFile;
189
190 typedef struct SpaceOops {
191         SpaceLink *next, *prev;
192         int spacetype;
193         float blockscale;
194         struct ScrArea *area;
195
196         short blockhandler[8];
197
198         View2D v2d;
199         
200         ListBase oops;
201         short pin, visiflag, flag, rt;
202         void *lockpoin;
203         
204         ListBase tree;
205         struct TreeStore *treestore;
206         
207         /* search stuff */
208         char search_string[32];
209         struct TreeStoreElem search_tse;
210         int search_flags, do_;
211         
212         short type, outlinevis, storeflag;
213         short deps_flags;
214         
215 } SpaceOops;
216
217 typedef struct SpaceImage {
218         SpaceLink *next, *prev;
219         int spacetype;
220         float blockscale;
221         struct ScrArea *area;
222
223         short blockhandler[8];
224
225         View2D v2d;
226         
227         struct Image *image;
228         struct ImageUser iuser;
229         
230         struct CurveMapping *cumap;
231         short mode, menunr;
232         short imanr;
233         short curtile; /* the currently active tile of the image when tile is enabled, is kept in sync with the active faces tile */
234         int flag;
235         short selectmode;
236         short imtypenr, lock;
237         short pin;
238         float zoom;
239         char dt_uv; /* UV draw type */
240         char sticky; /* sticky selection type */
241         char dt_uvstretch;
242         char pad[5];
243         
244         float xof, yof;                                 /* user defined offset, image is centered */
245         float centx, centy;                             /* storage for offset while render drawing */
246         
247 } SpaceImage;
248
249 typedef struct SpaceNla {
250         struct SpaceLink *next, *prev;
251         int spacetype;
252         float blockscale;
253         struct ScrArea *area;
254
255         short blockhandler[8];
256
257         short menunr, lock;
258         short autosnap;                 /* this uses the same settings as autosnap for Action Editor */
259         short flag;
260         
261         View2D v2d;     
262 } SpaceNla;
263
264 typedef struct SpaceText {
265         SpaceLink *next, *prev;
266         int spacetype;
267         float blockscale;
268         struct ScrArea *area;
269
270         short blockhandler[8];
271
272         struct Text *text;      
273
274         int top, viewlines;
275         short flags, menunr;
276         
277         int font_id;    
278         int lheight;
279         int left;
280         int showlinenrs;
281         
282         int tabnumber;
283         int currtab_set; 
284         int showsyntax;
285         int unused_padd;
286         
287         float pix_per_line;
288
289         struct rcti txtscroll, txtbar;
290
291 } SpaceText;
292
293 typedef struct Script {
294         ID id;
295
296         void *py_draw;
297         void *py_event;
298         void *py_button;
299         void *py_browsercallback;
300         void *py_globaldict;
301
302         int flags, lastspace;
303         char scriptname[256]; /* store the script file here so we can re-run it on loading blender, if "Enable Scripts" is on */
304         char scriptarg[256];
305 } Script;
306 #define SCRIPT_SET_NULL(_script) _script->py_draw = _script->py_event = _script->py_button = _script->py_browsercallback = _script->py_globaldict = NULL; _script->flags = 0;
307 #define SCRIPT_RUNNING  0x01
308 #define SCRIPT_GUI              0x02
309 #define SCRIPT_FILESEL  0x04
310
311 typedef struct SpaceScript {
312         SpaceLink *next, *prev;
313         int spacetype;
314         float blockscale;
315         struct ScrArea *area;
316         struct Script *script;
317
318         short flags, menunr;
319         int pad1;
320         
321         void *but_refs;
322 } SpaceScript;
323
324 typedef struct SpaceTime {
325         SpaceLink *next, *prev;
326         int spacetype;
327         float blockscale;
328         struct ScrArea *area;
329         
330         View2D v2d;
331         
332         int flag, redraws;
333         
334 } SpaceTime;
335
336 typedef struct SpaceNode {
337         SpaceLink *next, *prev;
338         int spacetype;
339         float blockscale;
340         struct ScrArea *area;
341         
342         View2D v2d;
343         
344         struct ID *id, *from;           /* context, no need to save in file? well... pinning... */
345         short flag, menunr;                     /* menunr: browse id block in header */
346         float aspect;
347         void *curfont;
348         
349         float xof, yof; /* offset for drawing the backdrop */
350         
351         struct bNodeTree *nodetree, *edittree;
352         int treetype, pad;                      /* treetype: as same nodetree->type */
353         
354 } SpaceNode;
355
356 /* snode->flag */
357 #define SNODE_DO_PREVIEW        1
358 #define SNODE_BACKDRAW          2
359
360 typedef struct SpaceImaSel {
361         SpaceLink *next, *prev;
362         int spacetype;
363         float blockscale;
364         struct ScrArea *area;
365         
366         short blockhandler[8];
367
368         View2D v2d;
369
370         struct FileList *files;
371
372         /* specific stuff for drawing */
373         char title[24];
374         char dir[240];
375         char file[80];
376
377         short type, menu, flag, sort;
378
379         void *curfont;
380         int     active_file;
381
382         int numtilesx;
383         int numtilesy;
384
385         int selstate;
386
387         struct rcti viewrect;
388         struct rcti bookmarkrect;
389
390         float scrollpos; /* current position of scrollhandle */
391         float scrollheight; /* height of the scrollhandle */
392         float scrollarea; /* scroll region, scrollpos is from 0 to scrollarea */
393
394         float aspect;
395         unsigned short retval;          /* event */
396
397         short ipotype;
398         
399         short filter;
400         short active_bookmark;
401         short pad, pad1;
402
403         /* view settings */
404         short prv_w;
405         short prv_h;
406
407         /* one day we'll add unions to dna */
408         void (*returnfunc)(char *);
409         void (*returnfunc_event)(unsigned short);
410         void (*returnfunc_args)(char *, void *, void *);
411         
412         void *arg1, *arg2;
413         short *menup;   /* pointer to menu result or ID browsing */
414         char *pupmenu;  /* optional menu in header */
415
416         struct ImBuf *img;
417 } SpaceImaSel;
418
419
420 /* **************** SPACE ********************* */
421
422
423 /* view3d  Now in DNA_view3d_types.h */
424
425 /* button defines in BIF_butspace.h */
426
427 /* sbuts->flag */
428 #define SB_PRV_OSA                      1
429
430 /* these values need to be hardcoded in structs, dna does not recognize defines */
431 /* also defined in BKE */
432 #define FILE_MAXDIR                     160
433 #define FILE_MAXFILE            80
434 #define FILE_MAX                        240
435
436 /* filesel types */
437 #define FILE_UNIX                       8
438 #define FILE_BLENDER            8 /* dont display relative paths */
439 #define FILE_SPECIAL            9
440
441 #define FILE_LOADLIB            1
442 #define FILE_MAIN                       2
443 #define FILE_LOADFONT           3
444
445 /* sfile->flag and simasel->flag */
446 #define FILE_SHOWSHORT          1
447 #define FILE_STRINGCODE         2
448 #define FILE_LINK                       4
449 #define FILE_HIDE_DOT           8
450 #define FILE_AUTOSELECT         16
451 #define FILE_ACTIVELAY          32
452 #define FILE_ATCURSOR           64
453 #define FILE_SYNCPOSE           128
454 #define FILE_FILTER                     256
455 #define FILE_BOOKMARKS          512
456
457 /* sfile->sort */
458 #define FILE_SORTALPHA          0
459 #define FILE_SORTDATE           1
460 #define FILE_SORTSIZE           2
461 #define FILE_SORTEXTENS         3
462
463 /* files in filesel list: 2=ACTIVE  */
464 #define HILITE                          1
465 #define BLENDERFILE                     4
466 #define PSXFILE                         8
467 #define IMAGEFILE                       16
468 #define MOVIEFILE                       32
469 #define PYSCRIPTFILE            64
470 #define FTFONTFILE                      128
471 #define SOUNDFILE                       256
472 #define TEXTFILE                        512
473 #define MOVIEFILE_ICON          1024 /* movie file that preview can't load */
474 #define FOLDERFILE                      2048 /* represents folders for filtering */
475
476 #define SCROLLH 16                      /* height scrollbar */
477 #define SCROLLB 16                      /* width scrollbar */
478
479 /* SpaceImage->mode */
480 #define SI_TEXTURE              0
481 #define SI_SHOW                 1
482
483 /* SpaceImage->dt_uv */
484 #define SI_UVDT_OUTLINE 0
485 #define SI_UVDT_DASH    1
486 #define SI_UVDT_BLACK   2
487 #define SI_UVDT_WHITE   3
488
489 /* SpaceImage->dt_uvstretch */
490 #define SI_UVDT_STRETCH_ANGLE   0
491 #define SI_UVDT_STRETCH_AREA    1
492
493 /* SpaceImage->sticky
494  * Note DISABLE should be 0, however would also need to re-arrange icon order,
495  * also, sticky loc is the default mode so this means we dont need to 'do_versons' */
496 #define SI_STICKY_LOC           0
497 #define SI_STICKY_DISABLE       1
498 #define SI_STICKY_VERTEX        2
499
500 /* SpaceImage->selectmode */
501 #define SI_SELECT_VERTEX        0
502 #define SI_SELECT_EDGE          1 /* not implemented */
503 #define SI_SELECT_FACE          2
504 #define SI_SELECT_ISLAND        3
505
506 /* SpaceImage->flag */
507 #define SI_BE_SQUARE    1<<0
508 #define SI_EDITTILE             1<<1
509 #define SI_CLIP_UV              1<<2
510 #define SI_DRAWTOOL             1<<3
511 #define SI_DEPRECATED1  1<<4    /* stick UVs to others in the same location */
512 #define SI_DRAWSHADOW   1<<5
513 #define SI_SELACTFACE   1<<6    /* deprecated */
514 #define SI_DEPRECATED2  1<<7
515 #define SI_DEPRECATED3  1<<8    /* stick UV selection to mesh vertex (UVs wont always be touching) */
516 #define SI_COORDFLOATS  1<<9
517 #define SI_PIXELSNAP    1<<10
518 #define SI_LIVE_UNWRAP  1<<11
519 #define SI_USE_ALPHA    1<<12
520 #define SI_SHOW_ALPHA   1<<13
521 #define SI_SHOW_ZBUF    1<<14
522                 /* next two for render window dislay */
523 #define SI_PREVSPACE    1<<15
524 #define SI_FULLWINDOW   1<<16
525 #define SI_SYNC_UVSEL   1<<17
526 #define SI_LOCAL_UV             1<<18
527                 /* this means that the image is drawn until it reaches the view edge,
528                  * in the image view, its unrelated to the 'tile' mode for texface */
529 #define SI_DRAW_TILE    1<<19 
530 #define SI_SMOOTH_UV    1<<20
531 #define SI_DRAW_STRETCH 1<<21
532
533 /* SpaceIpo->flag */
534 #define SIPO_LOCK_VIEW                  1<<0
535 #define SIPO_NOTRANSKEYCULL             1<<1
536
537 /* SpaceText flags (moved from DNA_text_types.h) */
538
539 #define ST_SCROLL_SELECT        0x0001 // scrollable
540 #define ST_CLEAR_NAMESPACE      0x0010 // clear namespace after script
541                                        // execution (see BPY_main.c)
542
543 /* SpaceOops->type */
544 #define SO_OOPS                 0
545 #define SO_OUTLINER             1
546 #define SO_DEPSGRAPH    2
547
548 /* SpaceOops->flag */
549 #define SO_TESTBLOCKS   1
550 #define SO_NEWSELECTED  2
551 #define SO_HIDE_RESTRICTCOLS            4
552
553 /* SpaceOops->visiflag */
554 #define OOPS_SCE        1
555 #define OOPS_OB         2
556 #define OOPS_ME         4
557 #define OOPS_CU         8
558 #define OOPS_MB         16
559 #define OOPS_LT         32
560 #define OOPS_LA         64
561 #define OOPS_MA         128
562 #define OOPS_TE         256
563 #define OOPS_IP         512
564 #define OOPS_LAY        1024
565 #define OOPS_LI         2048
566 #define OOPS_IM         4096
567 #define OOPS_AR         8192
568 #define OOPS_GR         16384
569 #define OOPS_CA         32768
570
571 /* SpaceOops->outlinevis */
572 #define SO_ALL_SCENES   0
573 #define SO_CUR_SCENE    1
574 #define SO_VISIBLE              2
575 #define SO_SELECTED             3
576 #define SO_ACTIVE               4
577 #define SO_SAME_TYPE    5
578 #define SO_GROUPS               6
579 #define SO_LIBRARIES    7
580 #define SO_VERSE_SESSION        8
581 #define SO_VERSE_MS             9
582
583 /* SpaceOops->storeflag */
584 #define SO_TREESTORE_CLEANUP    1
585                 /* if set, it allows redraws. gets set for some allqueue events */
586 #define SO_TREESTORE_REDRAW             2
587
588 /* headerbuttons: 450-499 */
589
590 #define B_IMASELHOME            451
591 #define B_IMASELREMOVEBIP       452
592
593 #define C_BACK  0xBAAAAA
594 #define C_DARK  0x665656
595 #define C_DERK  0x766666
596 #define C_HI    0xCBBBBB
597 #define C_LO    0x544444
598
599 /* queue settings */
600 #define IMS_KNOW_WIN        1
601 #define IMS_KNOW_BIP        2
602 #define IMS_KNOW_DIR        4
603 #define IMS_DOTHE_INF           8
604 #define IMS_KNOW_INF       16
605 #define IMS_DOTHE_IMA      32
606 #define IMS_KNOW_IMA       64
607 #define IMS_FOUND_BIP     128
608 #define IMS_DOTHE_BIP     256
609 #define IMS_WRITE_NO_BIP  512
610
611 /* imasel->mode */
612 #define IMS_NOIMA                       0
613 #define IMS_IMA                         1
614 #define IMS_ANIM                        2
615 #define IMS_DIR                         4
616 #define IMS_FILE                        8
617 #define IMS_STRINGCODE          16
618
619 #define IMS_INDIR                       1
620 #define IMS_INDIRSLI            2
621 #define IMS_INFILE                      3
622 #define IMS_INFILESLI           4
623
624 /* nla->flag */
625 #define SNLA_ALLKEYED           1
626 #define SNLA_ACTIVELAYERS       2
627 #define SNLA_DRAWTIME           4
628 #define SNLA_NOTRANSKEYCULL     8
629
630 /* time->flag */
631         /* show timing in frames instead of in seconds */
632 #define TIME_DRAWFRAMES         1
633         /* temporary flag set when scrubbing time */
634 #define TIME_CFRA_NUM           2
635         /* only keyframes from active/selected channels get shown */
636 #define TIME_ONLYACTSEL         4
637
638 /* time->redraws */
639 #define TIME_LEFTMOST_3D_WIN    1
640 #define TIME_ALL_3D_WIN                 2
641 #define TIME_ALL_ANIM_WIN               4
642 #define TIME_ALL_BUTS_WIN               8
643 #define TIME_WITH_SEQ_AUDIO             16
644 #define TIME_SEQ                                32
645 #define TIME_ALL_IMAGE_WIN              64
646 #define TIME_CONTINUE_PHYSICS   128
647
648 /* sseq->mainb */
649 #define SEQ_DRAW_SEQUENCE         0
650 #define SEQ_DRAW_IMG_IMBUF        1
651 #define SEQ_DRAW_IMG_WAVEFORM     2
652 #define SEQ_DRAW_IMG_VECTORSCOPE  3
653 #define SEQ_DRAW_IMG_HISTOGRAM    4
654
655 /* sseq->flag */
656 #define SEQ_DRAWFRAMES   1
657 #define SEQ_MARKER_TRANS 2
658 #define SEQ_DRAW_COLOR_SEPERATED     4
659 #define SEQ_DRAW_SAFE_MARGINS        8
660
661 /* space types, moved from DNA_screen_types.h */
662 enum {
663         SPACE_EMPTY,
664         SPACE_VIEW3D,
665         SPACE_IPO,
666         SPACE_OOPS,
667         SPACE_BUTS,
668         SPACE_FILE,
669         SPACE_IMAGE,            
670         SPACE_INFO,
671         SPACE_SEQ,
672         SPACE_TEXT,
673         SPACE_IMASEL,
674         SPACE_SOUND,
675         SPACE_ACTION,
676         SPACE_NLA,
677         SPACE_SCRIPT,
678         SPACE_TIME,
679         SPACE_NODE,
680         SPACEICONMAX = SPACE_NODE
681 /*      SPACE_LOGIC     */
682 };
683
684 #endif