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