d2bb480b109f0944bb3692cf5990235cb5227b7b
[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 struct bGPdata;
54
55         /**
56          * The base structure all the other spaces
57          * are derived (implicitly) from. Would be
58          * good to make this explicit.
59          */
60
61 typedef struct SpaceLink {
62         struct SpaceLink *next, *prev;
63         int spacetype;
64         float blockscale;                       /* XXX depricate this */
65         short blockhandler[8];          /* XXX depricate this */
66 } SpaceLink;
67
68 typedef struct SpaceInfo {
69         SpaceLink *next, *prev;
70         int spacetype;
71         float blockscale;
72
73         short blockhandler[8];
74 } SpaceInfo;
75
76 typedef struct SpaceIpo {
77         SpaceLink *next, *prev;
78         int spacetype;
79         float blockscale;
80
81         short blockhandler[8];
82         
83         unsigned int rowbut, pad2; 
84         View2D v2d; /* depricated, copied to region */
85         
86         void *editipo;
87         ListBase ipokey;
88         
89         /* the ipo context we need to store */
90         struct Ipo *ipo;
91         struct ID *from;
92         char actname[32], constname[32], bonename[32];
93
94         short totipo, pin;
95         short butofs, channel;
96         short showkey, blocktype;
97         short menunr, lock;
98         int flag;
99         float median[3];
100         rctf tot;
101 } SpaceIpo;
102
103 typedef struct SpaceButs {
104         SpaceLink *next, *prev;
105         int spacetype;
106         float blockscale;
107         struct RenderInfo *ri;
108
109         short blockhandler[8];
110
111         short cursens, curact;
112         short align, tabo;              /* align for panels, tab is old tab */
113         View2D v2d; /* depricated, copied to region */
114         
115         short mainb, menunr;    /* texnr and menunr have to remain shorts */
116         short pin, mainbo;      
117         void *lockpoin;
118         
119         short texnr;
120         char texfrom, showgroup;
121         
122         short modeltype;
123         short scriptblock;
124         short scaflag;
125         short re_align;
126         
127         short oldkeypress;              /* for keeping track of the sub tab key cycling */
128         char pad, flag;
129         
130         char texact, tab[7];    /* storing tabs for each context */
131                 
132 } SpaceButs;
133
134 typedef struct SpaceSeq {
135         SpaceLink *next, *prev;
136         int spacetype;
137         float blockscale;
138
139         short blockhandler[8];
140
141         View2D v2d; /* depricated, copied to region */
142         
143         float xof, yof; /* offset for drawing the image preview */
144         short mainb, pad;
145         short chanshown;
146         short zebra;
147         int flag;
148         float zoom;
149         
150         struct bGPdata *gpd;            /* grease-pencil data */
151 } SpaceSeq;
152
153 typedef struct SpaceFile {
154         SpaceLink *next, *prev;
155         int spacetype;
156         float blockscale;
157         
158         short blockhandler[8];
159
160         struct direntry *filelist;
161         int totfile;
162         
163         char title[24];
164         char dir[240];
165         char file[80];
166         
167         short type, ofs, flag, sort;
168         short maxnamelen, collums, f_fp, pad1;
169         int pad2;
170         char fp_str[8];
171
172         struct BlendHandle *libfiledata;
173         
174         unsigned short retval;          /* event */
175         short menu, act, ipotype;
176         
177         /* one day we'll add unions to dna */
178         void (*returnfunc)(char *);
179         void (*returnfunc_event)(unsigned short);
180         void (*returnfunc_args)(char *, void *, void *);
181         
182         void *arg1, *arg2;
183         short *menup;   /* pointer to menu result or ID browsing */
184         char *pupmenu;  /* optional menu in header */
185 } SpaceFile;
186
187 typedef struct SpaceOops {
188         SpaceLink *next, *prev;
189         int spacetype;
190         float blockscale;
191
192         short blockhandler[8];
193
194         View2D v2d; /* depricated, copied to region */
195         
196         ListBase oops;
197         short pin, visiflag, flag, rt;
198         void *lockpoin;
199         
200         ListBase tree;
201         struct TreeStore *treestore;
202         
203         /* search stuff */
204         char search_string[32];
205         struct TreeStoreElem search_tse;
206         int search_flags, do_;
207         
208         short type, outlinevis, storeflag;
209         short deps_flags;
210
211         /* RNA */
212         char *rnapath;
213         
214 } SpaceOops;
215
216 typedef struct SpaceImage {
217         SpaceLink *next, *prev;
218         int spacetype;
219         float blockscale;
220
221         short blockhandler[8];
222
223         View2D v2d; /* depricated, copied to region */
224         
225         struct Image *image;
226         struct ImageUser iuser;
227         
228         struct CurveMapping *cumap;
229         short mode, menunr;
230         short imanr;
231         short curtile; /* the currently active tile of the image when tile is enabled, is kept in sync with the active faces tile */
232         int flag;
233         short selectmode;
234         short imtypenr, lock;
235         short pin;
236         float zoom;
237         char dt_uv; /* UV draw type */
238         char sticky; /* sticky selection type */
239         char dt_uvstretch;
240         char pad[5];
241         
242         float xof, yof;                                 /* user defined offset, image is centered */
243         float centx, centy;                             /* storage for offset while render drawing */
244         
245         struct bGPdata *gpd;                    /* grease pencil data */
246 } SpaceImage;
247
248 typedef struct SpaceNla {
249         struct SpaceLink *next, *prev;
250         int spacetype;
251         float blockscale;
252
253         short blockhandler[8];
254
255         short menunr, lock;
256         short autosnap;                 /* this uses the same settings as autosnap for Action Editor */
257         short flag;
258         
259         View2D v2d;      /* depricated, copied to region */
260 } SpaceNla;
261
262 typedef struct SpaceText {
263         SpaceLink *next, *prev;
264         int spacetype;
265         float blockscale;
266
267         short blockhandler[8];
268
269         struct Text *text;      
270
271         int top, viewlines;
272         short flags, menunr;    
273         int font_id;
274
275         int lheight;
276         int left;
277         int showlinenrs;
278         int tabnumber;
279
280         int currtab_set; 
281         int showsyntax;
282         int overwrite;
283         float pix_per_line;
284
285         struct rcti txtscroll, txtbar;
286
287         int wordwrap, doplugins;
288
289 } SpaceText;
290
291 typedef struct Script {
292         ID id;
293
294         void *py_draw;
295         void *py_event;
296         void *py_button;
297         void *py_browsercallback;
298         void *py_globaldict;
299
300         int flags, lastspace;
301         char scriptname[256]; /* store the script file here so we can re-run it on loading blender, if "Enable Scripts" is on */
302         char scriptarg[256];
303 } Script;
304 #define SCRIPT_SET_NULL(_script) _script->py_draw = _script->py_event = _script->py_button = _script->py_browsercallback = _script->py_globaldict = NULL; _script->flags = 0;
305 #define SCRIPT_RUNNING  0x01
306 #define SCRIPT_GUI              0x02
307 #define SCRIPT_FILESEL  0x04
308
309 typedef struct SpaceScript {
310         SpaceLink *next, *prev;
311         int spacetype;
312         float blockscale;
313         struct Script *script;
314
315         short flags, menunr;
316         int pad1;
317         
318         void *but_refs;
319 } SpaceScript;
320
321 typedef struct SpaceTime {
322         SpaceLink *next, *prev;
323         int spacetype;
324         float blockscale;
325         
326         View2D v2d; /* depricated, copied to region */
327         
328         int flag, redraws;
329         
330 } SpaceTime;
331
332 typedef struct SpaceNode {
333         SpaceLink *next, *prev;
334         int spacetype;
335         float blockscale;
336         
337         short blockhandler[8];
338         
339         View2D v2d; /* depricated, copied to region */
340         
341         struct ID *id, *from;           /* context, no need to save in file? well... pinning... */
342         short flag, menunr;                     /* menunr: browse id block in header */
343         float aspect;
344         void *curfont;
345         
346         float xof, yof; /* offset for drawing the backdrop */
347         
348         struct bNodeTree *nodetree, *edittree;
349         int treetype, pad;                      /* treetype: as same nodetree->type */
350         
351         struct bGPdata *gpd;            /* grease-pencil data */
352 } SpaceNode;
353
354 /* snode->flag */
355 #define SNODE_DO_PREVIEW        1
356 #define SNODE_BACKDRAW          2
357 #define SNODE_DISPGP            4
358
359 typedef struct SpaceImaSel {
360         SpaceLink *next, *prev;
361         int spacetype;
362         float blockscale;
363         
364         short blockhandler[8];
365
366         View2D v2d; /* depricated, copied to region */
367
368         struct FileList *files;
369
370         /* specific stuff for drawing */
371         char title[24];
372         char dir[240];
373         char file[80];
374
375         short type, menu, flag, sort;
376
377         void *curfont;
378         int     active_file;
379
380         int numtilesx;
381         int numtilesy;
382
383         int selstate;
384
385         struct rcti viewrect;
386         struct rcti bookmarkrect;
387
388         float scrollpos; /* current position of scrollhandle */
389         float scrollheight; /* height of the scrollhandle */
390         float scrollarea; /* scroll region, scrollpos is from 0 to scrollarea */
391
392         float aspect;
393         unsigned short retval;          /* event */
394
395         short ipotype;
396         
397         short filter;
398         short active_bookmark;
399         short pad, pad1;
400
401         /* view settings */
402         short prv_w;
403         short prv_h;
404
405         /* one day we'll add unions to dna */
406         void (*returnfunc)(char *);
407         void (*returnfunc_event)(unsigned short);
408         void (*returnfunc_args)(char *, void *, void *);
409         
410         void *arg1, *arg2;
411         short *menup;   /* pointer to menu result or ID browsing */
412         char *pupmenu;  /* optional menu in header */
413
414         struct ImBuf *img;
415 } SpaceImaSel;
416
417
418 /* view3d  Now in DNA_view3d_types.h */
419
420
421
422 /* **************** SPACE DEFINES ********************* */
423
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 /* SpaceImage->mode */
477 #define SI_TEXTURE              0
478 #define SI_SHOW                 1
479
480 /* SpaceImage->dt_uv */
481 #define SI_UVDT_OUTLINE 0
482 #define SI_UVDT_DASH    1
483 #define SI_UVDT_BLACK   2
484 #define SI_UVDT_WHITE   3
485
486 /* SpaceImage->dt_uvstretch */
487 #define SI_UVDT_STRETCH_ANGLE   0
488 #define SI_UVDT_STRETCH_AREA    1
489
490 /* SpaceImage->sticky
491  * Note DISABLE should be 0, however would also need to re-arrange icon order,
492  * also, sticky loc is the default mode so this means we dont need to 'do_versons' */
493 #define SI_STICKY_LOC           0
494 #define SI_STICKY_DISABLE       1
495 #define SI_STICKY_VERTEX        2
496
497 /* SpaceImage->selectmode */
498 #define SI_SELECT_VERTEX        0
499 #define SI_SELECT_EDGE          1 /* not implemented */
500 #define SI_SELECT_FACE          2
501 #define SI_SELECT_ISLAND        3
502
503 /* SpaceImage->flag */
504 #define SI_BE_SQUARE    1<<0
505 #define SI_EDITTILE             1<<1
506 #define SI_CLIP_UV              1<<2
507 #define SI_DRAWTOOL             1<<3
508 #define SI_DEPRECATED1  1<<4    /* stick UVs to others in the same location */
509 #define SI_DRAWSHADOW   1<<5
510 #define SI_SELACTFACE   1<<6    /* deprecated */
511 #define SI_DEPRECATED2  1<<7
512 #define SI_DEPRECATED3  1<<8    /* stick UV selection to mesh vertex (UVs wont always be touching) */
513 #define SI_COORDFLOATS  1<<9
514 #define SI_PIXELSNAP    1<<10
515 #define SI_LIVE_UNWRAP  1<<11
516 #define SI_USE_ALPHA    1<<12
517 #define SI_SHOW_ALPHA   1<<13
518 #define SI_SHOW_ZBUF    1<<14
519                 /* next two for render window dislay */
520 #define SI_PREVSPACE    1<<15
521 #define SI_FULLWINDOW   1<<16
522 #define SI_SYNC_UVSEL   1<<17
523 #define SI_LOCAL_UV             1<<18
524                 /* this means that the image is drawn until it reaches the view edge,
525                  * in the image view, its unrelated to the 'tile' mode for texface */
526 #define SI_DRAW_TILE    1<<19 
527 #define SI_SMOOTH_UV    1<<20
528 #define SI_DRAW_STRETCH 1<<21
529 #define SI_DISPGP               1<<22
530
531 /* SpaceIpo->flag */
532 #define SIPO_LOCK_VIEW                  1<<0
533 #define SIPO_NOTRANSKEYCULL             1<<1
534
535 /* SpaceText flags (moved from DNA_text_types.h) */
536
537 #define ST_SCROLL_SELECT        0x0001 // scrollable
538 #define ST_CLEAR_NAMESPACE      0x0010 // clear namespace after script
539                                        // execution (see BPY_main.c)
540
541 /* SpaceOops->type */
542 #define SO_OOPS                 0
543 #define SO_OUTLINER             1
544 #define SO_DEPSGRAPH    2
545
546 /* SpaceOops->flag */
547 #define SO_TESTBLOCKS   1
548 #define SO_NEWSELECTED  2
549 #define SO_HIDE_RESTRICTCOLS            4
550
551 /* SpaceOops->visiflag */
552 #define OOPS_SCE        1
553 #define OOPS_OB         2
554 #define OOPS_ME         4
555 #define OOPS_CU         8
556 #define OOPS_MB         16
557 #define OOPS_LT         32
558 #define OOPS_LA         64
559 #define OOPS_MA         128
560 #define OOPS_TE         256
561 #define OOPS_IP         512
562 #define OOPS_LAY        1024
563 #define OOPS_LI         2048
564 #define OOPS_IM         4096
565 #define OOPS_AR         8192
566 #define OOPS_GR         16384
567 #define OOPS_CA         32768
568
569 /* SpaceOops->outlinevis */
570 #define SO_ALL_SCENES   0
571 #define SO_CUR_SCENE    1
572 #define SO_VISIBLE              2
573 #define SO_SELECTED             3
574 #define SO_ACTIVE               4
575 #define SO_SAME_TYPE    5
576 #define SO_GROUPS               6
577 #define SO_LIBRARIES    7
578 #define SO_VERSE_SESSION        8
579 #define SO_VERSE_MS             9
580 #define SO_SEQUENCE             10
581
582 /* SpaceOops->storeflag */
583 #define SO_TREESTORE_CLEANUP    1
584                 /* if set, it allows redraws. gets set for some allqueue events */
585 #define SO_TREESTORE_REDRAW             2
586
587 /* headerbuttons: 450-499 */
588
589 #define B_IMASELHOME            451
590 #define B_IMASELREMOVEBIP       452
591
592 #define C_BACK  0xBAAAAA
593 #define C_DARK  0x665656
594 #define C_DERK  0x766666
595 #define C_HI    0xCBBBBB
596 #define C_LO    0x544444
597
598 /* queue settings */
599 #define IMS_KNOW_WIN        1
600 #define IMS_KNOW_BIP        2
601 #define IMS_KNOW_DIR        4
602 #define IMS_DOTHE_INF           8
603 #define IMS_KNOW_INF       16
604 #define IMS_DOTHE_IMA      32
605 #define IMS_KNOW_IMA       64
606 #define IMS_FOUND_BIP     128
607 #define IMS_DOTHE_BIP     256
608 #define IMS_WRITE_NO_BIP  512
609
610 /* imasel->mode */
611 #define IMS_NOIMA                       0
612 #define IMS_IMA                         1
613 #define IMS_ANIM                        2
614 #define IMS_DIR                         4
615 #define IMS_FILE                        8
616 #define IMS_STRINGCODE          16
617
618 #define IMS_INDIR                       1
619 #define IMS_INDIRSLI            2
620 #define IMS_INFILE                      3
621 #define IMS_INFILESLI           4
622
623 /* nla->flag */
624 #define SNLA_ALLKEYED           1
625 #define SNLA_ACTIVELAYERS       2
626 #define SNLA_DRAWTIME           4
627 #define SNLA_NOTRANSKEYCULL     8
628
629 /* time->flag */
630         /* show timing in frames instead of in seconds */
631 #define TIME_DRAWFRAMES         1
632         /* temporary flag set when scrubbing time */
633 #define TIME_CFRA_NUM           2
634         /* only keyframes from active/selected channels get shown */
635 #define TIME_ONLYACTSEL         4
636
637 /* time->redraws */
638 #define TIME_LEFTMOST_3D_WIN    1
639 #define TIME_ALL_3D_WIN                 2
640 #define TIME_ALL_ANIM_WIN               4
641 #define TIME_ALL_BUTS_WIN               8
642 #define TIME_WITH_SEQ_AUDIO             16
643 #define TIME_SEQ                                32
644 #define TIME_ALL_IMAGE_WIN              64
645 #define TIME_CONTINUE_PHYSICS   128
646
647 /* sseq->mainb */
648 #define SEQ_DRAW_SEQUENCE         0
649 #define SEQ_DRAW_IMG_IMBUF        1
650 #define SEQ_DRAW_IMG_WAVEFORM     2
651 #define SEQ_DRAW_IMG_VECTORSCOPE  3
652 #define SEQ_DRAW_IMG_HISTOGRAM    4
653
654 /* sseq->flag */
655 #define SEQ_DRAWFRAMES   1
656 #define SEQ_MARKER_TRANS 2
657 #define SEQ_DRAW_COLOR_SEPERATED     4
658 #define SEQ_DRAW_SAFE_MARGINS        8
659 #define SEQ_DRAW_GPENCIL                        16
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