Option to overlay mask over the footage
[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 overlay_mode;
550         char pad3[5];
551 } MaskSpaceInfo;
552
553 /* sseq->mainb */
554 typedef enum eSpaceSeq_OverlayType {
555         SEQ_DRAW_OVERLAY_RECT = 0,
556         SEQ_DRAW_OVERLAY_REFERENCE = 1,
557         SEQ_DRAW_OVERLAY_CURRENT = 2
558 } eSpaceSeq_OverlayType;
559
560 /* File Selector ========================================== */
561
562 /* Config and Input for File Selector */
563 typedef struct FileSelectParams {
564         char title[96]; /* title, also used for the text of the execute button */
565         char dir[1056]; /* directory, FILE_MAX_LIBEXTRA, 1024 + 32, this is for extreme case when 1023 length path
566                          * needs to be linked in, where foo.blend/Armature need adding  */
567         char file[256]; /* file */
568         char renamefile[256];
569         char renameedit[256]; /* annoying but the first is only used for initialization */
570
571         char filter_glob[64]; /* list of filetypes to filter */
572
573         int active_file;
574         int sel_first;
575         int sel_last;
576
577         /* short */
578         short type; /* XXXXX for now store type here, should be moved to the operator */
579         short flag; /* settings for filter, hiding dots files,...  */
580         short sort; /* sort order */
581         short display; /* display mode flag */
582         short filter; /* filter when (flags & FILE_FILTER) is true */
583
584         /* XXX --- still unused -- */
585         short f_fp; /* show font preview */
586         char fp_str[8]; /* string to use for font preview */
587
588         /* XXX --- end unused -- */
589 } FileSelectParams;
590
591 /* File Browser */
592 typedef struct SpaceFile {
593         SpaceLink *next, *prev;
594         ListBase regionbase;        /* storage of regions for inactive spaces */
595         int spacetype;
596         
597         int scroll_offset;
598
599         struct FileSelectParams *params; /* config and input for file select */
600         
601         struct FileList *files; /* holds the list of files to show */
602
603         ListBase *folders_prev; /* holds the list of previous directories to show */
604         ListBase *folders_next; /* holds the list of next directories (pushed from previous) to show */
605
606         /* operator that is invoking fileselect 
607          * op->exec() will be called on the 'Load' button.
608          * if operator provides op->cancel(), then this will be invoked
609          * on the cancel button.
610          */
611         struct wmOperator *op; 
612
613         struct wmTimer *smoothscroll_timer;
614
615         struct FileLayout *layout;
616         
617         short recentnr, bookmarknr;
618         short systemnr, pad2;
619 } SpaceFile;
620
621
622 /* FileSelectParams.display */
623 enum FileDisplayTypeE {
624         FILE_DEFAULTDISPLAY = 0,
625         FILE_SHORTDISPLAY = 1,
626         FILE_LONGDISPLAY = 2,
627         FILE_IMGDISPLAY = 3
628 };
629
630 /* FileSelectParams.sort */
631 enum FileSortTypeE {
632         FILE_SORT_NONE = 0,
633         FILE_SORT_ALPHA = 1,
634         FILE_SORT_EXTENSION = 2,
635         FILE_SORT_TIME = 3,
636         FILE_SORT_SIZE = 4
637 };
638
639 /* these values need to be hardcoded in structs, dna does not recognize defines */
640 /* also defined in BKE */
641 #define FILE_MAXDIR         768
642 #define FILE_MAXFILE        256
643 #define FILE_MAX            1024
644
645 #define FILE_MAX_LIBEXTRA   (FILE_MAX + MAX_ID_NAME)
646
647 /* filesel types */
648 #define FILE_UNIX           8
649 #define FILE_BLENDER        8 /* don't display relative paths */
650 #define FILE_SPECIAL        9
651
652 #define FILE_LOADLIB        1
653 #define FILE_MAIN           2
654 #define FILE_LOADFONT       3
655
656 /* filesel op property -> action */
657 typedef enum eFileSel_Action {
658         FILE_OPENFILE = 0,
659         FILE_SAVE = 1,
660 } eFileSel_Action;
661
662 /* sfile->params->flag and simasel->flag */
663 typedef enum eFileSel_Params_Flag {
664         FILE_SHOWSHORT      = (1 << 0),
665         FILE_RELPATH        = (1 << 1), /* was FILE_STRINGCODE */
666         FILE_LINK           = (1 << 2),
667         FILE_HIDE_DOT       = (1 << 3),
668         FILE_AUTOSELECT     = (1 << 4),
669         FILE_ACTIVELAY      = (1 << 5),
670 /*  FILE_ATCURSOR       = (1 << 6), */ /* deprecated */
671         FILE_DIRSEL_ONLY    = (1 << 7),
672         FILE_FILTER         = (1 << 8),
673         FILE_BOOKMARKS      = (1 << 9),
674         FILE_GROUP_INSTANCE = (1 << 10),
675 } eFileSel_Params_Flag;
676
677
678 /* files in filesel list: file types */
679 typedef enum eFileSel_File_Types {
680         BLENDERFILE         = (1 << 2),
681         BLENDERFILE_BACKUP  = (1 << 3),
682         IMAGEFILE           = (1 << 4),
683         MOVIEFILE           = (1 << 5),
684         PYSCRIPTFILE        = (1 << 6),
685         FTFONTFILE          = (1 << 7),
686         SOUNDFILE           = (1 << 8),
687         TEXTFILE            = (1 << 9),
688         MOVIEFILE_ICON      = (1 << 10), /* movie file that preview can't load */
689         FOLDERFILE          = (1 << 11), /* represents folders for filtering */
690         BTXFILE             = (1 << 12),
691         COLLADAFILE         = (1 << 13),
692         OPERATORFILE        = (1 << 14), /* from filter_glob operator property */
693 } eFileSel_File_Types;
694
695 /* Selection Flags in filesel: struct direntry, unsigned char selflag */
696 typedef enum eDirEntry_SelectFlag {
697 /*  ACTIVE_FILE         = (1 << 1), */ /* UNUSED */
698         HILITED_FILE        = (1 << 2),
699         SELECTED_FILE       = (1 << 3),
700         EDITING_FILE        = (1 << 4),
701 } eDirEntry_SelectFlag;
702
703 /* Image/UV Editor ======================================== */
704
705 /* Image/UV Editor */
706 typedef struct SpaceImage {
707         SpaceLink *next, *prev;
708         ListBase regionbase;        /* storage of regions for inactive spaces */
709         int spacetype;
710
711         int flag;
712
713         struct Image *image;
714         struct ImageUser iuser;
715
716         struct CurveMapping *cumap DNA_DEPRECATED;  /* was switched to scene's color management settings */
717
718         struct Scopes scopes;           /* histogram waveform and vectorscope */
719         struct Histogram sample_line_hist;  /* sample line histogram */
720
721         struct bGPdata *gpd;            /* grease pencil data */
722
723         float cursor[2];                /* UV editor 2d cursor */
724         float xof, yof;                 /* user defined offset, image is centered */
725         float zoom;                     /* user defined zoom level */
726         float centx, centy;             /* storage for offset while render drawing */
727
728         char  mode;                     /* view/paint/mask */
729         char  pin;
730         short pad;
731         short curtile; /* the currently active tile of the image when tile is enabled, is kept in sync with the active faces tile */
732         short lock;
733         char dt_uv; /* UV draw type */
734         char sticky; /* sticky selection type */
735         char dt_uvstretch;
736         char around;
737
738         MaskSpaceInfo mask_info;
739 } SpaceImage;
740
741
742 /* SpaceImage->dt_uv */
743 typedef enum eSpaceImage_UVDT {
744         SI_UVDT_OUTLINE = 0,
745         SI_UVDT_DASH = 1,
746         SI_UVDT_BLACK = 2,
747         SI_UVDT_WHITE = 3,
748 } eSpaceImage_UVDT;
749
750 /* SpaceImage->dt_uvstretch */
751 typedef enum eSpaceImage_UVDT_Stretch {
752         SI_UVDT_STRETCH_ANGLE = 0,
753         SI_UVDT_STRETCH_AREA = 1,
754 } eSpaceImage_UVDT_Stretch;
755
756 /* SpaceImage->mode */
757 typedef enum eSpaceImage_Mode {
758         SI_MODE_VIEW  = 0,
759         SI_MODE_PAINT = 1,
760         SI_MODE_MASK  = 2   /* note: mesh edit mode overrides mask */
761 } eSpaceImage_Mode;
762
763 /* SpaceImage->sticky
764  * Note DISABLE should be 0, however would also need to re-arrange icon order,
765  * also, sticky loc is the default mode so this means we don't need to 'do_versons' */
766 typedef enum eSpaceImage_Sticky {
767         SI_STICKY_LOC      = 0,
768         SI_STICKY_DISABLE  = 1,
769         SI_STICKY_VERTEX   = 2,
770 } eSpaceImage_Sticky;
771
772 /* SpaceImage->flag */
773 typedef enum eSpaceImage_Flag {
774 /*      SI_BE_SQUARE          = (1 << 0), */  /* deprecated */
775         SI_EDITTILE           = (1 << 1),     /* XXX - not used but should be? */
776         SI_CLIP_UV            = (1 << 2),
777 /*      SI_DRAWTOOL           = (1 << 3), */  /* deprecated */
778         SI_NO_DRAWFACES       = (1 << 4),
779         SI_DRAWSHADOW         = (1 << 5),
780 /*      SI_SELACTFACE         = (1 << 6), */  /* deprecated */
781 /*      SI_DEPRECATED2        = (1 << 7), */  /* deprecated */
782 /*      SI_DEPRECATED3        = (1 << 8), */  /* deprecated */
783         SI_COORDFLOATS        = (1 << 9),
784         SI_PIXELSNAP          = (1 << 10),
785         SI_LIVE_UNWRAP        = (1 << 11),
786         SI_USE_ALPHA          = (1 << 12),
787         SI_SHOW_ALPHA         = (1 << 13),
788         SI_SHOW_ZBUF          = (1 << 14),
789         
790         /* next two for render window display */
791         SI_PREVSPACE          = (1 << 15),
792         SI_FULLWINDOW         = (1 << 16),
793         
794 /*      SI_DEPRECATED4        = (1 << 17), */  /* deprecated */
795 /*      SI_DEPRECATED5        = (1 << 18), */  /* deprecated */
796         
797         /* this means that the image is drawn until it reaches the view edge,
798          * in the image view, its unrelated to the 'tile' mode for texface
799          */
800         SI_DRAW_TILE          = (1 << 19),
801         SI_SMOOTH_UV          = (1 << 20),
802         SI_DRAW_STRETCH       = (1 << 21),
803         SI_SHOW_GPENCIL       = (1 << 22),
804         SI_DRAW_OTHER         = (1 << 23),
805
806         SI_COLOR_CORRECTION   = (1 << 24),
807 } eSpaceImage_Flag;
808
809 /* Text Editor ============================================ */
810
811 /* Text Editor */
812 typedef struct SpaceText {
813         SpaceLink *next, *prev;
814         ListBase regionbase;        /* storage of regions for inactive spaces */
815         int spacetype;
816         float blockscale DNA_DEPRECATED;
817         short blockhandler[8]  DNA_DEPRECATED;
818
819         struct Text *text;
820
821         int top, viewlines;
822         short flags, menunr;
823
824         short lheight;      /* user preference, is font_size! */
825         char cwidth, linenrs_tot;       /* runtime computed, character width and the number of chars to use when showing line numbers */
826         int left;
827         int showlinenrs;
828         int tabnumber;
829
830         short showsyntax;
831         short line_hlight;
832         short overwrite;
833         short live_edit; /* run python while editing, evil */
834         float pix_per_line;
835
836         struct rcti txtscroll, txtbar;
837
838         int wordwrap, doplugins;
839
840         char findstr[256];      /* ST_MAX_FIND_STR */
841         char replacestr[256];   /* ST_MAX_FIND_STR */
842
843         short margin_column;    /* column number to show right margin at */
844         short lheight_dpi;              /* actual lineheight, dpi controlled */
845         char pad[4];
846
847         void *drawcache; /* cache for faster drawing */
848 } SpaceText;
849
850
851 /* SpaceText flags (moved from DNA_text_types.h) */
852 typedef enum eSpaceText_Flags {
853         /* scrollable */
854         ST_SCROLL_SELECT        = (1 << 0),
855         /* clear namespace after script execution (BPY_main.c) */
856         ST_CLEAR_NAMESPACE      = (1 << 4), 
857         
858         ST_FIND_WRAP            = (1 << 5),
859         ST_FIND_ALL             = (1 << 6),
860         ST_SHOW_MARGIN          = (1 << 7),
861         ST_MATCH_CASE           = (1 << 8),
862         
863         ST_FIND_ACTIVATE                = (1 << 9),
864 } eSpaceText_Flags;
865
866 /* stext->findstr/replacestr */
867 #define ST_MAX_FIND_STR     256
868
869 /* Script View (Obsolete) ================================== */
870
871 /* Script Runtime Data - Obsolete (pre 2.5) */
872 typedef struct Script {
873         ID id;
874
875         void *py_draw;
876         void *py_event;
877         void *py_button;
878         void *py_browsercallback;
879         void *py_globaldict;
880
881         int flags, lastspace;
882         /* store the script file here so we can re-run it on loading blender, if "Enable Scripts" is on */
883         char scriptname[1024]; /* 1024 = FILE_MAX */
884         char scriptarg[256]; /* 1024 = FILE_MAX */
885 } Script;
886 #define SCRIPT_SET_NULL(_script) _script->py_draw = _script->py_event = _script->py_button = _script->py_browsercallback = _script->py_globaldict = NULL; _script->flags = 0
887
888 /* Script View - Obsolete (pre 2.5) */
889 typedef struct SpaceScript {
890         SpaceLink *next, *prev;
891         ListBase regionbase;        /* storage of regions for inactive spaces */
892         int spacetype;
893         float blockscale DNA_DEPRECATED;
894         struct Script *script;
895
896         short flags, menunr;
897         int pad1;
898         
899         void *but_refs;
900 } SpaceScript;
901
902 /* Nodes Editor =========================================== */
903
904 /* Node Editor */
905
906 typedef struct bNodeTreePath {
907         struct bNodeTreePath *next, *prev;
908         
909         struct bNodeTree *nodetree;
910         bNodeInstanceKey parent_key;    /* base key for nodes in this tree instance */
911         int pad;
912         float view_center[2];                   /* v2d center point, so node trees can have different offsets in editors */
913         /* XXX this is not automatically updated when node names are changed! */
914         char node_name[64];             /* MAX_NAME */
915 } bNodeTreePath;
916
917 typedef struct SpaceNode {
918         SpaceLink *next, *prev;
919         ListBase regionbase;        /* storage of regions for inactive spaces */
920         int spacetype;
921         float blockscale DNA_DEPRECATED;
922         short blockhandler[8]  DNA_DEPRECATED;
923         
924         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
925         
926         struct ID *id, *from;       /* context, no need to save in file? well... pinning... */
927         short flag, pad1;           /* menunr: browse id block in header */
928         float aspect, pad2;     /* internal state variables */
929         
930         float xof, yof;     /* offset for drawing the backdrop */
931         float zoom;   /* zoom for backdrop */
932         float cursor[2];    /* mouse pos for drawing socketless link and adding nodes */
933         
934         /* XXX nodetree pointer info is all in the path stack now,
935          * remove later on and use bNodeTreePath instead. For now these variables are set when pushing/popping
936          * from path stack, to avoid having to update all the functions and operators. Can be done when
937          * design is accepted and everything is properly tested.
938          */
939         ListBase treepath;
940         
941         struct bNodeTree *nodetree, *edittree;
942         
943         /* tree type for the current node tree */
944         char tree_idname[64];
945         int treetype DNA_DEPRECATED; /* treetype: as same nodetree->type */
946         int pad3;
947         
948         short texfrom;      /* texfrom object, world or brush */
949         short shaderfrom;   /* shader from object or world */
950         short recalc;       /* currently on 0/1, for auto compo */
951         short pad4;
952         ListBase linkdrag;  /* temporary data for modal linking operator */
953         
954         struct bGPdata *gpd;        /* grease-pencil data */
955 } SpaceNode;
956
957 /* snode->flag */
958 typedef enum eSpaceNode_Flag {
959         SNODE_BACKDRAW       = (1 << 1),
960         SNODE_SHOW_GPENCIL   = (1 << 2),
961         SNODE_USE_ALPHA      = (1 << 3),
962         SNODE_SHOW_ALPHA     = (1 << 4),
963         SNODE_SHOW_R         = (1 << 7),
964         SNODE_SHOW_G         = (1 << 8),
965         SNODE_SHOW_B         = (1 << 9),
966         SNODE_AUTO_RENDER    = (1 << 5),
967         SNODE_SHOW_HIGHLIGHT = (1 << 6),
968         SNODE_USE_HIDDEN_PREVIEW = (1 << 10),
969         SNODE_NEW_SHADERS = (1 << 11),
970         SNODE_PIN            = (1 << 12),
971 } eSpaceNode_Flag;
972
973 /* snode->texfrom */
974 typedef enum eSpaceNode_TexFrom {
975         SNODE_TEX_OBJECT   = 0,
976         SNODE_TEX_WORLD    = 1,
977         SNODE_TEX_BRUSH    = 2,
978 } eSpaceNode_TexFrom;
979
980 /* snode->shaderfrom */
981 typedef enum eSpaceNode_ShaderFrom {
982         SNODE_SHADER_OBJECT = 0,
983         SNODE_SHADER_WORLD = 1,
984 } eSpaceNode_ShaderFrom;
985
986 /* Game Logic Editor ===================================== */
987
988 /* Logic Editor */
989 typedef struct SpaceLogic {
990         SpaceLink *next, *prev;
991         ListBase regionbase;        /* storage of regions for inactive spaces */
992         int spacetype;
993         float blockscale DNA_DEPRECATED;
994         
995         short blockhandler[8]  DNA_DEPRECATED;
996         
997         short flag, scaflag;
998         int pad;
999         
1000         struct bGPdata *gpd;        /* grease-pencil data */
1001 } SpaceLogic;
1002
1003 /* Console ================================================ */
1004
1005 /* Console content */
1006 typedef struct ConsoleLine {
1007         struct ConsoleLine *next, *prev;
1008         
1009         /* keep these 3 vars so as to share free, realloc funcs */
1010         int len_alloc;  /* allocated length */
1011         int len;    /* real len - strlen() */
1012         char *line; 
1013         
1014         int cursor;
1015         int type; /* only for use when in the 'scrollback' listbase */
1016 } ConsoleLine;
1017
1018 /* ConsoleLine.type */
1019 typedef enum eConsoleLine_Type {
1020         CONSOLE_LINE_OUTPUT = 0,
1021         CONSOLE_LINE_INPUT = 1,
1022         CONSOLE_LINE_INFO = 2, /* autocomp feedback */
1023         CONSOLE_LINE_ERROR = 3
1024 } eConsoleLine_Type;
1025
1026
1027 /* Console View */
1028 typedef struct SpaceConsole {
1029         SpaceLink *next, *prev;
1030         ListBase regionbase;        /* storage of regions for inactive spaces */
1031         int spacetype;
1032         float blockscale DNA_DEPRECATED;            // XXX are these needed?
1033         short blockhandler[8]  DNA_DEPRECATED;      // XXX are these needed?
1034         
1035         /* space vars */
1036         int lheight, pad;
1037
1038         ListBase scrollback; /* ConsoleLine; output */
1039         ListBase history; /* ConsoleLine; command history, current edited line is the first */
1040         char prompt[256];
1041         char language[32]; /* multiple consoles are possible, not just python */
1042         
1043         int sel_start;
1044         int sel_end;
1045 } SpaceConsole;
1046
1047
1048 /* User Preferences ======================================= */
1049
1050 /* User Preferences View */
1051 typedef struct SpaceUserPref {
1052         SpaceLink *next, *prev;
1053         ListBase regionbase;        /* storage of regions for inactive spaces */
1054         int spacetype;
1055         
1056         char pad[3];
1057         char filter_type;
1058         char filter[64];        /* search term for filtering in the UI */
1059 } SpaceUserPref;
1060
1061 /* Motion Tracking ======================================== */
1062
1063 /* Clip Editor */
1064 typedef struct SpaceClip {
1065         SpaceLink *next, *prev;
1066         ListBase regionbase;        /* storage of regions for inactive spaces */
1067         int spacetype;
1068
1069         float xof, yof;             /* user defined offset, image is centered */
1070         float xlockof, ylockof;     /* user defined offset from locked position */
1071         float zoom;                 /* user defined zoom level */
1072
1073         struct MovieClipUser user;      /* user of clip */
1074         struct MovieClip *clip;         /* clip data */
1075         struct MovieClipScopes scopes;  /* different scoped displayed in space panels */
1076
1077         int flag;                   /* flags */
1078         short mode;                 /* editor mode (editing context being displayed) */
1079         short view;                 /* type of the clip editor view */
1080
1081         int path_length;            /* length of displaying path, in frames */
1082
1083         /* current stabilization data */
1084         float loc[2], scale, angle; /* pre-composed stabilization data */
1085         int pad;
1086         float stabmat[4][4], unistabmat[4][4];  /* current stabilization matrix and the same matrix in unified space,
1087                                                  * defined when drawing and used for mouse position calculation */
1088
1089         /* movie postprocessing */
1090         int postproc_flag;
1091
1092         /* grease pencil */
1093         short gpencil_src, pad2;
1094
1095         int around, pad4;             /* pivot point for transforms */
1096
1097         float cursor[2];              /* Mask editor 2d cursor */
1098
1099         MaskSpaceInfo mask_info;
1100 } SpaceClip;
1101
1102 /* SpaceClip->flag */
1103 typedef enum eSpaceClip_Flag {
1104         SC_SHOW_MARKER_PATTERN = (1 << 0),
1105         SC_SHOW_MARKER_SEARCH  = (1 << 1),
1106         SC_LOCK_SELECTION      = (1 << 2),
1107         SC_SHOW_TINY_MARKER    = (1 << 3),
1108         SC_SHOW_TRACK_PATH     = (1 << 4),
1109         SC_SHOW_BUNDLES        = (1 << 5),
1110         SC_MUTE_FOOTAGE        = (1 << 6),
1111         SC_HIDE_DISABLED       = (1 << 7),
1112         SC_SHOW_NAMES          = (1 << 8),
1113         SC_SHOW_GRID           = (1 << 9),
1114         SC_SHOW_STABLE         = (1 << 10),
1115         SC_MANUAL_CALIBRATION  = (1 << 11),
1116         SC_SHOW_GPENCIL        = (1 << 12),
1117         SC_SHOW_FILTERS        = (1 << 13),
1118         SC_SHOW_GRAPH_FRAMES   = (1 << 14),
1119         SC_SHOW_GRAPH_TRACKS   = (1 << 15),
1120 /*      SC_SHOW_PYRAMID_LEVELS = (1 << 16), */  /* UNUSED */
1121         SC_LOCK_TIMECURSOR     = (1 << 17),
1122         SC_SHOW_SECONDS        = (1 << 18),
1123         SC_SHOW_GRAPH_SEL_ONLY = (1 << 19),
1124         SC_SHOW_GRAPH_HIDDEN   = (1 << 20),
1125 } eSpaceClip_Flag;
1126
1127 /* SpaceClip->mode */
1128 typedef enum eSpaceClip_Mode {
1129         SC_MODE_TRACKING = 0,
1130         SC_MODE_RECONSTRUCTION = 1,
1131         SC_MODE_DISTORTION = 2,
1132         SC_MODE_MASKEDIT = 3,
1133 } eSpaceClip_Mode;
1134
1135 /* SpaceClip->view */
1136 typedef enum eSpaceClip_View {
1137         SC_VIEW_CLIP = 0,
1138         SC_VIEW_GRAPH = 1,
1139         SC_VIEW_DOPESHEET = 2,
1140 } eSpaceClip_View;
1141
1142 /* SpaceClip->gpencil_src */
1143 typedef enum eSpaceClip_GPencil_Source {
1144         SC_GPENCIL_SRC_CLIP = 0,
1145         SC_GPENCIL_SRC_TRACK = 1,
1146 } eSpaceClip_GPencil_Source;
1147
1148 /* **************** SPACE DEFINES ********************* */
1149
1150 /* space types, moved from DNA_screen_types.h */
1151 /* Do NOT change order, append on end. types are hardcoded needed */
1152 typedef enum eSpace_Type {
1153         SPACE_EMPTY    = 0,
1154         SPACE_VIEW3D   = 1,
1155         SPACE_IPO      = 2,
1156         SPACE_OUTLINER = 3,
1157         SPACE_BUTS     = 4,
1158         SPACE_FILE     = 5,
1159         SPACE_IMAGE    = 6,
1160         SPACE_INFO     = 7,
1161         SPACE_SEQ      = 8,
1162         SPACE_TEXT     = 9,
1163         SPACE_IMASEL   = 10, /* deprecated */
1164         SPACE_SOUND    = 11, /* Deprecated */
1165         SPACE_ACTION   = 12,
1166         SPACE_NLA      = 13,
1167         SPACE_SCRIPT   = 14, /* Deprecated */
1168         SPACE_TIME     = 15,
1169         SPACE_NODE     = 16,
1170         SPACE_LOGIC    = 17,
1171         SPACE_CONSOLE  = 18,
1172         SPACE_USERPREF = 19,
1173         SPACE_CLIP     = 20,
1174         
1175         SPACEICONMAX = SPACE_CLIP
1176 } eSpace_Type;
1177
1178 #define IMG_SIZE_FALLBACK 256
1179
1180 #endif  /* __DNA_SPACE_TYPES_H__ */