Small cleanup from previous commit by Danrae Pray (@spockTheGray)
[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 Image;
54 struct Scopes;
55 struct Histogram;
56 struct SpaceIpo;
57 struct bNodeTree;
58 struct FileList;
59 struct bGPdata;
60 struct bDopeSheet;
61 struct FileSelectParams;
62 struct FileLayout;
63 struct wmOperator;
64 struct wmTimer;
65 struct MovieClip;
66 struct MovieClipScopes;
67 struct Mask;
68 struct BLI_mempool;
69
70
71 /* SpaceLink (Base) ==================================== */
72
73 /**
74  * The base structure all the other spaces
75  * are derived (implicitly) from. Would be
76  * good to make this explicit.
77  */
78 typedef struct SpaceLink {
79         struct SpaceLink *next, *prev;
80         ListBase regionbase;        /* storage of regions for inactive spaces */
81         int spacetype;
82         float blockscale DNA_DEPRECATED;        /* XXX make deprecated */
83         short blockhandler[8]  DNA_DEPRECATED;  /* XXX make deprecated */
84 } SpaceLink;
85
86
87 /* Space Info ========================================== */
88
89 /* Info Header */
90 typedef struct SpaceInfo {
91         SpaceLink *next, *prev;
92         ListBase regionbase;        /* storage of regions for inactive spaces */
93         int spacetype;
94         float blockscale DNA_DEPRECATED;
95         short blockhandler[8]  DNA_DEPRECATED;      /* XXX make deprecated */
96         
97         char rpt_mask;
98         char pad[7];
99 } SpaceInfo;
100
101 /* SpaceInfo.rpt_mask */
102 typedef enum eSpaceInfo_RptMask {
103         INFO_RPT_DEBUG  = (1 << 0),
104         INFO_RPT_INFO   = (1 << 1),
105         INFO_RPT_OP     = (1 << 2),
106         INFO_RPT_WARN   = (1 << 3),
107         INFO_RPT_ERR    = (1 << 4),
108 } eSpaceInfo_RptMask;
109
110
111 /* Properties Editor ==================================== */
112
113 /* Properties Editor */
114 typedef struct SpaceButs {
115         SpaceLink *next, *prev;
116         ListBase regionbase;        /* storage of regions for inactive spaces */
117         int spacetype;
118         float blockscale DNA_DEPRECATED;
119         
120         short blockhandler[8]  DNA_DEPRECATED;
121
122         View2D v2d DNA_DEPRECATED;                      /* deprecated, copied to region */
123         
124         short mainb, mainbo, mainbuser; /* context tabs */
125         short re_align, align;          /* align for panels */
126         short preview;                  /* preview is signal to refresh */
127         /* texture context selector (material, lamp, particles, world, other) */
128         short texture_context, texture_context_prev;
129         char flag;
130         char collection_context;
131         char pad[6];
132         
133         void *path;                     /* runtime */
134         int pathflag, dataicon;         /* runtime */
135         ID *pinid;
136
137         void *texuser;
138 } SpaceButs;
139
140 /* button defines (deprecated) */
141 /* warning: the values of these defines are used in sbuts->tabs[8] */
142 /* sbuts->mainb new */
143 #define CONTEXT_SCENE   0
144 #define CONTEXT_OBJECT  1
145 #define CONTEXT_TYPES   2
146 #define CONTEXT_SHADING 3
147 #define CONTEXT_EDITING 4
148 #define CONTEXT_SCRIPT  5
149 #define CONTEXT_LOGIC   6
150
151 /* sbuts->mainb old (deprecated) */
152 #ifdef DNA_DEPRECATED_ALLOW
153 // #define BUTS_VIEW           0
154 #define BUTS_LAMP           1
155 #define BUTS_MAT            2
156 #define BUTS_TEX            3
157 #define BUTS_ANIM           4
158 #define BUTS_WORLD          5
159 #define BUTS_RENDER         6
160 #define BUTS_EDIT           7
161 #define BUTS_GAME           8
162 #define BUTS_FPAINT         9
163 #define BUTS_RADIO          10
164 #define BUTS_SCRIPT         11
165 // #define BUTS_SOUND          12
166 #define BUTS_CONSTRAINT     13
167 // #define BUTS_EFFECTS        14
168 #endif
169
170 /* buts->mainb new */
171 typedef enum eSpaceButtons_Context {
172         BCONTEXT_RENDER = 0,
173         BCONTEXT_SCENE = 1,
174         BCONTEXT_WORLD = 2,
175         BCONTEXT_OBJECT = 3,
176         BCONTEXT_DATA = 4,
177         BCONTEXT_MATERIAL = 5,
178         BCONTEXT_TEXTURE = 6,
179         BCONTEXT_PARTICLE = 7,
180         BCONTEXT_PHYSICS = 8,
181         BCONTEXT_BONE = 9,
182         BCONTEXT_MODIFIER = 10,
183         BCONTEXT_CONSTRAINT = 11,
184         BCONTEXT_BONE_CONSTRAINT = 12,
185         BCONTEXT_VIEW_LAYER = 13,
186         BCONTEXT_COLLECTION = 14,
187         BCONTEXT_WORKSPACE = 15,
188
189         /* always as last... */
190         BCONTEXT_TOT
191 } eSpaceButtons_Context;
192
193 /* sbuts->flag */
194 typedef enum eSpaceButtons_Flag {
195         SB_PRV_OSA = (1 << 0),
196         SB_PIN_CONTEXT = (1 << 1),
197         /* SB_WORLD_TEX = (1 << 2), */ /* not used anymore */
198         /* SB_BRUSH_TEX = (1 << 3), */ /* not used anymore */
199         SB_TEX_USER_LIMITED = (1 << 3), /* Do not add materials, particles, etc. in TemplateTextureUser list. */
200         SB_SHADING_CONTEXT = (1 << 4),
201 } eSpaceButtons_Flag;
202
203 /* sbuts->texture_context */
204 typedef enum eSpaceButtons_Texture_Context {
205         SB_TEXC_MATERIAL = 0,
206         SB_TEXC_WORLD = 1,
207         SB_TEXC_LAMP = 2,
208         SB_TEXC_PARTICLES = 3,
209         SB_TEXC_OTHER = 4,
210         SB_TEXC_LINESTYLE = 5,
211 } eSpaceButtons_Texture_Context;
212
213 /* sbuts->collection_context */
214 typedef enum eSpaceButtons_Collection_Context {
215         SB_COLLECTION_CTX_VIEW_LAYER = 0,
216         SB_COLLECTION_CTX_GROUP = 1,
217 } eSpaceButtons_Collection_Context;
218
219 /* sbuts->align */
220 typedef enum eSpaceButtons_Align {
221         BUT_FREE = 0,
222         BUT_HORIZONTAL = 1,
223         BUT_VERTICAL = 2,
224         BUT_AUTO = 3,
225 } eSpaceButtons_Align;
226
227 /* sbuts->scaflag */
228 #define BUTS_SENS_SEL           1
229 #define BUTS_SENS_ACT           2
230 #define BUTS_SENS_LINK          4
231 #define BUTS_CONT_SEL           8
232 #define BUTS_CONT_ACT           16
233 #define BUTS_CONT_LINK          32
234 #define BUTS_ACT_SEL            64
235 #define BUTS_ACT_ACT            128
236 #define BUTS_ACT_LINK           256
237 #define BUTS_SENS_STATE         512
238 #define BUTS_ACT_STATE          1024
239 #define BUTS_CONT_INIT_STATE    2048
240
241
242 /* Outliner =============================================== */
243
244 /* Outliner */
245 typedef struct SpaceOops {
246         SpaceLink *next, *prev;
247         ListBase regionbase;        /* storage of regions for inactive spaces */
248         int spacetype;
249         float blockscale DNA_DEPRECATED;
250         short blockhandler[8]  DNA_DEPRECATED;
251
252         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
253         
254         ListBase tree;
255         
256         /* treestore is an ordered list of TreeStoreElem's from outliner tree;
257          * Note that treestore may contain duplicate elements if element
258          * is used multiple times in outliner tree (e. g. linked objects)
259          * Also note that BLI_mempool can not be read/written in DNA directly,
260          * therefore readfile.c/writefile.c linearize treestore into TreeStore structure
261          */
262         struct BLI_mempool *treestore;
263         
264         /* search stuff */
265         char search_string[64];
266         struct TreeStoreElem search_tse;
267
268         short flag, outlinevis, storeflag, search_flags;
269         
270         /* pointers to treestore elements, grouped by (id, type, nr) in hashtable for faster searching */
271         void *treehash;
272 } SpaceOops;
273
274
275 /* SpaceOops->flag */
276 typedef enum eSpaceOutliner_Flag {
277         SO_TESTBLOCKS           = (1 << 0),
278         SO_NEWSELECTED          = (1 << 1),
279         SO_HIDE_RESTRICTCOLS    = (1 << 2),
280         SO_HIDE_KEYINGSETINFO   = (1 << 3),
281         SO_SKIP_SORT_ALPHA      = (1 << 4),
282 } eSpaceOutliner_Flag;
283
284 /* SpaceOops->outlinevis */
285 typedef enum eSpaceOutliner_Mode {
286         SO_ALL_SCENES     = 0,
287         SO_CUR_SCENE      = 1,
288         SO_VISIBLE        = 2,
289         SO_SELECTED       = 3,
290         SO_ACTIVE         = 4,
291         SO_SAME_TYPE      = 5,
292         SO_GROUPS         = 6,
293         SO_LIBRARIES      = 7,
294         /* SO_VERSE_SESSION  = 8, */  /* deprecated! */
295         /* SO_VERSE_MS       = 9, */  /* deprecated! */
296         SO_SEQUENCE       = 10,
297         SO_DATABLOCKS     = 11,
298         SO_USERDEF        = 12,
299         /* SO_KEYMAP      = 13, */    /* deprecated! */
300         SO_ID_ORPHANS     = 14,
301         SO_ACT_LAYER      = 15,
302         SO_COLLECTIONS    = 16,
303 } eSpaceOutliner_Mode;
304
305 /* SpaceOops->storeflag */
306 typedef enum eSpaceOutliner_StoreFlag {
307         /* cleanup tree */
308         SO_TREESTORE_CLEANUP    = (1 << 0),
309         /* if set, it allows redraws. gets set for some allqueue events */
310         SO_TREESTORE_REDRAW     = (1 << 1),
311         /* rebuild the tree, similar to cleanup,
312          * but defer a call to BKE_outliner_treehash_rebuild_from_treestore instead */
313         SO_TREESTORE_REBUILD    = (1 << 2),
314 } eSpaceOutliner_StoreFlag;
315
316 /* outliner search flags (SpaceOops->search_flags) */
317 typedef enum eSpaceOutliner_Search_Flags {
318         SO_FIND_CASE_SENSITIVE  = (1 << 0),
319         SO_FIND_COMPLETE        = (1 << 1),
320         SO_SEARCH_RECURSIVE     = (1 << 2),
321 } eSpaceOutliner_Search_Flags;
322
323
324 /* Graph Editor ========================================= */
325
326 /* 'Graph' Editor (formerly known as the IPO Editor) */
327 typedef struct SpaceIpo {
328         SpaceLink *next, *prev;
329         ListBase regionbase;        /* storage of regions for inactive spaces */
330         int spacetype;
331         float blockscale DNA_DEPRECATED;
332         short blockhandler[8]  DNA_DEPRECATED;
333         
334         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
335         
336         struct bDopeSheet *ads; /* settings for filtering animation data (NOTE: we use a pointer due to code-linking issues) */
337         
338         ListBase ghostCurves;   /* sampled snapshots of F-Curves used as in-session guides */
339         
340         short mode;             /* mode for the Graph editor (eGraphEdit_Mode) */
341         short autosnap;         /* time-transform autosnapping settings for Graph editor (eAnimEdit_AutoSnap in DNA_action_types.h) */
342         int flag;               /* settings for Graph editor (eGraphEdit_Flag) */
343         
344         float cursorTime;       /* time value for cursor (when in drivers mode; animation uses current frame) */
345         float cursorVal;        /* cursor value (y-value, x-value is current frame) */
346         int around;             /* pivot point for transforms */
347         int pad;
348 } SpaceIpo;
349
350
351 /* SpaceIpo->flag (Graph Editor Settings) */
352 typedef enum eGraphEdit_Flag {
353         /* OLD DEPRECEATED SETTING */
354         /* SIPO_LOCK_VIEW            = (1 << 0), */
355         
356         /* don't merge keyframes on the same frame after a transform */
357         SIPO_NOTRANSKEYCULL       = (1 << 1),
358         /* don't show any keyframe handles at all */
359         SIPO_NOHANDLES            = (1 << 2),
360         /* don't show current frame number beside indicator line */
361         SIPO_NODRAWCFRANUM        = (1 << 3),
362         /* show timing in seconds instead of frames */
363         SIPO_DRAWTIME             = (1 << 4),
364         /* only show keyframes for selected F-Curves */
365         SIPO_SELCUVERTSONLY       = (1 << 5),
366         /* draw names of F-Curves beside the respective curves */
367         /* NOTE: currently not used */
368         SIPO_DRAWNAMES            = (1 << 6),
369         /* show sliders in channels list */
370         SIPO_SLIDERS              = (1 << 7),
371         /* don't show the horizontal component of the cursor */
372         SIPO_NODRAWCURSOR         = (1 << 8),
373         /* only show handles of selected keyframes */
374         SIPO_SELVHANDLESONLY      = (1 << 9),
375         /* temporary flag to force channel selections to be synced with main */
376         SIPO_TEMP_NEEDCHANSYNC    = (1 << 10),
377         /* don't perform realtime updates */
378         SIPO_NOREALTIMEUPDATES    = (1 << 11),
379         /* don't draw curves with AA ("beauty-draw") for performance */
380         SIPO_BEAUTYDRAW_OFF       = (1 << 12),
381         /* draw grouped channels with colors set in group */
382         SIPO_NODRAWGCOLORS        = (1 << 13),
383         /* normalize curves on display */
384         SIPO_NORMALIZE            = (1 << 14),
385         SIPO_NORMALIZE_FREEZE     = (1 << 15),
386 } eGraphEdit_Flag;
387
388 /* SpaceIpo->mode (Graph Editor Mode) */
389 typedef enum eGraphEdit_Mode {
390         /* all animation curves (from all over Blender) */
391         SIPO_MODE_ANIMATION = 0,
392         /* drivers only */
393         SIPO_MODE_DRIVERS = 1,
394 } eGraphEdit_Mode;
395
396
397 /* NLA Editor ============================================= */
398
399 /* NLA Editor */
400 typedef struct SpaceNla {
401         struct SpaceLink *next, *prev;
402         ListBase regionbase;        /* storage of regions for inactive spaces */
403         int spacetype;
404         float blockscale DNA_DEPRECATED;
405         short blockhandler[8]  DNA_DEPRECATED;
406
407         short autosnap;         /* this uses the same settings as autosnap for Action Editor */
408         short flag;
409         int pad;
410         
411         struct bDopeSheet *ads;
412         View2D v2d DNA_DEPRECATED;   /* deprecated, copied to region */
413 } SpaceNla;
414
415 /* nla->flag */
416 typedef enum eSpaceNla_Flag {
417         /* flags (1<<0), (1<<1), and (1<<3) are deprecated flags from old verisons */
418
419         /* draw timing in seconds instead of frames */
420         SNLA_DRAWTIME          = (1 << 2),
421         /* don't draw frame number beside frame indicator */
422         SNLA_NODRAWCFRANUM     = (1 << 4),
423         /* don't draw influence curves on strips */
424         SNLA_NOSTRIPCURVES     = (1 << 5),
425         /* don't perform realtime updates */
426         SNLA_NOREALTIMEUPDATES = (1 << 6),
427         /* don't show local strip marker indications */
428         SNLA_NOLOCALMARKERS    = (1 << 7),
429 } eSpaceNla_Flag;
430
431
432 /* Timeline =============================================== */
433
434 /* Pointcache drawing data */
435 # /* Only store the data array in the cache to avoid constant reallocation. */
436 # /* No need to store when saved. */
437 typedef struct SpaceTimeCache {
438         struct SpaceTimeCache *next, *prev;
439         float *array;
440 } SpaceTimeCache;
441
442 /* Timeline View */
443 typedef struct SpaceTime {
444         SpaceLink *next, *prev;
445         ListBase regionbase;        /* storage of regions for inactive spaces */
446         int spacetype;
447         float blockscale DNA_DEPRECATED;
448         
449         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
450
451         ListBase caches;
452
453         int cache_display;
454         int flag;
455 } SpaceTime;
456
457
458 /* time->flag */
459 typedef enum eTimeline_Flag {
460         /* show timing in frames instead of in seconds */
461         TIME_DRAWFRAMES    = (1 << 0),
462         /* show time indicator box beside the frame number */
463         TIME_CFRA_NUM      = (1 << 1),
464         /* only keyframes from active/selected channels get shown */
465         TIME_ONLYACTSEL    = (1 << 2),
466 } eTimeline_Flag;
467
468 /* time->redraws (now screen->redraws_flag) */
469 typedef enum eScreen_Redraws_Flag {
470         TIME_REGION            = (1 << 0),
471         TIME_ALL_3D_WIN        = (1 << 1),
472         TIME_ALL_ANIM_WIN      = (1 << 2),
473         TIME_ALL_BUTS_WIN      = (1 << 3),
474         // TIME_WITH_SEQ_AUDIO    = (1 << 4), /* DEPRECATED */
475         TIME_SEQ               = (1 << 5),
476         TIME_ALL_IMAGE_WIN     = (1 << 6),
477         // TIME_CONTINUE_PHYSICS  = (1 << 7), /* UNUSED */
478         TIME_NODES             = (1 << 8),
479         TIME_CLIPS             = (1 << 9),
480
481         TIME_FOLLOW            = (1 << 15),
482 } eScreen_Redraws_Flag;
483
484 /* time->cache */
485 typedef enum eTimeline_Cache_Flag {
486         TIME_CACHE_DISPLAY       = (1 << 0),
487         TIME_CACHE_SOFTBODY      = (1 << 1),
488         TIME_CACHE_PARTICLES     = (1 << 2),
489         TIME_CACHE_CLOTH         = (1 << 3),
490         TIME_CACHE_SMOKE         = (1 << 4),
491         TIME_CACHE_DYNAMICPAINT  = (1 << 5),
492         TIME_CACHE_RIGIDBODY     = (1 << 6),
493 } eTimeline_Cache_Flag;
494
495
496 /* Sequence Editor ======================================= */
497
498 /* Sequencer */
499 typedef struct SpaceSeq {
500         SpaceLink *next, *prev;
501         ListBase regionbase;        /* storage of regions for inactive spaces */
502         int spacetype;
503         float blockscale DNA_DEPRECATED;
504
505         short blockhandler[8]  DNA_DEPRECATED;
506
507         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
508         
509         float xof DNA_DEPRECATED, yof DNA_DEPRECATED;   /* deprecated: offset for drawing the image preview */
510         short mainb;    /* weird name for the sequencer subtype (seq, image, luma... etc) */
511         short render_size;  /* eSpaceSeq_Proxy_RenderSize */
512         short chanshown;
513         short zebra;
514         int flag;
515         float zoom DNA_DEPRECATED;  /* deprecated, handled by View2D now */
516         int view; /* see SEQ_VIEW_* below */
517         int overlay_type;
518         int draw_flag; /* overlay an image of the editing on below the strips */
519         int pad;
520
521         struct bGPdata *gpd;        /* grease-pencil data */
522
523         struct SequencerScopes scopes;  /* different scoped displayed in space */
524
525         char multiview_eye;                             /* multiview current eye - for internal use */
526         char pad2[7];
527
528         struct GPUFX *compositor;
529         void *pad3;
530 } SpaceSeq;
531
532
533 /* sseq->mainb */
534 typedef enum eSpaceSeq_RegionType {
535         SEQ_DRAW_SEQUENCE = 0,
536         SEQ_DRAW_IMG_IMBUF = 1,
537         SEQ_DRAW_IMG_WAVEFORM = 2,
538         SEQ_DRAW_IMG_VECTORSCOPE = 3,
539         SEQ_DRAW_IMG_HISTOGRAM = 4,
540 } eSpaceSeq_RegionType;
541
542 /* sseq->draw_flag */
543 typedef enum eSpaceSeq_DrawFlag {
544         SEQ_DRAW_BACKDROP              = (1 << 0),
545         SEQ_DRAW_OFFSET_EXT            = (1 << 1),
546 } eSpaceSeq_DrawFlag;
547
548
549 /* sseq->flag */
550 typedef enum eSpaceSeq_Flag {
551         SEQ_DRAWFRAMES              = (1 << 0),
552         SEQ_MARKER_TRANS            = (1 << 1),
553         SEQ_DRAW_COLOR_SEPARATED    = (1 << 2),
554         SEQ_SHOW_SAFE_MARGINS       = (1 << 3),
555         SEQ_SHOW_GPENCIL            = (1 << 4),
556         SEQ_NO_DRAW_CFRANUM         = (1 << 5),
557         SEQ_USE_ALPHA               = (1 << 6), /* use RGBA display mode for preview */
558         SEQ_ALL_WAVEFORMS           = (1 << 7), /* draw all waveforms */
559         SEQ_NO_WAVEFORMS            = (1 << 8), /* draw no waveforms */
560         SEQ_SHOW_SAFE_CENTER        = (1 << 9),
561         SEQ_SHOW_METADATA           = (1 << 10),
562 } eSpaceSeq_Flag;
563
564 /* sseq->view */
565 typedef enum eSpaceSeq_Displays {
566         SEQ_VIEW_SEQUENCE = 1,
567         SEQ_VIEW_PREVIEW = 2,
568         SEQ_VIEW_SEQUENCE_PREVIEW = 3,
569 } eSpaceSeq_Dispays;
570
571 /* sseq->render_size */
572 typedef enum eSpaceSeq_Proxy_RenderSize {
573         SEQ_PROXY_RENDER_SIZE_NONE      =  -1,
574         SEQ_PROXY_RENDER_SIZE_SCENE     =   0,
575         SEQ_PROXY_RENDER_SIZE_25        =  25,
576         SEQ_PROXY_RENDER_SIZE_50        =  50,
577         SEQ_PROXY_RENDER_SIZE_75        =  75,
578         SEQ_PROXY_RENDER_SIZE_100       =  99,
579         SEQ_PROXY_RENDER_SIZE_FULL      = 100
580 } eSpaceSeq_Proxy_RenderSize;
581
582 typedef struct MaskSpaceInfo {
583         /* **** mask editing **** */
584         struct Mask *mask;
585         /* draw options */
586         char draw_flag;
587         char draw_type;
588         char overlay_mode;
589         char pad3[5];
590 } MaskSpaceInfo;
591
592 /* sseq->mainb */
593 typedef enum eSpaceSeq_OverlayType {
594         SEQ_DRAW_OVERLAY_RECT = 0,
595         SEQ_DRAW_OVERLAY_REFERENCE = 1,
596         SEQ_DRAW_OVERLAY_CURRENT = 2
597 } eSpaceSeq_OverlayType;
598
599 /* File Selector ========================================== */
600
601 /* Config and Input for File Selector */
602 typedef struct FileSelectParams {
603         char title[96]; /* title, also used for the text of the execute button */
604         char dir[1090]; /* directory, FILE_MAX_LIBEXTRA, 1024 + 66, this is for extreme case when 1023 length path
605                          * needs to be linked in, where foo.blend/Armature need adding  */
606         char pad_c1[2];
607         char file[256]; /* file */
608         char renamefile[256];
609         char renameedit[256]; /* annoying but the first is only used for initialization */
610
611         char filter_glob[256]; /* list of filetypes to filter */
612
613         char filter_search[64];  /* text items' name must match to be shown. */
614         int filter_id;  /* same as filter, but for ID types (aka library groups). */
615
616         int active_file;    /* active file used for keyboard navigation */
617         int highlight_file; /* file under cursor */
618         int sel_first;
619         int sel_last;
620         unsigned short thumbnail_size;
621         short pad;
622
623         /* short */
624         short type; /* XXXXX for now store type here, should be moved to the operator */
625         short flag; /* settings for filter, hiding dots files,...  */
626         short sort; /* sort order */
627         short display; /* display mode flag */
628         int filter; /* filter when (flags & FILE_FILTER) is true */
629
630         short recursion_level;  /* max number of levels in dirtree to show at once, 0 to disable recursion. */
631
632         /* XXX --- still unused -- */
633         short f_fp; /* show font preview */
634         char fp_str[8]; /* string to use for font preview */
635
636         /* XXX --- end unused -- */
637 } FileSelectParams;
638
639 /* File Browser */
640 typedef struct SpaceFile {
641         SpaceLink *next, *prev;
642         ListBase regionbase;        /* storage of regions for inactive spaces */
643         int spacetype;
644         
645         int scroll_offset;
646
647         struct FileSelectParams *params; /* config and input for file select */
648         
649         struct FileList *files; /* holds the list of files to show */
650
651         ListBase *folders_prev; /* holds the list of previous directories to show */
652         ListBase *folders_next; /* holds the list of next directories (pushed from previous) to show */
653
654         /* operator that is invoking fileselect 
655          * op->exec() will be called on the 'Load' button.
656          * if operator provides op->cancel(), then this will be invoked
657          * on the cancel button.
658          */
659         struct wmOperator *op; 
660
661         struct wmTimer *smoothscroll_timer;
662         struct wmTimer *previews_timer;
663
664         struct FileLayout *layout;
665         
666         short recentnr, bookmarknr;
667         short systemnr, system_bookmarknr;
668 } SpaceFile;
669
670 /* FSMenuEntry's without paths indicate separators */
671 typedef struct FSMenuEntry {
672         struct FSMenuEntry *next;
673
674         char *path;
675         char name[256];  /* FILE_MAXFILE */
676         short save;
677         short valid;
678         short pad[2];
679 } FSMenuEntry;
680
681 /* FileSelectParams.display */
682 enum eFileDisplayType {
683         FILE_DEFAULTDISPLAY = 0,
684         FILE_SHORTDISPLAY = 1,
685         FILE_LONGDISPLAY = 2,
686         FILE_IMGDISPLAY = 3
687 };
688
689 /* FileSelectParams.sort */
690 enum eFileSortType {
691         FILE_SORT_NONE = 0,
692         FILE_SORT_ALPHA = 1,
693         FILE_SORT_EXTENSION = 2,
694         FILE_SORT_TIME = 3,
695         FILE_SORT_SIZE = 4
696 };
697
698 /* these values need to be hardcoded in structs, dna does not recognize defines */
699 /* also defined in BKE */
700 #define FILE_MAXDIR         768
701 #define FILE_MAXFILE        256
702 #define FILE_MAX            1024
703
704 #define FILE_MAX_LIBEXTRA   (FILE_MAX + MAX_ID_NAME)
705
706 /* filesel types */
707 #define FILE_UNIX           8
708 #define FILE_BLENDER        8 /* don't display relative paths */
709 #define FILE_SPECIAL        9
710
711 #define FILE_LOADLIB        1
712 #define FILE_MAIN           2
713 #define FILE_LOADFONT       3
714
715 /* filesel op property -> action */
716 typedef enum eFileSel_Action {
717         FILE_OPENFILE = 0,
718         FILE_SAVE = 1,
719 } eFileSel_Action;
720
721 /* sfile->params->flag and simasel->flag */
722 typedef enum eFileSel_Params_Flag {
723         FILE_SHOWSHORT      = (1 << 0),
724         FILE_RELPATH        = (1 << 1), /* was FILE_STRINGCODE */
725         FILE_LINK           = (1 << 2),
726         FILE_HIDE_DOT       = (1 << 3),
727         FILE_AUTOSELECT     = (1 << 4),
728         FILE_ACTIVE_COLLECTION = (1 << 5),
729 /*  FILE_ATCURSOR       = (1 << 6), */ /* deprecated */
730         FILE_DIRSEL_ONLY    = (1 << 7),
731         FILE_FILTER         = (1 << 8),
732         FILE_BOOKMARKS      = (1 << 9),
733         FILE_GROUP_INSTANCE = (1 << 10),
734 } eFileSel_Params_Flag;
735
736
737 /* files in filesel list: file types
738  * Note we could use mere values (instead of bitflags) for file types themselves,
739  * but since we do not lack of bytes currently...
740  */
741 typedef enum eFileSel_File_Types {
742         FILE_TYPE_BLENDER           = (1 << 2),
743         FILE_TYPE_BLENDER_BACKUP    = (1 << 3),
744         FILE_TYPE_IMAGE             = (1 << 4),
745         FILE_TYPE_MOVIE             = (1 << 5),
746         FILE_TYPE_PYSCRIPT          = (1 << 6),
747         FILE_TYPE_FTFONT            = (1 << 7),
748         FILE_TYPE_SOUND             = (1 << 8),
749         FILE_TYPE_TEXT              = (1 << 9),
750         /* 1 << 10 was FILE_TYPE_MOVIE_ICON, got rid of this so free slot for future type... */
751         FILE_TYPE_FOLDER            = (1 << 11), /* represents folders for filtering */
752         FILE_TYPE_BTX               = (1 << 12),
753         FILE_TYPE_COLLADA           = (1 << 13),
754         FILE_TYPE_OPERATOR          = (1 << 14), /* from filter_glob operator property */
755         FILE_TYPE_APPLICATIONBUNDLE = (1 << 15),
756         FILE_TYPE_ALEMBIC           = (1 << 16),
757
758         FILE_TYPE_DIR               = (1 << 30),  /* An FS directory (i.e. S_ISDIR on its path is true). */
759         FILE_TYPE_BLENDERLIB        = (1u << 31),
760 } eFileSel_File_Types;
761
762 /* Selection Flags in filesel: struct direntry, unsigned char selflag */
763 typedef enum eDirEntry_SelectFlag {
764 /*      FILE_SEL_ACTIVE         = (1 << 1), */ /* UNUSED */
765         FILE_SEL_HIGHLIGHTED    = (1 << 2),
766         FILE_SEL_SELECTED       = (1 << 3),
767         FILE_SEL_EDITING        = (1 << 4),
768 } eDirEntry_SelectFlag;
769
770 #define FILE_LIST_MAX_RECURSION 4
771
772 /* ***** Related to file browser, but never saved in DNA, only here to help with RNA. ***** */
773
774 /* About Unique identifier.
775  * Stored in a CustomProps once imported.
776  * Each engine is free to use it as it likes - it will be the only thing passed to it by blender to identify
777  * asset/variant/version (concatenating the three into a single 48 bytes one).
778  * Assumed to be 128bits, handled as four integers due to lack of real bytes proptype in RNA :|.
779  */
780 #define ASSET_UUID_LENGTH     16
781
782 /* Used to communicate with asset engines outside of 'import' context. */
783 typedef struct AssetUUID {
784         int uuid_asset[4];
785         int uuid_variant[4];
786         int uuid_revision[4];
787 } AssetUUID;
788
789 typedef struct AssetUUIDList {
790         AssetUUID *uuids;
791         int nbr_uuids, pad;
792 } AssetUUIDList;
793
794 /* Container for a revision, only relevant in asset context. */
795 typedef struct FileDirEntryRevision {
796         struct FileDirEntryRevision *next, *prev;
797
798         char *comment;
799         void *pad;
800
801         int uuid[4];
802
803         uint64_t size;
804         int64_t time;
805         /* Temp caching of UI-generated strings... */
806         char    size_str[16];
807         char    time_str[8];
808         char    date_str[16];
809 } FileDirEntryRevision;
810
811 /* Container for a variant, only relevant in asset context.
812  * In case there are no variants, a single one shall exist, with NULL name/description. */
813 typedef struct FileDirEntryVariant {
814         struct FileDirEntryVariant *next, *prev;
815
816         int uuid[4];
817         char *name;
818         char *description;
819
820         ListBase revisions;
821         int nbr_revisions;
822         int act_revision;
823 } FileDirEntryVariant;
824
825 /* Container for mere direntry, with additional asset-related data. */
826 typedef struct FileDirEntry {
827         struct FileDirEntry *next, *prev;
828
829         int uuid[4];
830         char *name;
831         char *description;
832
833         /* Either point to active variant/revision if available, or own entry (in mere filebrowser case). */
834         FileDirEntryRevision *entry;
835
836         int typeflag;  /* eFileSel_File_Types */
837         int blentype;  /* ID type, in case typeflag has FILE_TYPE_BLENDERLIB set. */
838
839         char *relpath;
840
841         void *poin;  /* TODO: make this a real ID pointer? */
842         struct ImBuf *image;
843
844         /* Tags are for info only, most of filtering is done in asset engine. */
845         char **tags;
846         int nbr_tags;
847
848         short status;
849         short flags;
850
851         ListBase variants;
852         int nbr_variants;
853         int act_variant;
854 } FileDirEntry;
855
856 /* Array of direntries. */
857 /* This struct is used in various, different contexts.
858  * In Filebrowser UI, it stores the total number of available entries, the number of visible (filtered) entries,
859  *                    and a subset of those in 'entries' ListBase, from idx_start (included) to idx_end (excluded).
860  * In AssetEngine context (i.e. outside of 'browsing' context), entries contain all needed data, there is no filtering,
861  *                        so nbr_entries_filtered, entry_idx_start and entry_idx_end should all be set to -1.
862  */
863 typedef struct FileDirEntryArr {
864         ListBase entries;
865         int nbr_entries;
866         int nbr_entries_filtered;
867         int entry_idx_start, entry_idx_end;
868
869         char root[1024];         /* FILE_MAX */
870 } FileDirEntryArr;
871
872 /* FileDirEntry.status */
873 enum {
874         ASSET_STATUS_LOCAL  = 1 << 0,  /* If active uuid is available locally/immediately. */
875         ASSET_STATUS_LATEST = 1 << 1,  /* If active uuid is latest available version. */
876 };
877
878 /* FileDirEntry.flags */
879 enum {
880         FILE_ENTRY_INVALID_PREVIEW = 1 << 0,  /* The preview for this entry could not be generated. */
881 };
882
883 /* Image/UV Editor ======================================== */
884
885 /* Image/UV Editor */
886 typedef struct SpaceImage {
887         SpaceLink *next, *prev;
888         ListBase regionbase;        /* storage of regions for inactive spaces */
889         int spacetype;
890
891         int flag;
892
893         struct Image *image;
894         struct ImageUser iuser;
895
896         struct Scopes scopes;           /* histogram waveform and vectorscope */
897         struct Histogram sample_line_hist;  /* sample line histogram */
898
899         struct bGPdata *gpd;            /* grease pencil data */
900
901         float cursor[2];                /* UV editor 2d cursor */
902         float xof, yof;                 /* user defined offset, image is centered */
903         float zoom;                     /* user defined zoom level */
904         float centx, centy;             /* storage for offset while render drawing */
905
906         char  mode;                     /* view/paint/mask */
907         char  pin;
908         short pad;
909         short curtile; /* the currently active tile of the image when tile is enabled, is kept in sync with the active faces tile */
910         short lock;
911         char dt_uv; /* UV draw type */
912         char sticky; /* sticky selection type */
913         char dt_uvstretch;
914         char around;
915
916         /* Filter settings when editor shows other object's UVs. */
917         int other_uv_filter;
918         int pad2;
919
920         MaskSpaceInfo mask_info;
921 } SpaceImage;
922
923
924 /* SpaceImage->dt_uv */
925 typedef enum eSpaceImage_UVDT {
926         SI_UVDT_OUTLINE = 0,
927         SI_UVDT_DASH = 1,
928         SI_UVDT_BLACK = 2,
929         SI_UVDT_WHITE = 3,
930 } eSpaceImage_UVDT;
931
932 /* SpaceImage->dt_uvstretch */
933 typedef enum eSpaceImage_UVDT_Stretch {
934         SI_UVDT_STRETCH_ANGLE = 0,
935         SI_UVDT_STRETCH_AREA = 1,
936 } eSpaceImage_UVDT_Stretch;
937
938 /* SpaceImage->mode */
939 typedef enum eSpaceImage_Mode {
940         SI_MODE_VIEW  = 0,
941         SI_MODE_PAINT = 1,
942         SI_MODE_MASK  = 2   /* note: mesh edit mode overrides mask */
943 } eSpaceImage_Mode;
944
945 /* SpaceImage->sticky
946  * Note DISABLE should be 0, however would also need to re-arrange icon order,
947  * also, sticky loc is the default mode so this means we don't need to 'do_versions' */
948 typedef enum eSpaceImage_Sticky {
949         SI_STICKY_LOC      = 0,
950         SI_STICKY_DISABLE  = 1,
951         SI_STICKY_VERTEX   = 2,
952 } eSpaceImage_Sticky;
953
954 /* SpaceImage->flag */
955 typedef enum eSpaceImage_Flag {
956 /*      SI_BE_SQUARE          = (1 << 0), */  /* deprecated */
957 /*      SI_EDITTILE           = (1 << 1), */  /* deprecated */
958         SI_CLIP_UV            = (1 << 2),
959 /*      SI_DRAWTOOL           = (1 << 3), */  /* deprecated */
960         SI_NO_DRAWFACES       = (1 << 4),
961         SI_DRAWSHADOW         = (1 << 5),
962 /*      SI_SELACTFACE         = (1 << 6), */  /* deprecated */
963 /*      SI_DEPRECATED2        = (1 << 7), */  /* deprecated */
964 /*      SI_DEPRECATED3        = (1 << 8), */  /* deprecated */
965         SI_COORDFLOATS        = (1 << 9),
966         SI_PIXELSNAP          = (1 << 10),
967         SI_LIVE_UNWRAP        = (1 << 11),
968         SI_USE_ALPHA          = (1 << 12),
969         SI_SHOW_ALPHA         = (1 << 13),
970         SI_SHOW_ZBUF          = (1 << 14),
971         
972         /* next two for render window display */
973         SI_PREVSPACE          = (1 << 15),
974         SI_FULLWINDOW         = (1 << 16),
975         
976 /*      SI_DEPRECATED4        = (1 << 17), */  /* deprecated */
977 /*      SI_DEPRECATED5        = (1 << 18), */  /* deprecated */
978         
979         /* this means that the image is drawn until it reaches the view edge,
980          * in the image view, it's unrelated to the 'tile' mode for texface
981          */
982         SI_DRAW_TILE          = (1 << 19),
983         SI_SMOOTH_UV          = (1 << 20),
984         SI_DRAW_STRETCH       = (1 << 21),
985         SI_SHOW_GPENCIL       = (1 << 22),
986         SI_DRAW_OTHER         = (1 << 23),
987
988         SI_COLOR_CORRECTION   = (1 << 24),
989
990         SI_NO_DRAW_TEXPAINT   = (1 << 25),
991         SI_DRAW_METADATA      = (1 << 26),
992
993         SI_SHOW_R             = (1 << 27),
994         SI_SHOW_G             = (1 << 28),
995         SI_SHOW_B             = (1 << 29),
996 } eSpaceImage_Flag;
997
998 /* SpaceImage->other_uv_filter */
999 typedef enum eSpaceImage_OtherUVFilter {
1000         SI_FILTER_SAME_IMAGE    = 0,
1001         SI_FILTER_ALL           = 1,
1002 } eSpaceImage_OtherUVFilter;
1003
1004 /* Text Editor ============================================ */
1005
1006 /* Text Editor */
1007 typedef struct SpaceText {
1008         SpaceLink *next, *prev;
1009         ListBase regionbase;        /* storage of regions for inactive spaces */
1010         int spacetype;
1011         float blockscale DNA_DEPRECATED;
1012         short blockhandler[8]  DNA_DEPRECATED;
1013
1014         struct Text *text;
1015
1016         int top, viewlines;
1017         short flags, menunr;
1018
1019         short lheight;      /* user preference, is font_size! */
1020         char cwidth, linenrs_tot;       /* runtime computed, character width and the number of chars to use when showing line numbers */
1021         int left;
1022         int showlinenrs;
1023         int tabnumber;
1024
1025         short showsyntax;
1026         short line_hlight;
1027         short overwrite;
1028         short live_edit; /* run python while editing, evil */
1029         float pix_per_line;
1030
1031         struct rcti txtscroll, txtbar;
1032
1033         int wordwrap, doplugins;
1034
1035         char findstr[256];      /* ST_MAX_FIND_STR */
1036         char replacestr[256];   /* ST_MAX_FIND_STR */
1037
1038         short margin_column;    /* column number to show right margin at */
1039         short lheight_dpi;              /* actual lineheight, dpi controlled */
1040         char pad[4];
1041
1042         void *drawcache; /* cache for faster drawing */
1043
1044         float scroll_accum[2]; /* runtime, for scroll increments smaller than a line */
1045 } SpaceText;
1046
1047
1048 /* SpaceText flags (moved from DNA_text_types.h) */
1049 typedef enum eSpaceText_Flags {
1050         /* scrollable */
1051         ST_SCROLL_SELECT        = (1 << 0),
1052         /* clear namespace after script execution (BPY_main.c) */
1053         ST_CLEAR_NAMESPACE      = (1 << 4), 
1054         
1055         ST_FIND_WRAP            = (1 << 5),
1056         ST_FIND_ALL             = (1 << 6),
1057         ST_SHOW_MARGIN          = (1 << 7),
1058         ST_MATCH_CASE           = (1 << 8),
1059         
1060         ST_FIND_ACTIVATE                = (1 << 9),
1061 } eSpaceText_Flags;
1062
1063 /* stext->findstr/replacestr */
1064 #define ST_MAX_FIND_STR     256
1065
1066 /* Script View (Obsolete) ================================== */
1067
1068 /* Script Runtime Data - Obsolete (pre 2.5) */
1069 typedef struct Script {
1070         ID id;
1071
1072         void *py_draw;
1073         void *py_event;
1074         void *py_button;
1075         void *py_browsercallback;
1076         void *py_globaldict;
1077
1078         int flags, lastspace;
1079         /* store the script file here so we can re-run it on loading blender, if "Enable Scripts" is on */
1080         char scriptname[1024]; /* 1024 = FILE_MAX */
1081         char scriptarg[256]; /* 1024 = FILE_MAX */
1082 } Script;
1083 #define SCRIPT_SET_NULL(_script) _script->py_draw = _script->py_event = _script->py_button = _script->py_browsercallback = _script->py_globaldict = NULL; _script->flags = 0
1084
1085 /* Script View - Obsolete (pre 2.5) */
1086 typedef struct SpaceScript {
1087         SpaceLink *next, *prev;
1088         ListBase regionbase;        /* storage of regions for inactive spaces */
1089         int spacetype;
1090         float blockscale DNA_DEPRECATED;
1091         struct Script *script;
1092
1093         short flags, menunr;
1094         int pad1;
1095         
1096         void *but_refs;
1097 } SpaceScript;
1098
1099 /* Nodes Editor =========================================== */
1100
1101 /* Node Editor */
1102
1103 typedef struct bNodeTreePath {
1104         struct bNodeTreePath *next, *prev;
1105         
1106         struct bNodeTree *nodetree;
1107         bNodeInstanceKey parent_key;    /* base key for nodes in this tree instance */
1108         int pad;
1109         float view_center[2];                   /* v2d center point, so node trees can have different offsets in editors */
1110         
1111         char node_name[64];             /* MAX_NAME */
1112 } bNodeTreePath;
1113
1114 typedef struct SpaceNode {
1115         SpaceLink *next, *prev;
1116         ListBase regionbase;        /* storage of regions for inactive spaces */
1117         int spacetype;
1118         float blockscale DNA_DEPRECATED;
1119         short blockhandler[8]  DNA_DEPRECATED;
1120         
1121         View2D v2d DNA_DEPRECATED;  /* deprecated, copied to region */
1122         
1123         struct ID *id, *from;       /* context, no need to save in file? well... pinning... */
1124         short flag, pad1;           /* menunr: browse id block in header */
1125         float aspect, pad2;     /* internal state variables */
1126         
1127         float xof, yof;     /* offset for drawing the backdrop */
1128         float zoom;   /* zoom for backdrop */
1129         float cursor[2];    /* mouse pos for drawing socketless link and adding nodes */
1130         
1131         /* XXX nodetree pointer info is all in the path stack now,
1132          * remove later on and use bNodeTreePath instead. For now these variables are set when pushing/popping
1133          * from path stack, to avoid having to update all the functions and operators. Can be done when
1134          * design is accepted and everything is properly tested.
1135          */
1136         ListBase treepath;
1137         
1138         struct bNodeTree *nodetree, *edittree;
1139         
1140         /* tree type for the current node tree */
1141         char tree_idname[64];
1142         int treetype DNA_DEPRECATED; /* treetype: as same nodetree->type */
1143         int pad3;
1144         
1145         short texfrom;       /* texfrom object, world or brush */
1146         short shaderfrom;    /* shader from object or world */
1147         short recalc;        /* currently on 0/1, for auto compo */
1148
1149         char insert_ofs_dir; /* direction for offsetting nodes on insertion */
1150         char pad4;
1151
1152         ListBase linkdrag;   /* temporary data for modal linking operator */
1153         /* XXX hack for translate_attach op-macros to pass data from transform op to insert_offset op */
1154         struct NodeInsertOfsData *iofsd; /* temporary data for node insert offset (in UI called Auto-offset) */
1155
1156         struct bGPdata *gpd;        /* grease-pencil data */
1157 } SpaceNode;
1158
1159 /* snode->flag */
1160 typedef enum eSpaceNode_Flag {
1161         SNODE_BACKDRAW       = (1 << 1),
1162         SNODE_SHOW_GPENCIL   = (1 << 2),
1163         SNODE_USE_ALPHA      = (1 << 3),
1164         SNODE_SHOW_ALPHA     = (1 << 4),
1165         SNODE_SHOW_R         = (1 << 7),
1166         SNODE_SHOW_G         = (1 << 8),
1167         SNODE_SHOW_B         = (1 << 9),
1168         SNODE_AUTO_RENDER    = (1 << 5),
1169 //      SNODE_SHOW_HIGHLIGHT = (1 << 6), DNA_DEPRECATED
1170 //      SNODE_USE_HIDDEN_PREVIEW = (1 << 10), DNA_DEPRECATED December2013 
1171         SNODE_NEW_SHADERS    = (1 << 11),
1172         SNODE_PIN            = (1 << 12),
1173         SNODE_SKIP_INSOFFSET = (1 << 13), /* automatically offset following nodes in a chain on insertion */
1174 } eSpaceNode_Flag;
1175
1176 /* snode->texfrom */
1177 typedef enum eSpaceNode_TexFrom {
1178         SNODE_TEX_OBJECT   = 0,
1179         SNODE_TEX_WORLD    = 1,
1180         SNODE_TEX_BRUSH    = 2,
1181         SNODE_TEX_LINESTYLE = 3,
1182 } eSpaceNode_TexFrom;
1183
1184 /* snode->shaderfrom */
1185 typedef enum eSpaceNode_ShaderFrom {
1186         SNODE_SHADER_OBJECT = 0,
1187         SNODE_SHADER_WORLD = 1,
1188         SNODE_SHADER_LINESTYLE = 2,
1189 } eSpaceNode_ShaderFrom;
1190
1191 /* snode->insert_ofs_dir */
1192 enum {
1193         SNODE_INSERTOFS_DIR_RIGHT = 0,
1194         SNODE_INSERTOFS_DIR_LEFT  = 1,
1195 };
1196
1197 /* Game Logic Editor ===================================== */
1198
1199 /* Logic Editor */
1200 typedef struct SpaceLogic {
1201         SpaceLink *next, *prev;
1202         ListBase regionbase;        /* storage of regions for inactive spaces */
1203         int spacetype;
1204         float blockscale DNA_DEPRECATED;
1205         
1206         short blockhandler[8]  DNA_DEPRECATED;
1207         
1208         short flag, scaflag;
1209         int pad;
1210         
1211         struct bGPdata *gpd;        /* grease-pencil data */
1212 } SpaceLogic;
1213
1214 /* Console ================================================ */
1215
1216 /* Console content */
1217 typedef struct ConsoleLine {
1218         struct ConsoleLine *next, *prev;
1219         
1220         /* keep these 3 vars so as to share free, realloc funcs */
1221         int len_alloc;  /* allocated length */
1222         int len;    /* real len - strlen() */
1223         char *line; 
1224         
1225         int cursor;
1226         int type; /* only for use when in the 'scrollback' listbase */
1227 } ConsoleLine;
1228
1229 /* ConsoleLine.type */
1230 typedef enum eConsoleLine_Type {
1231         CONSOLE_LINE_OUTPUT = 0,
1232         CONSOLE_LINE_INPUT = 1,
1233         CONSOLE_LINE_INFO = 2, /* autocomp feedback */
1234         CONSOLE_LINE_ERROR = 3
1235 } eConsoleLine_Type;
1236
1237
1238 /* Console View */
1239 typedef struct SpaceConsole {
1240         SpaceLink *next, *prev;
1241         ListBase regionbase;        /* storage of regions for inactive spaces */
1242         int spacetype;
1243         float blockscale DNA_DEPRECATED;            // XXX are these needed?
1244         short blockhandler[8]  DNA_DEPRECATED;      // XXX are these needed?
1245         
1246         /* space vars */
1247         int lheight, pad;
1248
1249         ListBase scrollback; /* ConsoleLine; output */
1250         ListBase history; /* ConsoleLine; command history, current edited line is the first */
1251         char prompt[256];
1252         char language[32]; /* multiple consoles are possible, not just python */
1253         
1254         int sel_start;
1255         int sel_end;
1256 } SpaceConsole;
1257
1258
1259 /* User Preferences ======================================= */
1260
1261 /* User Preferences View */
1262 typedef struct SpaceUserPref {
1263         SpaceLink *next, *prev;
1264         ListBase regionbase;        /* storage of regions for inactive spaces */
1265         int spacetype;
1266         
1267         char pad[3];
1268         char filter_type;
1269         char filter[64];        /* search term for filtering in the UI */
1270 } SpaceUserPref;
1271
1272 /* Motion Tracking ======================================== */
1273
1274 /* Clip Editor */
1275 typedef struct SpaceClip {
1276         SpaceLink *next, *prev;
1277         ListBase regionbase;        /* storage of regions for inactive spaces */
1278         int spacetype;
1279
1280         float xof, yof;             /* user defined offset, image is centered */
1281         float xlockof, ylockof;     /* user defined offset from locked position */
1282         float zoom;                 /* user defined zoom level */
1283
1284         struct MovieClipUser user;      /* user of clip */
1285         struct MovieClip *clip;         /* clip data */
1286         struct MovieClipScopes scopes;  /* different scoped displayed in space panels */
1287
1288         int flag;                   /* flags */
1289         short mode;                 /* editor mode (editing context being displayed) */
1290         short view;                 /* type of the clip editor view */
1291
1292         int path_length;            /* length of displaying path, in frames */
1293
1294         /* current stabilization data */
1295         float loc[2], scale, angle; /* pre-composed stabilization data */
1296         int pad;
1297         float stabmat[4][4], unistabmat[4][4];  /* current stabilization matrix and the same matrix in unified space,
1298                                                  * defined when drawing and used for mouse position calculation */
1299
1300         /* movie postprocessing */
1301         int postproc_flag;
1302
1303         /* grease pencil */
1304         short gpencil_src, pad2;
1305
1306         int around, pad4;             /* pivot point for transforms */
1307
1308         float cursor[2];              /* Mask editor 2d cursor */
1309
1310         MaskSpaceInfo mask_info;
1311 } SpaceClip;
1312
1313 /* SpaceClip->flag */
1314 typedef enum eSpaceClip_Flag {
1315         SC_SHOW_MARKER_PATTERN      = (1 << 0),
1316         SC_SHOW_MARKER_SEARCH       = (1 << 1),
1317         SC_LOCK_SELECTION           = (1 << 2),
1318         SC_SHOW_TINY_MARKER         = (1 << 3),
1319         SC_SHOW_TRACK_PATH          = (1 << 4),
1320         SC_SHOW_BUNDLES             = (1 << 5),
1321         SC_MUTE_FOOTAGE             = (1 << 6),
1322         SC_HIDE_DISABLED            = (1 << 7),
1323         SC_SHOW_NAMES               = (1 << 8),
1324         SC_SHOW_GRID                = (1 << 9),
1325         SC_SHOW_STABLE              = (1 << 10),
1326         SC_MANUAL_CALIBRATION       = (1 << 11),
1327         SC_SHOW_GPENCIL             = (1 << 12),
1328         SC_SHOW_FILTERS             = (1 << 13),
1329         SC_SHOW_GRAPH_FRAMES        = (1 << 14),
1330         SC_SHOW_GRAPH_TRACKS_MOTION = (1 << 15),
1331 /*      SC_SHOW_PYRAMID_LEVELS      = (1 << 16), */     /* UNUSED */
1332         SC_LOCK_TIMECURSOR          = (1 << 17),
1333         SC_SHOW_SECONDS             = (1 << 18),
1334         SC_SHOW_GRAPH_SEL_ONLY      = (1 << 19),
1335         SC_SHOW_GRAPH_HIDDEN        = (1 << 20),
1336         SC_SHOW_GRAPH_TRACKS_ERROR  = (1 << 21),
1337         SC_SHOW_METADATA            = (1 << 22),
1338 } eSpaceClip_Flag;
1339
1340 /* SpaceClip->mode */
1341 typedef enum eSpaceClip_Mode {
1342         SC_MODE_TRACKING = 0,
1343         /*SC_MODE_RECONSTRUCTION = 1,*/  /* DEPRECATED */
1344         /*SC_MODE_DISTORTION = 2,*/  /* DEPRECATED */
1345         SC_MODE_MASKEDIT = 3,
1346 } eSpaceClip_Mode;
1347
1348 /* SpaceClip->view */
1349 typedef enum eSpaceClip_View {
1350         SC_VIEW_CLIP = 0,
1351         SC_VIEW_GRAPH = 1,
1352         SC_VIEW_DOPESHEET = 2,
1353 } eSpaceClip_View;
1354
1355 /* SpaceClip->gpencil_src */
1356 typedef enum eSpaceClip_GPencil_Source {
1357         SC_GPENCIL_SRC_CLIP = 0,
1358         SC_GPENCIL_SRC_TRACK = 1,
1359 } eSpaceClip_GPencil_Source;
1360
1361 /* **************** SPACE DEFINES ********************* */
1362
1363 /* space types, moved from DNA_screen_types.h */
1364 /* Do NOT change order, append on end. types are hardcoded needed */
1365 typedef enum eSpace_Type {
1366         SPACE_EMPTY    = 0,
1367         SPACE_VIEW3D   = 1,
1368         SPACE_IPO      = 2,
1369         SPACE_OUTLINER = 3,
1370         SPACE_BUTS     = 4,
1371         SPACE_FILE     = 5,
1372         SPACE_IMAGE    = 6,
1373         SPACE_INFO     = 7,
1374         SPACE_SEQ      = 8,
1375         SPACE_TEXT     = 9,
1376 #ifdef DNA_DEPRECATED
1377         SPACE_IMASEL   = 10, /* deprecated */
1378         SPACE_SOUND    = 11, /* Deprecated */
1379 #endif
1380         SPACE_ACTION   = 12,
1381         SPACE_NLA      = 13,
1382         /* TODO: fully deprecate */
1383         SPACE_SCRIPT   = 14, /* Deprecated */
1384         SPACE_TIME     = 15,
1385         SPACE_NODE     = 16,
1386         SPACE_LOGIC    = 17,
1387         SPACE_CONSOLE  = 18,
1388         SPACE_USERPREF = 19,
1389         SPACE_CLIP     = 20,
1390         
1391         SPACEICONMAX = SPACE_CLIP
1392 } eSpace_Type;
1393
1394 /* use for function args */
1395 #define SPACE_TYPE_ANY -1
1396
1397
1398 #define IMG_SIZE_FALLBACK 256
1399
1400 #endif  /* __DNA_SPACE_TYPES_H__ */