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