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