Code cleanup - Removing/commenting out various bits of legacy cruft related to
[blender.git] / source / blender / makesdna / DNA_space_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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 /** \file DNA_space_types.h
28  *  \ingroup DNA
29  *  \since mar-2001
30  *  \author nzc
31  */
32
33 #ifndef __DNA_SPACE_TYPES_H__
34 #define __DNA_SPACE_TYPES_H__
35
36 #include "DNA_defs.h"
37 #include "DNA_listBase.h"
38 #include "DNA_color_types.h"        /* for Histogram */
39 #include "DNA_vec_types.h"
40 #include "DNA_outliner_types.h"     /* for TreeStoreElem */
41 #include "DNA_image_types.h"        /* ImageUser */
42 #include "DNA_movieclip_types.h"    /* MovieClipUser */
43 /* Hum ... Not really nice... but needed for spacebuts. */
44 #include "DNA_view2d_types.h"
45
46 struct ID;
47 struct Text;
48 struct Script;
49 struct bSound;
50 struct ImBuf;
51 struct Image;
52 struct Scopes;
53 struct Histogram;
54 struct SpaceIpo;
55 struct BlendHandle;
56 struct RenderInfo;
57 struct bNodeTree;
58 struct uiBlock;
59 struct FileList;
60 struct bGPdata;
61 struct bDopeSheet;
62 struct FileSelectParams;
63 struct FileLayout;
64 struct bScreen;
65 struct Scene;
66 struct wmOperator;
67 struct wmTimer;
68 struct MovieClip;
69 struct MovieClipScopes;
70 struct Mask;
71
72
73 /* SpaceLink (Base) ==================================== */
74
75 /**
76  * The base structure all the other spaces
77  * are derived (implicitly) from. Would be
78  * good to make this explicit.
79  */
80 typedef struct SpaceLink {
81         struct SpaceLink *next, *prev;
82         ListBase regionbase;        /* storage of regions for inactive spaces */
83         int spacetype;
84         float blockscale DNA_DEPRECATED;        /* XXX make deprecated */
85         short blockhandler[8]  DNA_DEPRECATED;  /* XXX make deprecated */
86 } SpaceLink;
87
88
89 /* Space Info ========================================== */
90
91 /* Info Header */
92 typedef struct SpaceInfo {
93         SpaceLink *next, *prev;
94         ListBase regionbase;        /* storage of regions for inactive spaces */
95         int spacetype;
96         float blockscale DNA_DEPRECATED;
97         short blockhandler[8]  DNA_DEPRECATED;      /* XXX make deprecated */
98         
99         char rpt_mask;
100         char pad[7];
101 } SpaceInfo;
102
103 /* SpaceInfo.rpt_mask */
104 typedef enum eSpaceInfo_RptMask {
105         INFO_RPT_DEBUG  = (1 << 0),
106         INFO_RPT_INFO   = (1 << 1),
107         INFO_RPT_OP     = (1 << 2),
108         INFO_RPT_WARN   = (1 << 3),
109         INFO_RPT_ERR    = (1 << 4),
110 } eSpaceInfo_RptMask;
111
112
113 /* Properties Editor ==================================== */
114
115 /* Properties Editor */
116 typedef struct SpaceButs {
117         SpaceLink *next, *prev;
118         ListBase regionbase;        /* storage of regions for inactive spaces */
119         int spacetype;
120         float blockscale DNA_DEPRECATED;
121         
122         short blockhandler[8]  DNA_DEPRECATED;
123
124         View2D v2d DNA_DEPRECATED;                      /* deprecated, copied to region */
125         
126         short mainb, mainbo, mainbuser; /* context tabs */
127         short re_align, align;          /* align for panels */
128         short preview;                  /* preview is signal to refresh */
129         short texture_context;          /* texture context selector (material, world, brush)*/
130         char flag, pad;
131         
132         void *path;                     /* runtime */
133         int pathflag, dataicon;         /* runtime */
134         ID *pinid;
135
136         void *texuser;
137 } SpaceButs;
138
139 /* button defines (deprecated) */
140 /* warning: the values of these defines are used in sbuts->tabs[8] */
141 /* sbuts->mainb new */
142 #define CONTEXT_SCENE   0
143 #define CONTEXT_OBJECT  1
144 #define CONTEXT_TYPES   2
145 #define CONTEXT_SHADING 3
146 #define CONTEXT_EDITING 4
147 #define CONTEXT_SCRIPT  5
148 #define CONTEXT_LOGIC   6
149
150 /* sbuts->mainb old (deprecated) */
151 #define BUTS_VIEW           0
152 #define BUTS_LAMP           1
153 #define BUTS_MAT            2
154 #define BUTS_TEX            3
155 #define BUTS_ANIM           4
156 #define BUTS_WORLD          5
157 #define BUTS_RENDER         6
158 #define BUTS_EDIT           7
159 #define BUTS_GAME           8
160 #define BUTS_FPAINT         9
161 #define BUTS_RADIO          10
162 #define BUTS_SCRIPT         11
163 #define BUTS_SOUND          12
164 #define BUTS_CONSTRAINT     13
165 #define BUTS_EFFECTS        14
166
167 /* buts->mainb new */
168 typedef enum eSpaceButtons_Context {
169         BCONTEXT_RENDER = 0,
170         BCONTEXT_SCENE,
171         BCONTEXT_WORLD,
172         BCONTEXT_OBJECT,
173         BCONTEXT_DATA,
174         BCONTEXT_MATERIAL,
175         BCONTEXT_TEXTURE,
176         BCONTEXT_PARTICLE,
177         BCONTEXT_PHYSICS,
178         BCONTEXT_BONE,
179         BCONTEXT_MODIFIER,
180         BCONTEXT_CONSTRAINT,
181         BCONTEXT_BONE_CONSTRAINT,
182         
183         /* always as last... */
184         BCONTEXT_TOT
185 } eSpaceButtons_Context;
186
187 /* sbuts->flag */
188 #define SB_PRV_OSA          1
189 #define SB_PIN_CONTEXT      2
190 //#define SB_WORLD_TEX          4       //not used anymore
191 //#define SB_BRUSH_TEX          8       //not used anymore      
192 #define SB_SHADING_CONTEXT  16
193
194 /* sbuts->texture_context */
195 typedef enum eSpaceButtons_Texture_Context {
196         SB_TEXC_MAT_OR_LAMP = 0,
197         SB_TEXC_WORLD,
198         SB_TEXC_BRUSH,
199         SB_TEXC_PARTICLES,
200 } eSpaceButtons_Texture_Context;
201
202 /* sbuts->align */
203 typedef enum eSpaceButtons_Align {
204         BUT_FREE = 0,
205         BUT_HORIZONTAL,
206         BUT_VERTICAL,
207         BUT_AUTO,
208 } eSpaceButtons_Align;
209
210 /* sbuts->scaflag */            
211 #define BUTS_SENS_SEL           1
212 #define BUTS_SENS_ACT           2
213 #define BUTS_SENS_LINK          4
214 #define BUTS_CONT_SEL           8
215 #define BUTS_CONT_ACT           16
216 #define BUTS_CONT_LINK          32
217 #define BUTS_ACT_SEL            64
218 #define BUTS_ACT_ACT            128
219 #define BUTS_ACT_LINK           256
220 #define BUTS_SENS_STATE         512
221 #define BUTS_ACT_STATE          1024
222 #define BUTS_CONT_INIT_STATE    2048
223
224
225 /* Outliner =============================================== */
226
227 /* Outliner */
228 typedef struct SpaceOops {
229         SpaceLink *next, *prev;
230         ListBase regionbase;        /* storage of regions for inactive spaces */
231         int spacetype;
232         float blockscale DNA_DEPRECATED;
233         short blockhandler[8]  DNA_DEPRECATED;
234
235         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
236         
237         ListBase tree;
238         struct TreeStore *treestore;
239         
240         /* search stuff */
241         char search_string[32];
242         struct TreeStoreElem search_tse;
243
244         short flag, outlinevis, storeflag, search_flags;
245 } SpaceOops;
246
247
248 /* SpaceOops->flag */
249 typedef enum eSpaceOutliner_Flag {
250         SO_TESTBLOCKS           = (1 << 0),
251         SO_NEWSELECTED          = (1 << 1),
252         SO_HIDE_RESTRICTCOLS    = (1 << 2),
253         SO_HIDE_KEYINGSETINFO   = (1 << 3),
254 } eSpaceOutliner_Flag;
255
256 /* SpaceOops->outlinevis */
257 typedef enum eSpaceOutliner_Mode {
258         SO_ALL_SCENES = 0,
259         SO_CUR_SCENE,
260         SO_VISIBLE,
261         SO_SELECTED,
262         SO_ACTIVE,
263         SO_SAME_TYPE,
264         SO_GROUPS,
265         SO_LIBRARIES,
266         SO_VERSE_SESSION,
267         SO_VERSE_MS,
268         SO_SEQUENCE,
269         SO_DATABLOCKS,
270         SO_USERDEF,
271         SO_KEYMAP,
272 } eSpaceOutliner_Mode;
273
274 /* SpaceOops->storeflag */
275 typedef enum eSpaceOutliner_StoreFlag {
276         /* rebuild tree */
277         SO_TREESTORE_CLEANUP    = (1 << 0),
278         /* if set, it allows redraws. gets set for some allqueue events */
279         SO_TREESTORE_REDRAW     = (1 << 1),
280 } eSpaceOutliner_StoreFlag;
281
282 /* outliner search flags (SpaceOops->search_flags) */
283 typedef enum eSpaceOutliner_Search_Flags {
284         SO_FIND_CASE_SENSITIVE  = (1 << 0),
285         SO_FIND_COMPLETE        = (1 << 1),
286         SO_SEARCH_RECURSIVE     = (1 << 2),
287 } eSpaceOutliner_Search_Flags;
288
289
290 /* Graph Editor ========================================= */
291
292 /* 'Graph' Editor (formerly known as the IPO Editor) */
293 typedef struct SpaceIpo {
294         SpaceLink *next, *prev;
295         ListBase regionbase;        /* storage of regions for inactive spaces */
296         int spacetype;
297         float blockscale DNA_DEPRECATED;
298         short blockhandler[8]  DNA_DEPRECATED;
299         
300         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
301         
302         struct bDopeSheet *ads; /* settings for filtering animation data (NOTE: we use a pointer due to code-linking issues) */
303         
304         ListBase ghostCurves;   /* sampled snapshots of F-Curves used as in-session guides */
305         
306         short mode;             /* mode for the Graph editor (eGraphEdit_Mode) */
307         short autosnap;         /* time-transform autosnapping settings for Graph editor (eAnimEdit_AutoSnap in DNA_action_types.h) */
308         int flag;               /* settings for Graph editor (eGraphEdit_Flag) */
309         
310         float cursorVal;        /* cursor value (y-value, x-value is current frame) */
311         int around;             /* pivot point for transforms */
312 } SpaceIpo;
313
314
315 /* SpaceIpo->flag (Graph Editor Settings) */
316 typedef enum eGraphEdit_Flag {
317         /* OLD DEPRECEATED SETTING */
318         /* SIPO_LOCK_VIEW            = (1 << 0), */
319         
320         /* don't merge keyframes on the same frame after a transform */
321         SIPO_NOTRANSKEYCULL       = (1 << 1),
322         /* don't show any keyframe handles at all */
323         SIPO_NOHANDLES            = (1 << 2),
324         /* don't show current frame number beside indicator line */
325         SIPO_NODRAWCFRANUM        = (1 << 3),
326         /* show timing in seconds instead of frames */
327         SIPO_DRAWTIME             = (1 << 4),
328         /* only show keyframes for selected F-Curves */
329         SIPO_SELCUVERTSONLY       = (1 << 5),
330         /* draw names of F-Curves beside the respective curves */
331         /* NOTE: currently not used */
332         SIPO_DRAWNAMES            = (1 << 6),
333         /* show sliders in channels list */
334         SIPO_SLIDERS              = (1 << 7),
335         /* don't show the horizontal component of the cursor */
336         SIPO_NODRAWCURSOR         = (1 << 8),
337         /* only show handles of selected keyframes */
338         SIPO_SELVHANDLESONLY      = (1 << 9),
339         /* temporary flag to force channel selections to be synced with main */
340         SIPO_TEMP_NEEDCHANSYNC    = (1 << 10),
341         /* don't perform realtime updates */
342         SIPO_NOREALTIMEUPDATES    = (1 << 11),
343         /* don't draw curves with AA ("beauty-draw") for performance */
344         SIPO_BEAUTYDRAW_OFF       = (1 << 12),
345         /* draw grouped channels with colors set in group */
346         SIPO_NODRAWGCOLORS        = (1 << 13),
347 } eGraphEdit_Flag;
348
349 /* SpaceIpo->mode (Graph Editor Mode) */
350 typedef enum eGraphEdit_Mode {
351         /* all animation curves (from all over Blender) */
352         SIPO_MODE_ANIMATION = 0,
353         /* drivers only */
354         SIPO_MODE_DRIVERS,
355 } eGraphEdit_Mode;
356
357
358 /* NLA Editor ============================================= */
359
360 /* NLA Editor */
361 typedef struct SpaceNla {
362         struct SpaceLink *next, *prev;
363         ListBase regionbase;        /* storage of regions for inactive spaces */
364         int spacetype;
365         float blockscale DNA_DEPRECATED;
366         short blockhandler[8]  DNA_DEPRECATED;
367
368         short autosnap;         /* this uses the same settings as autosnap for Action Editor */
369         short flag;
370         int pad;
371         
372         struct bDopeSheet *ads;
373         View2D v2d DNA_DEPRECATED;   /* deprecated, copied to region */
374 } SpaceNla;
375
376 /* nla->flag */
377 typedef enum eSpaceNla_Flag {
378         /* flags (1<<0), (1<<1), and (1<<3) are depreceated flags from old verisons */
379
380         /* draw timing in seconds instead of frames */
381         SNLA_DRAWTIME          = (1 << 2),
382         /* don't draw frame number beside frame indicator */
383         SNLA_NODRAWCFRANUM     = (1 << 4),
384         /* don't draw influence curves on strips */
385         SNLA_NOSTRIPCURVES     = (1 << 5),
386         /* don't perform realtime updates */
387         SNLA_NOREALTIMEUPDATES = (1 << 6),
388 } eSpaceNla_Flag;
389
390
391 /* Timeline =============================================== */
392
393 /* Pointcache drawing data */
394 # /* Only store the data array in the cache to avoid constant reallocation. */
395 # /* No need to store when saved. */
396 typedef struct SpaceTimeCache {
397         struct SpaceTimeCache *next, *prev;
398         float *array;
399 } SpaceTimeCache;
400
401 /* Timeline View */
402 typedef struct SpaceTime {
403         SpaceLink *next, *prev;
404         ListBase regionbase;        /* storage of regions for inactive spaces */
405         int spacetype;
406         float blockscale DNA_DEPRECATED;
407         
408         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
409
410         ListBase caches;
411
412         int cache_display;
413         int flag;
414 } SpaceTime;
415
416
417 /* time->flag */
418 typedef enum eTimeline_Flag {
419         /* show timing in frames instead of in seconds */
420         TIME_DRAWFRAMES    = (1 << 0),
421         /* show time indicator box beside the frame number */
422         TIME_CFRA_NUM      = (1 << 1),
423         /* only keyframes from active/selected channels get shown */
424         TIME_ONLYACTSEL    = (1 << 2),
425 } eTimeline_Flag;
426
427 /* time->redraws (now screen->redraws_flag) */
428 typedef enum eScreen_Redraws_Flag {
429         TIME_REGION            = (1 << 0),
430         TIME_ALL_3D_WIN        = (1 << 1),
431         TIME_ALL_ANIM_WIN      = (1 << 2),
432         TIME_ALL_BUTS_WIN      = (1 << 3),
433         TIME_WITH_SEQ_AUDIO    = (1 << 4), /* DEPRECATED */
434         TIME_SEQ               = (1 << 5),
435         TIME_ALL_IMAGE_WIN     = (1 << 6),
436         TIME_CONTINUE_PHYSICS  = (1 << 7),
437         TIME_NODES             = (1 << 8),
438         TIME_CLIPS             = (1 << 9),
439 } eScreen_Redraws_Flag;
440
441 /* time->cache */
442 typedef enum eTimeline_Cache_Flag {
443         TIME_CACHE_DISPLAY       = (1 << 0),
444         TIME_CACHE_SOFTBODY      = (1 << 1),
445         TIME_CACHE_PARTICLES     = (1 << 2),
446         TIME_CACHE_CLOTH         = (1 << 3),
447         TIME_CACHE_SMOKE         = (1 << 4),
448         TIME_CACHE_DYNAMICPAINT  = (1 << 5),
449 } eTimeline_Cache_Flag;
450
451
452 /* Sequence Editor ======================================= */
453
454 /* Sequencer */
455 typedef struct SpaceSeq {
456         SpaceLink *next, *prev;
457         ListBase regionbase;        /* storage of regions for inactive spaces */
458         int spacetype;
459         float blockscale DNA_DEPRECATED;
460
461         short blockhandler[8]  DNA_DEPRECATED;
462
463         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
464         
465         float xof DNA_DEPRECATED, yof DNA_DEPRECATED;   /* deprecated: offset for drawing the image preview */
466         short mainb;    /* weird name for the sequencer subtype (seq, image, luma... etc) */
467         short render_size;
468         short chanshown;
469         short zebra;
470         int flag;
471         float zoom DNA_DEPRECATED;  /* deprecated, handled by View2D now */
472         int view; /* see SEQ_VIEW_* below */
473         int pad;
474
475         struct bGPdata *gpd;        /* grease-pencil data */
476 } SpaceSeq;
477
478
479 /* sseq->mainb */
480 typedef enum eSpaceSeq_RegionType {
481         SEQ_DRAW_SEQUENCE = 0,
482         SEQ_DRAW_IMG_IMBUF,
483         SEQ_DRAW_IMG_WAVEFORM,
484         SEQ_DRAW_IMG_VECTORSCOPE,
485         SEQ_DRAW_IMG_HISTOGRAM,
486 } eSpaceSeq_RegionType;
487
488 /* sseq->flag */
489 typedef enum eSpaceSeq_Flag {
490         SEQ_DRAWFRAMES              = (1 << 0),
491         SEQ_MARKER_TRANS            = (1 << 1),
492         SEQ_DRAW_COLOR_SEPARATED    = (1 << 2),
493         SEQ_DRAW_SAFE_MARGINS       = (1 << 3),
494 /*  SEQ_DRAW_GPENCIL            = (1 << 4), */ /* DEPRECATED */
495         SEQ_NO_DRAW_CFRANUM         = (1 << 5),
496 } eSpaceSeq_Flag;
497
498 /* sseq->view */
499 typedef enum eSpaceSeq_Displays {
500         SEQ_VIEW_SEQUENCE = 1,
501         SEQ_VIEW_PREVIEW,
502         SEQ_VIEW_SEQUENCE_PREVIEW,
503 } eSpaceSeq_Dispays;
504
505 /* sseq->render_size */
506 typedef enum eSpaceSeq_Proxy_RenderSize {
507         SEQ_PROXY_RENDER_SIZE_NONE      =  -1,
508         SEQ_PROXY_RENDER_SIZE_SCENE     =   0,
509         SEQ_PROXY_RENDER_SIZE_25        =  25,
510         SEQ_PROXY_RENDER_SIZE_50        =  50,
511         SEQ_PROXY_RENDER_SIZE_75        =  75,
512         SEQ_PROXY_RENDER_SIZE_100       =  99,
513         SEQ_PROXY_RENDER_SIZE_FULL      = 100
514 } eSpaceSeq_Proxy_RenderSize;
515
516
517 /* File Selector ========================================== */
518
519 /* Config and Input for File Selector */
520 typedef struct FileSelectParams {
521         char title[32]; /* title, also used for the text of the execute button */
522         char dir[1056]; /* directory, FILE_MAX_LIBEXTRA, 1024 + 32, this is for extreme case when 1023 length path
523                          * needs to be linked in, where foo.blend/Armature need adding  */
524         char file[256]; /* file */
525         char renamefile[256];
526         char renameedit[256]; /* annoying but the first is only used for initialization */
527
528         char filter_glob[64]; /* list of filetypes to filter */
529
530         int active_file;
531         int sel_first;
532         int sel_last;
533
534         /* short */
535         short type; /* XXXXX for now store type here, should be moved to the operator */
536         short flag; /* settings for filter, hiding dots files,...  */
537         short sort; /* sort order */
538         short display; /* display mode flag */
539         short filter; /* filter when (flags & FILE_FILTER) is true */
540
541         /* XXX --- still unused -- */
542         short f_fp; /* show font preview */
543         char fp_str[8]; /* string to use for font preview */
544
545         /* XXX --- end unused -- */
546 } FileSelectParams;
547
548 /* File Browser */
549 typedef struct SpaceFile {
550         SpaceLink *next, *prev;
551         ListBase regionbase;        /* storage of regions for inactive spaces */
552         int spacetype;
553         
554         int scroll_offset;
555
556         struct FileSelectParams *params; /* config and input for file select */
557         
558         struct FileList *files; /* holds the list of files to show */
559
560         ListBase *folders_prev; /* holds the list of previous directories to show */
561         ListBase *folders_next; /* holds the list of next directories (pushed from previous) to show */
562
563         /* operator that is invoking fileselect 
564          * op->exec() will be called on the 'Load' button.
565          * if operator provides op->cancel(), then this will be invoked
566          * on the cancel button.
567          */
568         struct wmOperator *op; 
569
570         struct wmTimer *smoothscroll_timer;
571
572         struct FileLayout *layout;
573         
574         short recentnr, bookmarknr;
575         short systemnr, pad2;
576 } SpaceFile;
577
578
579 /* FileSelectParams.display */
580 enum FileDisplayTypeE {
581         FILE_DEFAULTDISPLAY = 0,
582         FILE_SHORTDISPLAY,
583         FILE_LONGDISPLAY,
584         FILE_IMGDISPLAY
585 };
586
587 /* FileSelectParams.sort */
588 enum FileSortTypeE {
589         FILE_SORT_NONE = 0,
590         FILE_SORT_ALPHA = 1,
591         FILE_SORT_EXTENSION,
592         FILE_SORT_TIME,
593         FILE_SORT_SIZE
594 };
595
596 /* these values need to be hardcoded in structs, dna does not recognize defines */
597 /* also defined in BKE */
598 #define FILE_MAXDIR         768
599 #define FILE_MAXFILE        256
600 #define FILE_MAX            1024
601
602 #define FILE_MAX_LIBEXTRA   (FILE_MAX + 32)
603
604 /* filesel types */
605 #define FILE_UNIX           8
606 #define FILE_BLENDER        8 /* don't display relative paths */
607 #define FILE_SPECIAL        9
608
609 #define FILE_LOADLIB        1
610 #define FILE_MAIN           2
611 #define FILE_LOADFONT       3
612
613 /* filesel op property -> action */
614 typedef enum eFileSel_Action {
615         FILE_OPENFILE = 0,
616         FILE_SAVE,
617 } eFileSel_Action;
618
619 /* sfile->params->flag and simasel->flag */
620 typedef enum eFileSel_Params_Flag {
621         FILE_SHOWSHORT      = (1 << 0),
622         FILE_RELPATH        = (1 << 1), /* was FILE_STRINGCODE */
623         FILE_LINK           = (1 << 2),
624         FILE_HIDE_DOT       = (1 << 3),
625         FILE_AUTOSELECT     = (1 << 4),
626         FILE_ACTIVELAY      = (1 << 5),
627 /*  FILE_ATCURSOR       = (1 << 6), */ /* deprecated */
628         FILE_DIRSEL_ONLY    = (1 << 7),
629         FILE_FILTER         = (1 << 8),
630         FILE_BOOKMARKS      = (1 << 9),
631         FILE_GROUP_INSTANCE = (1 << 10),
632 } eFileSel_Params_Flag;
633
634
635 /* files in filesel list: file types */
636 typedef enum eFileSel_File_Types {
637         BLENDERFILE         = (1 << 2),
638         BLENDERFILE_BACKUP  = (1 << 3),
639         IMAGEFILE           = (1 << 4),
640         MOVIEFILE           = (1 << 5),
641         PYSCRIPTFILE        = (1 << 6),
642         FTFONTFILE          = (1 << 7),
643         SOUNDFILE           = (1 << 8),
644         TEXTFILE            = (1 << 9),
645         MOVIEFILE_ICON      = (1 << 10), /* movie file that preview can't load */
646         FOLDERFILE          = (1 << 11), /* represents folders for filtering */
647         BTXFILE             = (1 << 12),
648         COLLADAFILE         = (1 << 13),
649         OPERATORFILE        = (1 << 14), /* from filter_glob operator property */
650 } eFileSel_File_Types;
651
652 /* Selection Flags in filesel: struct direntry, unsigned char selflag */
653 typedef enum eDirEntry_SelectFlag {
654 /*  ACTIVE_FILE         = (1 << 1), */ /* UNUSED */
655         HILITED_FILE        = (1 << 2),
656         SELECTED_FILE       = (1 << 3),
657         EDITING_FILE        = (1 << 4),
658 } eDirEntry_SelectFlag;
659
660 /* Image/UV Editor ======================================== */
661
662 /* Image/UV Editor */
663 typedef struct SpaceImage {
664         SpaceLink *next, *prev;
665         ListBase regionbase;        /* storage of regions for inactive spaces */
666         int spacetype;
667
668         int flag;
669
670         struct Image *image;
671         struct ImageUser iuser;
672         struct CurveMapping *cumap;             
673         
674         struct Scopes scopes;           /* histogram waveform and vectorscope */
675         struct Histogram sample_line_hist;  /* sample line histogram */
676
677         struct bGPdata *gpd;            /* grease pencil data */
678
679         float cursor[2];                /* UV editor 2d cursor */
680         float xof, yof;                 /* user defined offset, image is centered */
681         float zoom;                     /* user defined zoom level */
682         float centx, centy;             /* storage for offset while render drawing */
683
684         short curtile; /* the currently active tile of the image when tile is enabled, is kept in sync with the active faces tile */
685         short pad;
686         short lock;
687         short pin;
688         char dt_uv; /* UV draw type */
689         char sticky; /* sticky selection type */
690         char dt_uvstretch;
691         char around;
692 } SpaceImage;
693
694
695 /* SpaceImage->dt_uv */
696 typedef enum eSpaceImage_UVDT {
697         SI_UVDT_OUTLINE = 0,
698         SI_UVDT_DASH,
699         SI_UVDT_BLACK,
700         SI_UVDT_WHITE,
701 } eSpaceImage_UVDT;
702
703 /* SpaceImage->dt_uvstretch */
704 typedef enum eSpaceImage_UVDT_Stretch {
705         SI_UVDT_STRETCH_ANGLE = 0,
706         SI_UVDT_STRETCH_AREA,
707 } eSpaceImage_UVDT_Stretch;
708
709 /* SpaceImage->sticky
710  * Note DISABLE should be 0, however would also need to re-arrange icon order,
711  * also, sticky loc is the default mode so this means we don't need to 'do_versons' */
712 typedef enum eSpaceImage_Sticky {
713         SI_STICKY_LOC      = 0,
714         SI_STICKY_DISABLE  = 1,
715         SI_STICKY_VERTEX   = 2,
716 } eSpaceImage_Sticky;
717
718 /* SpaceImage->flag */
719 typedef enum eSpaceImage_Flag {
720         SI_BE_SQUARE          = (1 << 0),
721         SI_EDITTILE           = (1 << 1),
722         SI_CLIP_UV            = (1 << 2),
723         SI_DRAWTOOL           = (1 << 3),
724         SI_NO_DRAWFACES       = (1 << 4),
725         SI_DRAWSHADOW         = (1 << 5),
726 /*  SI_SELACTFACE         = (1 << 6), */ /* deprecated */
727         SI_DEPRECATED2        = (1 << 7),
728         SI_DEPRECATED3        = (1 << 8),   /* stick UV selection to mesh vertex (UVs wont always be touching) */
729         SI_COORDFLOATS        = (1 << 9),
730         SI_PIXELSNAP          = (1 << 10),
731         SI_LIVE_UNWRAP        = (1 << 11),
732         SI_USE_ALPHA          = (1 << 12),
733         SI_SHOW_ALPHA         = (1 << 13),
734         SI_SHOW_ZBUF          = (1 << 14),
735         
736         /* next two for render window display */
737         SI_PREVSPACE          = (1 << 15),
738         SI_FULLWINDOW         = (1 << 16),
739         
740         SI_DEPRECATED4        = (1 << 17),
741         SI_DEPRECATED5        = (1 << 18),
742         
743         /* this means that the image is drawn until it reaches the view edge,
744          * in the image view, its unrelated to the 'tile' mode for texface
745          */
746         SI_DRAW_TILE          = (1 << 19),
747         SI_SMOOTH_UV          = (1 << 20),
748         SI_DRAW_STRETCH       = (1 << 21),
749 /*  SI_DISPGP             = (1 << 22), */ /* DEPRECATED */
750         SI_DRAW_OTHER         = (1 << 23),
751
752         SI_COLOR_CORRECTION   = (1 << 24),
753 } eSpaceImage_Flag;
754
755 /* Text Editor ============================================ */
756
757 /* Text Editor */
758 typedef struct SpaceText {
759         SpaceLink *next, *prev;
760         ListBase regionbase;        /* storage of regions for inactive spaces */
761         int spacetype;
762         float blockscale DNA_DEPRECATED;
763         short blockhandler[8]  DNA_DEPRECATED;
764
765         struct Text *text;      
766
767         int top, viewlines;
768         short flags, menunr;    
769
770         short lheight;      /* user preference */
771         char cwidth, linenrs_tot;       /* runtime computed, character width and the number of chars to use when showing line numbers */
772         int left;
773         int showlinenrs;
774         int tabnumber;
775
776         short showsyntax;
777         short line_hlight;
778         short overwrite;
779         short live_edit; /* run python while editing, evil */
780         float pix_per_line;
781
782         struct rcti txtscroll, txtbar;
783
784         int wordwrap, doplugins;
785
786         char findstr[256];      /* ST_MAX_FIND_STR */
787         char replacestr[256];   /* ST_MAX_FIND_STR */
788
789         short margin_column; /* column number to show right margin at */
790         char pad[6];
791
792         void *drawcache; /* cache for faster drawing */
793 } SpaceText;
794
795
796 /* SpaceText flags (moved from DNA_text_types.h) */
797 typedef enum eSpaceText_Flags {
798         /* scrollable */
799         ST_SCROLL_SELECT        = (1 << 0),
800         /* clear namespace after script execution (BPY_main.c) */
801         ST_CLEAR_NAMESPACE      = (1 << 4), 
802         
803         ST_FIND_WRAP            = (1 << 5),
804         ST_FIND_ALL             = (1 << 6),
805         ST_SHOW_MARGIN          = (1 << 7),
806         ST_MATCH_CASE           = (1 << 8),
807 } eSpaceText_Flags;
808
809 /* stext->findstr/replacestr */
810 #define ST_MAX_FIND_STR     256
811
812 /* Script View (Obsolete) ================================== */
813
814 /* Script Runtime Data - Obsolete (pre 2.5) */
815 typedef struct Script {
816         ID id;
817
818         void *py_draw;
819         void *py_event;
820         void *py_button;
821         void *py_browsercallback;
822         void *py_globaldict;
823
824         int flags, lastspace;
825         /* store the script file here so we can re-run it on loading blender, if "Enable Scripts" is on */
826         char scriptname[1024]; /* 1024 = FILE_MAX */
827         char scriptarg[256]; /* 1024 = FILE_MAX */
828 } Script;
829 #define SCRIPT_SET_NULL(_script) _script->py_draw = _script->py_event = _script->py_button = _script->py_browsercallback = _script->py_globaldict = NULL; _script->flags = 0
830
831 /* Script View - Obsolete (pre 2.5) */
832 typedef struct SpaceScript {
833         SpaceLink *next, *prev;
834         ListBase regionbase;        /* storage of regions for inactive spaces */
835         int spacetype;
836         float blockscale DNA_DEPRECATED;
837         struct Script *script;
838
839         short flags, menunr;
840         int pad1;
841         
842         void *but_refs;
843 } SpaceScript;
844
845 /* Nodes Editor =========================================== */
846
847 /* Node Editor */
848 typedef struct SpaceNode {
849         SpaceLink *next, *prev;
850         ListBase regionbase;        /* storage of regions for inactive spaces */
851         int spacetype;
852         float blockscale DNA_DEPRECATED;
853         short blockhandler[8]  DNA_DEPRECATED;
854         
855         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
856         
857         struct ID *id, *from;       /* context, no need to save in file? well... pinning... */
858         short flag, pad1;           /* menunr: browse id block in header */
859         float aspect;
860         
861         float xof, yof;     /* offset for drawing the backdrop */
862         float zoom, padf;   /* zoom for backdrop */
863         float mx, my;       /* mousepos for drawing socketless link */
864         
865         struct bNodeTree *nodetree, *edittree;
866         int treetype;       /* treetype: as same nodetree->type */
867         short texfrom;      /* texfrom object, world or brush */
868         short shaderfrom;   /* shader from object or world */
869         short recalc;       /* currently on 0/1, for auto compo */
870         short pad[3];
871         ListBase linkdrag;  /* temporary data for modal linking operator */
872         
873         struct bGPdata *gpd;        /* grease-pencil data */
874 } SpaceNode;
875
876 /* snode->flag */
877 typedef enum eSpaceNode_Flag {
878         SNODE_BACKDRAW     = (1 << 1),
879 /*  SNODE_DISPGP       = (1 << 2), */ /* XXX: Grease Pencil - deprecated? */
880         SNODE_USE_ALPHA    = (1 << 3),
881         SNODE_SHOW_ALPHA   = (1 << 4),
882         SNODE_AUTO_RENDER  = (1 << 5),
883 } eSpaceNode_Flag;
884
885 /* snode->texfrom */
886 typedef enum eSpaceNode_TexFrom {
887         SNODE_TEX_OBJECT   = 0,
888         SNODE_TEX_WORLD,
889         SNODE_TEX_BRUSH,
890 } eSpaceNode_TexFrom;
891
892 /* snode->shaderfrom */
893 typedef enum eSpaceNode_ShaderFrom {
894         SNODE_SHADER_OBJECT = 0,
895         SNODE_SHADER_WORLD,
896 } eSpaceNode_ShaderFrom;
897
898 /* Game Logic Editor ===================================== */
899
900 /* Logic Editor */
901 typedef struct SpaceLogic {
902         SpaceLink *next, *prev;
903         ListBase regionbase;        /* storage of regions for inactive spaces */
904         int spacetype;
905         float blockscale DNA_DEPRECATED;
906         
907         short blockhandler[8]  DNA_DEPRECATED;
908         
909         short flag, scaflag;
910         int pad;
911         
912         struct bGPdata *gpd;        /* grease-pencil data */
913 } SpaceLogic;
914
915 /* Console ================================================ */
916
917 /* Console content */
918 typedef struct ConsoleLine {
919         struct ConsoleLine *next, *prev;
920         
921         /* keep these 3 vars so as to share free, realloc funcs */
922         int len_alloc;  /* allocated length */
923         int len;    /* real len - strlen() */
924         char *line; 
925         
926         int cursor;
927         int type; /* only for use when in the 'scrollback' listbase */
928 } ConsoleLine;
929
930 /* ConsoleLine.type */
931 typedef enum eConsoleLine_Type {
932         CONSOLE_LINE_OUTPUT = 0,
933         CONSOLE_LINE_INPUT,
934         CONSOLE_LINE_INFO, /* autocomp feedback */
935         CONSOLE_LINE_ERROR
936 } eConsoleLine_Type;
937
938
939 /* Console View */
940 typedef struct SpaceConsole {
941         SpaceLink *next, *prev;
942         ListBase regionbase;        /* storage of regions for inactive spaces */
943         int spacetype;
944         float blockscale DNA_DEPRECATED;            // XXX are these needed?
945         short blockhandler[8]  DNA_DEPRECATED;      // XXX are these needed?
946         
947         /* space vars */
948         int lheight, pad;
949
950         ListBase scrollback; /* ConsoleLine; output */
951         ListBase history; /* ConsoleLine; command history, current edited line is the first */
952         char prompt[256];
953         char language[32]; /* multiple consoles are possible, not just python */
954         
955         int sel_start;
956         int sel_end;
957 } SpaceConsole;
958
959
960 /* User Preferences ======================================= */
961
962 /* User Preferences View */
963 typedef struct SpaceUserPref {
964         SpaceLink *next, *prev;
965         ListBase regionbase;        /* storage of regions for inactive spaces */
966         int spacetype;
967         
968         int pad;
969         
970         char filter[64];        /* search term for filtering in the UI */
971 } SpaceUserPref;
972
973 /* Motion Tracking ======================================== */
974
975 /* Clip Editor */
976 typedef struct SpaceClip {
977         SpaceLink *next, *prev;
978         ListBase regionbase;        /* storage of regions for inactive spaces */
979         int spacetype;
980
981         float xof, yof;             /* user defined offset, image is centered */
982         float xlockof, ylockof;     /* user defined offset from locked position */
983         float zoom;                 /* user defined zoom level */
984
985         struct MovieClipUser user;      /* user of clip */
986         struct MovieClip *clip;         /* clip data */
987         struct MovieClipScopes scopes;  /* different scoped displayed in space panels */
988
989         int flag;                   /* flags */
990         short mode;                 /* editor mode (editing context being displayed) */
991         short view;                 /* type of the clip editor view */
992
993         int path_length;            /* length of displaying path, in frames */
994
995         /* current stabilization data */
996         float loc[2], scale, angle; /* pre-composed stabilization data */
997         int pad;
998         float stabmat[4][4], unistabmat[4][4];  /* current stabilization matrix and the same matrix in unified space,
999                                                  * defined when drawing and used for mouse position calculation */
1000
1001         /* movie postprocessing */
1002         int postproc_flag;
1003
1004         /* grease pencil */
1005         short gpencil_src, pad2;
1006
1007         void *draw_context;
1008
1009         /* dopesheet */
1010         short dope_sort;        /* sort order in dopesheet view */
1011         short dope_flag;        /* dopsheet view flags */
1012
1013         int around;             /* pivot point for transforms */
1014
1015         /* **** mask editing **** */
1016         struct Mask *mask;
1017         /* draw options */
1018         char mask_draw_flag;
1019         char mask_draw_type;
1020         char pad3[6];
1021 } SpaceClip;
1022
1023 /* SpaceClip->flag */
1024 typedef enum eSpaceClip_Flag {
1025         SC_SHOW_MARKER_PATTERN = (1 << 0),
1026         SC_SHOW_MARKER_SEARCH  = (1 << 1),
1027         SC_LOCK_SELECTION      = (1 << 2),
1028         SC_SHOW_TINY_MARKER    = (1 << 3),
1029         SC_SHOW_TRACK_PATH     = (1 << 4),
1030         SC_SHOW_BUNDLES        = (1 << 5),
1031         SC_MUTE_FOOTAGE        = (1 << 6),
1032         SC_HIDE_DISABLED       = (1 << 7),
1033         SC_SHOW_NAMES          = (1 << 8),
1034         SC_SHOW_GRID           = (1 << 9),
1035         SC_SHOW_STABLE         = (1 << 10),
1036         SC_MANUAL_CALIBRATION  = (1 << 11),
1037 /*      SC_SHOW_GPENCIL        = (1 << 12),*/   /* UNUSED */
1038         SC_SHOW_FILTERS        = (1 << 13),
1039         SC_SHOW_GRAPH_FRAMES   = (1 << 14),
1040         SC_SHOW_GRAPH_TRACKS   = (1 << 15),
1041 /*      SC_SHOW_PYRAMID_LEVELS = (1 << 16), */  /* UNUSED */
1042         SC_LOCK_TIMECURSOR     = (1 << 17),
1043         SC_SHOW_SECONDS        = (1 << 18),
1044 } eSpaceClip_Flag;
1045
1046 /* SpaceClip->mode */
1047 typedef enum eSpaceClip_Mode {
1048         SC_MODE_TRACKING = 0,
1049         SC_MODE_RECONSTRUCTION,
1050         SC_MODE_DISTORTION,
1051         SC_MODE_MASKEDIT,
1052 } eSpaceClip_Mode;
1053
1054 /* SpaceClip->view */
1055 typedef enum eSpaceClip_View {
1056         SC_VIEW_CLIP = 0,
1057         SC_VIEW_GRAPH,
1058         SC_VIEW_DOPESHEET,
1059 } eSpaceClip_View;
1060
1061 /* SpaceClip->dope_sort */
1062 typedef enum eSpaceClip_Dopesheet_Sort {
1063         SC_DOPE_SORT_NAME = 0,
1064         SC_DOPE_SORT_LONGEST,
1065         SC_DOPE_SORT_TOTAL,
1066         SC_DOPE_SORT_AVERAGE_ERROR,
1067 } eSpaceClip_Dopesheet_Sort;
1068
1069 /* SpaceClip->dope_flag */
1070 typedef enum eSpaceClip_Dopesheet_Flag {
1071         SC_DOPE_SORT_INVERSE    = (1 << 0),
1072 } eSpaceClip_Dopesheet_Flag;
1073
1074 /* SpaceClip->gpencil_src */
1075 typedef enum eSpaceClip_GPencil_Source {
1076         SC_GPENCIL_SRC_CLIP = 0,
1077         SC_GPENCIL_SRC_TRACK = 1,
1078 } eSpaceClip_GPencil_Source;
1079
1080 /* **************** SPACE DEFINES ********************* */
1081
1082 /* headerbuttons: 450-499 */
1083 #define B_IMASELHOME        451
1084 #define B_IMASELREMOVEBIP   452
1085
1086
1087 /* space types, moved from DNA_screen_types.h */
1088 /* Do NOT change order, append on end. types are hardcoded needed */
1089 typedef enum eSpace_Type {
1090         SPACE_EMPTY,
1091         SPACE_VIEW3D,
1092         SPACE_IPO,
1093         SPACE_OUTLINER,
1094         SPACE_BUTS,
1095         SPACE_FILE,
1096         SPACE_IMAGE,            
1097         SPACE_INFO,
1098         SPACE_SEQ,
1099         SPACE_TEXT,
1100         SPACE_IMASEL, /* deprecated */
1101         SPACE_SOUND, /* Deprecated */
1102         SPACE_ACTION,
1103         SPACE_NLA,
1104         SPACE_SCRIPT, /* Deprecated */
1105         SPACE_TIME,
1106         SPACE_NODE,
1107         SPACE_LOGIC,
1108         SPACE_CONSOLE,
1109         SPACE_USERPREF,
1110         SPACE_CLIP,
1111         
1112         SPACEICONMAX = SPACE_CLIP
1113 } eSpace_Type;
1114
1115 #endif