1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*/
/** \file
* \ingroup DNA
*
* Structs for each of space type in the user interface.
*/
#pragma once
#include "DNA_color_types.h" /* for Histogram */
#include "DNA_defs.h"
#include "DNA_image_types.h" /* ImageUser */
#include "DNA_listBase.h"
#include "DNA_movieclip_types.h" /* MovieClipUser */
#include "DNA_node_types.h" /* for bNodeInstanceKey */
#include "DNA_outliner_types.h" /* for TreeStoreElem */
#include "DNA_sequence_types.h" /* SequencerScopes */
#include "DNA_vec_types.h"
/* Hum ... Not really nice... but needed for spacebuts. */
#include "DNA_view2d_types.h"
#ifdef __cplusplus
extern "C" {
#endif
struct BLI_mempool;
struct FileLayout;
struct FileList;
struct FileSelectParams;
struct Histogram;
struct ID;
struct Image;
struct Mask;
struct MovieClip;
struct MovieClipScopes;
struct Scopes;
struct Script;
struct SpaceGraph;
struct Text;
struct bDopeSheet;
struct bGPdata;
struct bNodeTree;
struct wmOperator;
struct wmTimer;
/* Defined in `buttons_intern.h`. */
typedef struct SpaceProperties_Runtime SpaceProperties_Runtime;
/* Defined in `node_intern.h`. */
typedef struct SpaceNode_Runtime SpaceNode_Runtime;
/* -------------------------------------------------------------------- */
/** \name SpaceLink (Base)
* \{ */
/**
* The base structure all the other spaces
* are derived (implicitly) from. Would be
* good to make this explicit.
*/
typedef struct SpaceLink {
struct SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
} SpaceLink;
/* SpaceLink.link_flag */
enum {
/**
* The space is not a regular one opened through the editor menu (for example) but spawned by an
* operator to fulfill some task and then disappear again.
* Can typically be cancelled using Escape, but that is handled on the editor level. */
SPACE_FLAG_TYPE_TEMPORARY = (1 << 0),
/**
* Used to mark a space as active but "overlapped" by temporary full-screen spaces. Without this
* we wouldn't be able to restore the correct active space after closing temp full-screens
* reliably if the same space type is opened twice in a full-screen stack (see T19296). We don't
* actually open the same space twice, we have to pretend it is by managing area order carefully.
*/
SPACE_FLAG_TYPE_WAS_ACTIVE = (1 << 1),
};
/** \} */
/* -------------------------------------------------------------------- */
/** \name Space Info
* \{ */
/* Info Header */
typedef struct SpaceInfo {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
char rpt_mask;
char _pad[7];
} SpaceInfo;
/* SpaceInfo.rpt_mask */
typedef enum eSpaceInfo_RptMask {
INFO_RPT_DEBUG = (1 << 0),
INFO_RPT_INFO = (1 << 1),
INFO_RPT_OP = (1 << 2),
INFO_RPT_WARN = (1 << 3),
INFO_RPT_ERR = (1 << 4),
} eSpaceInfo_RptMask;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Properties Editor
* \{ */
/* Properties Editor */
typedef struct SpaceProperties {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
/** Deprecated, copied to region. */
View2D v2d DNA_DEPRECATED;
/* For different kinds of property editors (exposed in the space type selector). */
short space_subtype;
/** Context tabs. */
short mainb, mainbo, mainbuser;
/** Preview is signal to refresh. */
short preview;
char _pad[4];
char flag;
/* eSpaceButtons_OutlinerSync */
char outliner_sync;
/** Runtime. */
void *path;
/** Runtime. */
int pathflag, dataicon;
ID *pinid;
void *texuser;
/* Doesn't necessarily need to be a pointer, but runtime structs are still written to files. */
struct SpaceProperties_Runtime *runtime;
} SpaceProperties;
/* button defines (deprecated) */
#ifdef DNA_DEPRECATED_ALLOW
/* warning: the values of these defines are used in SpaceProperties.tabs[8] */
/* SpaceProperties.mainb new */
# define CONTEXT_SCENE 0
# define CONTEXT_OBJECT 1
// #define CONTEXT_TYPES 2
# define CONTEXT_SHADING 3
# define CONTEXT_EDITING 4
// #define CONTEXT_SCRIPT 5
// #define CONTEXT_LOGIC 6
/* SpaceProperties.mainb old (deprecated) */
// #define BUTS_VIEW 0
# define BUTS_LAMP 1
# define BUTS_MAT 2
# define BUTS_TEX 3
# define BUTS_ANIM 4
# define BUTS_WORLD 5
# define BUTS_RENDER 6
# define BUTS_EDIT 7
// #define BUTS_GAME 8
# define BUTS_FPAINT 9
# define BUTS_RADIO 10
# define BUTS_SCRIPT 11
// #define BUTS_SOUND 12
# define BUTS_CONSTRAINT 13
// #define BUTS_EFFECTS 14
#endif /* DNA_DEPRECATED_ALLOW */
/* SpaceProperties.mainb new */
typedef enum eSpaceButtons_Context {
BCONTEXT_RENDER = 0,
BCONTEXT_SCENE = 1,
BCONTEXT_WORLD = 2,
BCONTEXT_OBJECT = 3,
BCONTEXT_DATA = 4,
BCONTEXT_MATERIAL = 5,
BCONTEXT_TEXTURE = 6,
BCONTEXT_PARTICLE = 7,
BCONTEXT_PHYSICS = 8,
BCONTEXT_BONE = 9,
BCONTEXT_MODIFIER = 10,
BCONTEXT_CONSTRAINT = 11,
BCONTEXT_BONE_CONSTRAINT = 12,
BCONTEXT_VIEW_LAYER = 13,
BCONTEXT_TOOL = 14,
BCONTEXT_SHADERFX = 15,
BCONTEXT_OUTPUT = 16,
/* Keep last. */
BCONTEXT_TOT,
} eSpaceButtons_Context;
/* SpaceProperties.flag */
typedef enum eSpaceButtons_Flag {
/* SB_PRV_OSA = (1 << 0), */ /* UNUSED */
SB_PIN_CONTEXT = (1 << 1),
SB_FLAG_UNUSED_2 = (1 << 2),
SB_FLAG_UNUSED_3 = (1 << 3),
/** Do not add materials, particles, etc. in TemplateTextureUser list. */
SB_TEX_USER_LIMITED = (1 << 3),
SB_SHADING_CONTEXT = (1 << 4),
} eSpaceButtons_Flag;
/* SpaceProperties.outliner_sync */
typedef enum eSpaceButtons_OutlinerSync {
PROPERTIES_SYNC_AUTO = 0,
PROPERTIES_SYNC_OFF = 1,
PROPERTIES_SYNC_ON = 2,
} eSpaceButtons_OutlinerSync;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Outliner
* \{ */
/* Defined in `outliner_intern.h`. */
typedef struct SpaceOutliner_Runtime SpaceOutliner_Runtime;
/* Outliner */
typedef struct SpaceOutliner {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
/** Deprecated, copied to region. */
View2D v2d DNA_DEPRECATED;
ListBase tree;
/* treestore is an ordered list of TreeStoreElem's from outliner tree;
* Note that treestore may contain duplicate elements if element
* is used multiple times in outliner tree (e. g. linked objects)
* Also note that BLI_mempool can not be read/written in DNA directly,
* therefore readfile.c/writefile.c linearize treestore into TreeStore structure
*/
struct BLI_mempool *treestore;
/* search stuff */
char search_string[64];
struct TreeStoreElem search_tse;
short flag, outlinevis, storeflag;
char search_flags;
/** Selection syncing flag (#WM_OUTLINER_SYNC_SELECT_FROM_OBJECT and similar flags). */
char sync_select_dirty;
int filter;
char filter_state;
char show_restrict_flags;
short filter_id_type;
SpaceOutliner_Runtime *runtime;
} SpaceOutliner;
/* SpaceOutliner.flag */
typedef enum eSpaceOutliner_Flag {
/* SO_TESTBLOCKS = (1 << 0), */ /* UNUSED */
/* SO_NEWSELECTED = (1 << 1), */ /* UNUSED */
SO_FLAG_UNUSED_1 = (1 << 2), /* cleared */
/* SO_HIDE_KEYINGSETINFO = (1 << 3), */ /* UNUSED */
SO_SKIP_SORT_ALPHA = (1 << 4),
SO_SYNC_SELECT = (1 << 5),
SO_MODE_COLUMN = (1 << 6),
} eSpaceOutliner_Flag;
/* SpaceOutliner.filter */
typedef enum eSpaceOutliner_Filter {
SO_FILTER_SEARCH = (1 << 0), /* Run-time flag. */
SO_FILTER_CLEARED_1 = (1 << 1),
SO_FILTER_NO_LIB_OVERRIDE = SO_FILTER_CLEARED_1, /* re-use */
SO_FILTER_NO_OBJECT = (1 << 2),
SO_FILTER_NO_OB_CONTENT = (1 << 3), /* Not only mesh, but modifiers, constraints, ... */
SO_FILTER_NO_CHILDREN = (1 << 4),
SO_FILTER_UNUSED_5 = (1 << 5), /* cleared */
SO_FILTER_NO_OB_MESH = (1 << 6),
SO_FILTER_NO_OB_ARMATURE = (1 << 7),
SO_FILTER_NO_OB_EMPTY = (1 << 8),
SO_FILTER_NO_OB_LAMP = (1 << 9),
SO_FILTER_NO_OB_CAMERA = (1 << 10),
SO_FILTER_NO_OB_OTHERS = (1 << 11),
SO_FILTER_OB_STATE_SELECTABLE = (1 << 12), /* Not set via DNA. */
SO_FILTER_OB_STATE_VISIBLE = (1 << 13), /* Not set via DNA. */
SO_FILTER_OB_STATE_INVERSE = (1 << 14),
SO_FILTER_OB_STATE_SELECTED = (1 << 15), /* Not set via DNA. */
SO_FILTER_OB_STATE_ACTIVE = (1 << 16), /* Not set via DNA. */
SO_FILTER_NO_COLLECTION = (1 << 17),
SO_FILTER_ID_TYPE = (1 << 18),
} eSpaceOutliner_Filter;
#define SO_FILTER_OB_TYPE \
(SO_FILTER_NO_OB_MESH | SO_FILTER_NO_OB_ARMATURE | SO_FILTER_NO_OB_EMPTY | \
SO_FILTER_NO_OB_LAMP | SO_FILTER_NO_OB_CAMERA | SO_FILTER_NO_OB_OTHERS)
#define SO_FILTER_OB_STATE \
(SO_FILTER_OB_STATE_VISIBLE | SO_FILTER_OB_STATE_SELECTED | SO_FILTER_OB_STATE_ACTIVE | \
SO_FILTER_OB_STATE_SELECTABLE)
#define SO_FILTER_ANY \
(SO_FILTER_NO_OB_CONTENT | SO_FILTER_NO_CHILDREN | SO_FILTER_OB_TYPE | SO_FILTER_OB_STATE | \
SO_FILTER_NO_COLLECTION | SO_FILTER_NO_LIB_OVERRIDE)
/* SpaceOutliner.filter_state */
typedef enum eSpaceOutliner_StateFilter {
SO_FILTER_OB_ALL = 0,
SO_FILTER_OB_VISIBLE = 1,
SO_FILTER_OB_HIDDEN = 2, /* deprecated */
SO_FILTER_OB_SELECTED = 3,
SO_FILTER_OB_ACTIVE = 4,
SO_FILTER_OB_SELECTABLE = 5,
} eSpaceOutliner_StateFilter;
/* SpaceOutliner.show_restrict_flags */
typedef enum eSpaceOutliner_ShowRestrictFlag {
SO_RESTRICT_ENABLE = (1 << 0),
SO_RESTRICT_SELECT = (1 << 1),
SO_RESTRICT_HIDE = (1 << 2),
SO_RESTRICT_VIEWPORT = (1 << 3),
SO_RESTRICT_RENDER = (1 << 4),
SO_RESTRICT_HOLDOUT = (1 << 5),
SO_RESTRICT_INDIRECT_ONLY = (1 << 6),
} eSpaceOutliner_Restrict;
/* SpaceOutliner.outlinevis */
typedef enum eSpaceOutliner_Mode {
SO_SCENES = 0,
/* SO_CUR_SCENE = 1, */ /* deprecated! */
/* SO_VISIBLE = 2, */ /* deprecated! */
/* SO_SELECTED = 3, */ /* deprecated! */
/* SO_ACTIVE = 4, */ /* deprecated! */
/* SO_SAME_TYPE = 5, */ /* deprecated! */
/* SO_GROUPS = 6, */ /* deprecated! */
SO_LIBRARIES = 7,
/* SO_VERSE_SESSION = 8, */ /* deprecated! */
/* SO_VERSE_MS = 9, */ /* deprecated! */
SO_SEQUENCE = 10,
SO_DATA_API = 11,
/* SO_USERDEF = 12, */ /* deprecated! */
/* SO_KEYMAP = 13, */ /* deprecated! */
SO_ID_ORPHANS = 14,
SO_VIEW_LAYER = 15,
} eSpaceOutliner_Mode;
/* SpaceOutliner.storeflag */
typedef enum eSpaceOutliner_StoreFlag {
/* cleanup tree */
SO_TREESTORE_CLEANUP = (1 << 0),
SO_TREESTORE_UNUSED_1 = (1 << 1), /* cleared */
/* rebuild the tree, similar to cleanup,
* but defer a call to BKE_outliner_treehash_rebuild_from_treestore instead */
SO_TREESTORE_REBUILD = (1 << 2),
} eSpaceOutliner_StoreFlag;
/* outliner search flags (SpaceOutliner.search_flags) */
typedef enum eSpaceOutliner_Search_Flags {
SO_FIND_CASE_SENSITIVE = (1 << 0),
SO_FIND_COMPLETE = (1 << 1),
SO_SEARCH_RECURSIVE = (1 << 2),
} eSpaceOutliner_Search_Flags;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Graph Editor
* \{ */
typedef struct SpaceGraph_Runtime {
/** #eGraphEdit_Runtime_Flag */
char flag;
char _pad[7];
/** Sampled snapshots of F-Curves used as in-session guides */
ListBase ghost_curves;
} SpaceGraph_Runtime;
/* 'Graph' Editor (formerly known as the IPO Editor) */
typedef struct SpaceGraph {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
/** Deprecated, copied to region. */
View2D v2d DNA_DEPRECATED;
/** Settings for filtering animation data
* \note we use a pointer due to code-linking issues. */
struct bDopeSheet *ads;
/** Mode for the Graph editor (eGraphEdit_Mode). */
short mode;
/**
* Time-transform autosnapping settings for Graph editor
* (eAnimEdit_AutoSnap in DNA_action_types.h).
*/
short autosnap;
/** Settings for Graph editor (eGraphEdit_Flag). */
int flag;
/** Time value for cursor (when in drivers mode; animation uses current frame). */
float cursorTime;
/** Cursor value (y-value, x-value is current frame). */
float cursorVal;
/** Pivot point for transforms. */
int around;
char _pad[4];
SpaceGraph_Runtime runtime;
} SpaceGraph;
/* SpaceGraph.flag (Graph Editor Settings) */
typedef enum eGraphEdit_Flag {
/* OLD DEPRECATED SETTING */
/* SIPO_LOCK_VIEW = (1 << 0), */
/* don't merge keyframes on the same frame after a transform */
SIPO_NOTRANSKEYCULL = (1 << 1),
/* don't show any keyframe handles at all */
SIPO_NOHANDLES = (1 << 2),
/* SIPO_NODRAWCFRANUM = (1 << 3), DEPRECATED */
/* show timing in seconds instead of frames */
SIPO_DRAWTIME = (1 << 4),
/* only show keyframes for selected F-Curves */
SIPO_SELCUVERTSONLY = (1 << 5),
/* draw names of F-Curves beside the respective curves */
/* NOTE: currently not used */
/* SIPO_DRAWNAMES = (1 << 6), */ /* UNUSED */
/* show sliders in channels list */
SIPO_SLIDERS = (1 << 7),
/* don't show the horizontal component of the cursor */
SIPO_NODRAWCURSOR = (1 << 8),
/* only show handles of selected keyframes */
SIPO_SELVHANDLESONLY = (1 << 9),
/* don't perform realtime updates */
SIPO_NOREALTIMEUPDATES = (1 << 11),
/* don't draw curves with AA ("beauty-draw") for performance */
SIPO_BEAUTYDRAW_OFF = (1 << 12),
/* draw grouped channels with colors set in group */
/* SIPO_NODRAWGCOLORS = (1 << 13), DEPRECATED */
/* normalize curves on display */
SIPO_NORMALIZE = (1 << 14),
SIPO_NORMALIZE_FREEZE = (1 << 15),
/* show markers region */
SIPO_SHOW_MARKERS = (1 << 16),
} eGraphEdit_Flag;
/* SpaceGraph.mode (Graph Editor Mode) */
typedef enum eGraphEdit_Mode {
/* all animation curves (from all over Blender) */
SIPO_MODE_ANIMATION = 0,
/* drivers only */
SIPO_MODE_DRIVERS = 1,
} eGraphEdit_Mode;
typedef enum eGraphEdit_Runtime_Flag {
/** Temporary flag to force channel selections to be synced with main. */
SIPO_RUNTIME_FLAG_NEED_CHAN_SYNC = (1 << 0),
/** Temporary flag to force fcurves to recalculate colors. */
SIPO_RUNTIME_FLAG_NEED_CHAN_SYNC_COLOR = (1 << 1),
/**
* These flags are for the mouse-select code to communicate with the transform code. Click
* dragging (tweaking) a handle sets the according left/right flag which transform code uses then
* to limit translation to this side. */
SIPO_RUNTIME_FLAG_TWEAK_HANDLES_LEFT = (1 << 2),
SIPO_RUNTIME_FLAG_TWEAK_HANDLES_RIGHT = (1 << 3),
} eGraphEdit_Runtime_Flag;
/** \} */
/* -------------------------------------------------------------------- */
/** \name NLA Editor
* \{ */
/* NLA Editor */
typedef struct SpaceNla {
struct SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
/** This uses the same settings as autosnap for Action Editor. */
short autosnap;
short flag;
char _pad[4];
struct bDopeSheet *ads;
/** Deprecated, copied to region. */
View2D v2d DNA_DEPRECATED;
} SpaceNla;
/* SpaceNla.flag */
typedef enum eSpaceNla_Flag {
SNLA_FLAG_UNUSED_0 = (1 << 0),
SNLA_FLAG_UNUSED_1 = (1 << 1),
/* draw timing in seconds instead of frames */
SNLA_DRAWTIME = (1 << 2),
SNLA_FLAG_UNUSED_3 = (1 << 3),
/* SNLA_NODRAWCFRANUM = (1 << 4), DEPRECATED */
/* don't draw influence curves on strips */
SNLA_NOSTRIPCURVES = (1 << 5),
/* don't perform realtime updates */
SNLA_NOREALTIMEUPDATES = (1 << 6),
/* don't show local strip marker indications */
SNLA_NOLOCALMARKERS = (1 << 7),
/* show markers region */
SNLA_SHOW_MARKERS = (1 << 8),
} eSpaceNla_Flag;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Sequence Editor
* \{ */
/* Sequencer */
typedef struct SpaceSeq {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
/** Deprecated, copied to region. */
View2D v2d DNA_DEPRECATED;
/** Deprecated: offset for drawing the image preview. */
float xof DNA_DEPRECATED, yof DNA_DEPRECATED;
/** Weird name for the sequencer subtype (seq, image, luma... etc). */
short mainb;
/** ESpaceSeq_Proxy_RenderSize. */
short render_size;
short chanshown;
short zebra;
int flag;
/** Deprecated, handled by View2D now. */
float zoom DNA_DEPRECATED;
/** See SEQ_VIEW_* below. */
int view;
int overlay_type;
/** Overlay an image of the editing on below the strips. */
int draw_flag;
char _pad[4];
/** Grease-pencil data. */
struct bGPdata *gpd;
/** Different scoped displayed in space. */
struct SequencerScopes scopes;
/** Multiview current eye - for internal use. */
char multiview_eye;
char _pad2[7];
} SpaceSeq;
/* SpaceSeq.mainb */
typedef enum eSpaceSeq_RegionType {
SEQ_DRAW_SEQUENCE = 0,
SEQ_DRAW_IMG_IMBUF = 1,
SEQ_DRAW_IMG_WAVEFORM = 2,
SEQ_DRAW_IMG_VECTORSCOPE = 3,
SEQ_DRAW_IMG_HISTOGRAM = 4,
} eSpaceSeq_RegionType;
/* SpaceSeq.draw_flag */
typedef enum eSpaceSeq_DrawFlag {
SEQ_DRAW_BACKDROP = (1 << 0),
SEQ_DRAW_OFFSET_EXT = (1 << 1),
} eSpaceSeq_DrawFlag;
/* SpaceSeq.flag */
typedef enum eSpaceSeq_Flag {
SEQ_DRAWFRAMES = (1 << 0),
SEQ_MARKER_TRANS = (1 << 1),
SEQ_DRAW_COLOR_SEPARATED = (1 << 2),
SEQ_SHOW_SAFE_MARGINS = (1 << 3),
SEQ_SHOW_GPENCIL = (1 << 4),
SEQ_SHOW_FCURVES = (1 << 5),
SEQ_USE_ALPHA = (1 << 6), /* use RGBA display mode for preview */
SEQ_ALL_WAVEFORMS = (1 << 7), /* draw all waveforms */
SEQ_NO_WAVEFORMS = (1 << 8), /* draw no waveforms */
SEQ_SHOW_SAFE_CENTER = (1 << 9),
SEQ_SHOW_METADATA = (1 << 10),
SEQ_SHOW_MARKERS = (1 << 11), /* show markers region */
SEQ_ZOOM_TO_FIT = (1 << 12),
SEQ_SHOW_STRIP_OVERLAY = (1 << 13),
SEQ_SHOW_STRIP_NAME = (1 << 14),
SEQ_SHOW_STRIP_SOURCE = (1 << 15),
SEQ_SHOW_STRIP_DURATION = (1 << 16),
} eSpaceSeq_Flag;
/* SpaceSeq.view */
typedef enum eSpaceSeq_Displays {
SEQ_VIEW_SEQUENCE = 1,
SEQ_VIEW_PREVIEW = 2,
SEQ_VIEW_SEQUENCE_PREVIEW = 3,
} eSpaceSeq_Dispays;
/* SpaceSeq.render_size */
typedef enum eSpaceSeq_Proxy_RenderSize {
SEQ_RENDER_SIZE_NONE = -1,
SEQ_RENDER_SIZE_SCENE = 0,
SEQ_RENDER_SIZE_PROXY_25 = 25,
SEQ_RENDER_SIZE_PROXY_50 = 50,
SEQ_RENDER_SIZE_PROXY_75 = 75,
SEQ_RENDER_SIZE_PROXY_100 = 99,
SEQ_RENDER_SIZE_FULL = 100,
} eSpaceSeq_Proxy_RenderSize;
typedef struct MaskSpaceInfo {
/* **** mask editing **** */
struct Mask *mask;
/* draw options */
char draw_flag;
char draw_type;
char overlay_mode;
char _pad3[5];
} MaskSpaceInfo;
/* SpaceSeq.mainb */
typedef enum eSpaceSeq_OverlayType {
SEQ_DRAW_OVERLAY_RECT = 0,
SEQ_DRAW_OVERLAY_REFERENCE = 1,
SEQ_DRAW_OVERLAY_CURRENT = 2,
} eSpaceSeq_OverlayType;
/** \} */
/* -------------------------------------------------------------------- */
/** \name File Selector
* \{ */
/**
* Information to identify a asset library. May be either one of the predefined types (current
* 'Main', builtin library, project library), or a custom type as defined in the Preferences.
*
* If the type is set to #FILE_ASSET_LIBRARY_CUSTOM, idname must have the name to identify the
* custom library. Otherwise idname is not used.
*/
typedef struct FileSelectAssetLibraryUID {
short type;
char _pad[2];
/**
* If showing a custom asset library (#FILE_ASSET_LIBRARY_CUSTOM), this is the index of the
* #bUserAssetLibrary within #UserDef.asset_libraries.
* Should be ignored otherwise (but better set to -1 then, for sanity and debugging).
*/
int custom_library_index;
} FileSelectAssetLibraryUID;
/* Config and Input for File Selector */
typedef struct FileSelectParams {
/** Title, also used for the text of the execute button. */
char title[96];
/**
* Directory, FILE_MAX_LIBEXTRA, 1024 + 66, this is for extreme case when 1023 length path
* needs to be linked in, where foo.blend/Armature need adding
*/
char dir[1090];
char file[256];
char renamefile[256];
short rename_flag;
/** List of filetypes to filter (FILE_MAXFILE). */
char filter_glob[256];
/** Text items name must match to be shown. */
char filter_search[64];
/** Same as filter, but for ID types (aka library groups). */
int _pad0;
uint64_t filter_id;
/** Active file used for keyboard navigation. */
int active_file;
/** File under cursor. */
int highlight_file;
int sel_first;
int sel_last;
unsigned short thumbnail_size;
char _pad1[2];
/* short */
/** XXXXX for now store type here, should be moved to the operator. */
short type; /* eFileSelectType */
/** Settings for filter, hiding dots files. */
short flag;
/** Sort order. */
short sort;
/** Display mode flag. */
short display;
/** Details toggles (file size, creation date, etc.) */
char details_flags;
char _pad2[3];
/** Filter when (flags & FILE_FILTER) is true. */
int filter;
/** Max number of levels in dirtree to show at once, 0 to disable recursion. */
short recursion_level;
/* XXX --- still unused -- */
/** Show font preview. */
short f_fp;
/** String to use for font preview. */
char fp_str[8];
/* XXX --- end unused -- */
} FileSelectParams;
/**
* File selection parameters for asset browsing mode, with #FileSelectParams as base.
*/
typedef struct FileAssetSelectParams {
FileSelectParams base_params;
FileSelectAssetLibraryUID asset_library;
} FileAssetSelectParams;
/**
* A wrapper to store previous and next folder lists (#FolderList) for a specific browse mode
* (#eFileBrowse_Mode).
*/
typedef struct FileFolderHistory {
struct FileFolderLists *next, *prev;
/** The browse mode this prev/next folder-lists are created for. */
char browse_mode; /* eFileBrowse_Mode */
char _pad[7];
/** Holds the list of previous directories to show. */
ListBase folders_prev;
/** Holds the list of next directories (pushed from previous) to show. */
ListBase folders_next;
} FileFolderHistory;
/* File Browser */
typedef struct SpaceFile {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
/** Is this a File Browser or an Asset Browser? */
char browse_mode; /* eFileBrowse_Mode */
char _pad1[1];
short tags;
int scroll_offset;
/** Config and input for file select. One for each browse-mode, to keep them independent. */
FileSelectParams *params;
FileAssetSelectParams *asset_params;
void *_pad2;
/**
* Holds the list of files to show.
* Currently recreated when browse-mode changes. Could be per browse-mode to avoid refreshes.
*/
struct FileList *files;
/**
* Holds the list of previous directories to show. Owned by `folder_histories` below.
*/
ListBase *folders_prev;
/**
* Holds the list of next directories (pushed from previous) to show. Owned by
* `folder_histories` below.
*/
ListBase *folders_next;
/**
* This actually owns the prev/next folder-lists above. On browse-mode change, the lists of the
* new mode get assigned to the above.
*/
ListBase folder_histories; /* FileFolderHistory */
/* operator that is invoking fileselect
* op->exec() will be called on the 'Load' button.
* if operator provides op->cancel(), then this will be invoked
* on the cancel button.
*/
struct wmOperator *op;
struct wmTimer *smoothscroll_timer;
struct wmTimer *previews_timer;
struct FileLayout *layout;
short recentnr, bookmarknr;
short systemnr, system_bookmarknr;
} SpaceFile;
/* SpaceFile.browse_mode (File Space Browsing Mode) */
typedef enum eFileBrowse_Mode {
/* Regular Blender File Browser */
FILE_BROWSE_MODE_FILES = 0,
/* Asset Browser */
FILE_BROWSE_MODE_ASSETS = 1,
} eFileBrowse_Mode;
typedef enum eFileAssetLibrary_Type {
/* For the future. Display assets bundled with Blender by default. */
// FILE_ASSET_LIBRARY_BUNDLED = 0,
/** Display assets from the current session (current "Main"). */
FILE_ASSET_LIBRARY_LOCAL = 1,
/* For the future. Display assets for the current project. */
// FILE_ASSET_LIBRARY_PROJECT = 2,
/** Display assets from custom asset libraries, as defined in the preferences
* (#bUserAssetLibrary). The name will be taken from #FileSelectParams.asset_library.idname
* then.
* In RNA, we add the index of the custom library to this to identify it by index. So keep
* this last! */
FILE_ASSET_LIBRARY_CUSTOM = 100,
} eFileAssetLibrary_Type;
/* FileSelectParams.display */
enum eFileDisplayType {
/** Internal (not exposed to users): Keep whatever display type was used during the last File
* Browser use, or the default if no such record is found. Use this unless there's a good reason
* to set a specific display type. */
FILE_DEFAULTDISPLAY = 0,
/* User selectable choices. */
FILE_VERTICALDISPLAY = 1,
FILE_HORIZONTALDISPLAY = 2,
FILE_IMGDISPLAY = 3,
};
/* FileSelectParams.sort */
enum eFileSortType {
/** Internal (not exposed to users): Sort by whatever was sorted by during the last File Browser
* use, or the default if no such record is found. Use this unless there's a good reason to set a
* specific sort order. */
FILE_SORT_DEFAULT = 0,
/* User selectable choices. */
FILE_SORT_ALPHA = 1,
FILE_SORT_EXTENSION = 2,
FILE_SORT_TIME = 3,
FILE_SORT_SIZE = 4,
};
/* SpaceFile.tags */
enum eFileTags {
/** Tag the space as having to update files representing or containing main data. Must be set
* after file read and undo/redo. */
FILE_TAG_REBUILD_MAIN_FILES = (1 << 0),
};
/* FileSelectParams.details_flags */
enum eFileDetails {
FILE_DETAILS_SIZE = (1 << 0),
FILE_DETAILS_DATETIME = (1 << 1),
};
/* these values need to be hardcoded in structs, dna does not recognize defines */
/* also defined in BKE */
#define FILE_MAXDIR 768
#define FILE_MAXFILE 256
#define FILE_MAX 1024
#define FILE_MAX_LIBEXTRA (FILE_MAX + MAX_ID_NAME)
/* filesel types */
typedef enum eFileSelectType {
FILE_LOADLIB = 1,
FILE_MAIN = 2,
FILE_MAIN_ASSET = 3,
FILE_UNIX = 8,
FILE_BLENDER = 8, /* don't display relative paths */
FILE_SPECIAL = 9,
} eFileSelectType;
/* filesel op property -> action */
typedef enum eFileSel_Action {
FILE_OPENFILE = 0,
FILE_SAVE = 1,
} eFileSel_Action;
/* sfile->params->flag */
/**
* \note short flag, also used as 16 lower bits of flags in link/append code
* (WM and BLO code area, see #eBLOLibLinkFlags in BLO_readfile.h).
*/
typedef enum eFileSel_Params_Flag {
FILE_PARAMS_FLAG_UNUSED_1 = (1 << 0), /* cleared */
FILE_RELPATH = (1 << 1),
FILE_LINK = (1 << 2),
FILE_HIDE_DOT = (1 << 3),
FILE_AUTOSELECT = (1 << 4),
FILE_ACTIVE_COLLECTION = (1 << 5),
FILE_PARAMS_FLAG_UNUSED_6 = (1 << 6), /* cleared */
FILE_DIRSEL_ONLY = (1 << 7),
FILE_FILTER = (1 << 8),
FILE_OBDATA_INSTANCE = (1 << 9),
FILE_COLLECTION_INSTANCE = (1 << 10),
FILE_SORT_INVERT = (1 << 11),
FILE_HIDE_TOOL_PROPS = (1 << 12),
FILE_CHECK_EXISTING = (1 << 13),
FILE_ASSETS_ONLY = (1 << 14),
} eFileSel_Params_Flag;
/* sfile->params->rename_flag */
/* Note: short flag. Defined as bitflags, but currently only used as exclusive status markers... */
typedef enum eFileSel_Params_RenameFlag {
/** Used when we only have the name of the entry we want to rename,
* but not yet access to its matching file entry. */
FILE_PARAMS_RENAME_PENDING = 1 << 0,
/** We are actually renaming an entry. */
FILE_PARAMS_RENAME_ACTIVE = 1 << 1,
/** Used to scroll to newly renamed entry. */
FILE_PARAMS_RENAME_POSTSCROLL_PENDING = 1 << 2,
FILE_PARAMS_RENAME_POSTSCROLL_ACTIVE = 1 << 3,
} eFileSel_Params_RenameFlag;
/**
* Files in the file selector list: file types
* Note we could use mere values (instead of bit-flags) for file types themselves,
* but since we do not lack of bytes currently.
*/
typedef enum eFileSel_File_Types {
FILE_TYPE_BLENDER = (1 << 2),
FILE_TYPE_BLENDER_BACKUP = (1 << 3),
FILE_TYPE_IMAGE = (1 << 4),
FILE_TYPE_MOVIE = (1 << 5),
FILE_TYPE_PYSCRIPT = (1 << 6),
FILE_TYPE_FTFONT = (1 << 7),
FILE_TYPE_SOUND = (1 << 8),
FILE_TYPE_TEXT = (1 << 9),
FILE_TYPE_ARCHIVE = (1 << 10),
/** represents folders for filtering */
FILE_TYPE_FOLDER = (1 << 11),
FILE_TYPE_BTX = (1 << 12),
FILE_TYPE_COLLADA = (1 << 13),
/** from filter_glob operator property */
FILE_TYPE_OPERATOR = (1 << 14),
FILE_TYPE_APPLICATIONBUNDLE = (1 << 15),
FILE_TYPE_ALEMBIC = (1 << 16),
/** For all kinds of recognized import/export formats. No need for specialized types. */
FILE_TYPE_OBJECT_IO = (1 << 17),
FILE_TYPE_USD = (1 << 18),
FILE_TYPE_VOLUME = (1 << 19),
FILE_TYPE_ASSET = (1 << 28),
/** An FS directory (i.e. S_ISDIR on its path is true). */
FILE_TYPE_DIR = (1 << 30),
FILE_TYPE_BLENDERLIB = (1u << 31),
} eFileSel_File_Types;
/* Selection Flags in filesel: struct direntry, unsigned char selflag */
typedef enum eDirEntry_SelectFlag {
/* FILE_SEL_ACTIVE = (1 << 1), */ /* UNUSED */
FILE_SEL_HIGHLIGHTED = (1 << 2),
FILE_SEL_SELECTED = (1 << 3),
FILE_SEL_EDITING = (1 << 4),
} eDirEntry_SelectFlag;
/* ***** Related to file browser, but never saved in DNA, only here to help with RNA. ***** */
/**
* About Unique identifier.
*
* Stored in a CustomProps once imported.
* Each engine is free to use it as it likes - it will be the only thing passed to it by blender to
* identify asset/variant/version (concatenating the three into a single 48 bytes one).
* Assumed to be 128bits, handled as four integers due to lack of real bytes proptype in RNA :|.
*/
#define ASSET_UUID_LENGTH 16
/* Used to communicate with asset engines outside of 'import' context. */
#
#
typedef struct AssetUUID {
int uuid_asset[4];
int uuid_variant[4];
int uuid_revision[4];
} AssetUUID;
#
#
typedef struct AssetUUIDList {
AssetUUID *uuids;
int nbr_uuids;
char _pad[4];
} AssetUUIDList;
/* Container for a revision, only relevant in asset context. */
#
#
typedef struct FileDirEntryRevision {
struct FileDirEntryRevision *next, *prev;
char *comment;
void *_pad;
int uuid[4];
uint64_t size;
int64_t time;
/* Temp caching of UI-generated strings... */
char size_str[16];
char datetime_str[16 + 8];
} FileDirEntryRevision;
/* Container for a variant, only relevant in asset context.
* In case there are no variants, a single one shall exist, with NULL name/description. */
#
#
typedef struct FileDirEntryVariant {
struct FileDirEntryVariant *next, *prev;
int uuid[4];
char *name;
char *description;
ListBase revisions;
int nbr_revisions;
int act_revision;
} FileDirEntryVariant;
/* Container for mere direntry, with additional asset-related data. */
#
#
typedef struct FileDirEntry {
struct FileDirEntry *next, *prev;
int uuid[4];
char *name;
char *description;
/* Either point to active variant/revision if available, or own entry
* (in mere filebrowser case). */
FileDirEntryRevision *entry;
/** #eFileSel_File_Types. */
int typeflag;
/** ID type, in case typeflag has FILE_TYPE_BLENDERLIB set. */
int blentype;
/* Path to item that is relative to current folder root. */
char *relpath;
/** Optional argument for shortcuts, aliases etc. */
char *redirection_path;
/** When showing local IDs (FILE_MAIN, FILE_MAIN_ASSET), ID this file represents. Note comment
* for FileListInternEntry.local_data, the same applies here! */
ID *id;
/** If this file represents an asset, its asset data is here. Note that we may show assets of
* external files in which case this is set but not the id above.
* Note comment for FileListInternEntry.local_data, the same applies here! */
struct AssetMetaData *asset_data;
/* The icon_id for the preview image. */
int preview_icon_id;
/* Tags are for info only, most of filtering is done in asset engine. */
char **tags;
int nbr_tags;
short status;
short flags;
/* eFileAttributes defined in BLI_fileops.h */
int attributes;
ListBase variants;
int nbr_variants;
int act_variant;
} FileDirEntry;
/**
* Array of direntries.
*
* This struct is used in various, different contexts.
*
* In Filebrowser UI, it stores the total number of available entries, the number of visible
* (filtered) entries, and a subset of those in 'entries' ListBase, from idx_start (included)
* to idx_end (excluded).
*
* In AssetEngine context (i.e. outside of 'browsing' context), entries contain all needed data,
* there is no filtering, so nbr_entries_filtered, entry_idx_start and entry_idx_end
* should all be set to -1.
*/
#
#
typedef struct FileDirEntryArr {
ListBase entries;
int nbr_entries;
int nbr_entries_filtered;
int entry_idx_start, entry_idx_end;
/** FILE_MAX. */
char root[1024];
} FileDirEntryArr;
#if 0 /* UNUSED */
/* FileDirEntry.status */
enum {
ASSET_STATUS_LOCAL = 1 << 0, /* If active uuid is available locally/immediately. */
ASSET_STATUS_LATEST = 1 << 1, /* If active uuid is latest available version. */
};
#endif
/* FileDirEntry.flags */
enum {
FILE_ENTRY_INVALID_PREVIEW = 1 << 0, /* The preview for this entry could not be generated. */
};
/** \} */
/* -------------------------------------------------------------------- */
/** \name Image/UV Editor
* \{ */
/* Image/UV Editor */
typedef struct SpaceImageOverlay {
int flag;
char _pad[4];
} SpaceImageOverlay;
typedef struct SpaceImage {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
struct Image *image;
struct ImageUser iuser;
/** Histogram waveform and vectorscope. */
struct Scopes scopes;
/** Sample line histogram. */
struct Histogram sample_line_hist;
/** Grease pencil data. */
struct bGPdata *gpd;
/** UV editor 2d cursor. */
float cursor[2];
/** User defined offset, image is centered. */
float xof, yof;
/** User defined zoom level. */
float zoom;
/** Storage for offset while render drawing. */
float centx, centy;
/** View/paint/mask. */
char mode;
/* Storage for sub-space types. */
char mode_prev;
char pin;
char _pad1;
/**
* The currently active tile of the image when tile is enabled,
* is kept in sync with the active faces tile.
*/
short curtile;
short lock;
/** UV draw type. */
char dt_uv;
/** Sticky selection type. */
char sticky;
char dt_uvstretch;
char around;
int flag;
char pixel_snap_mode;
char _pad2[7];
float uv_opacity;
int tile_grid_shape[2];
MaskSpaceInfo mask_info;
SpaceImageOverlay overlay;
} SpaceImage;
/* SpaceImage.dt_uv */
typedef enum eSpaceImage_UVDT {
SI_UVDT_OUTLINE = 0,
SI_UVDT_DASH = 1,
SI_UVDT_BLACK = 2,
SI_UVDT_WHITE = 3,
} eSpaceImage_UVDT;
/* SpaceImage.dt_uvstretch */
typedef enum eSpaceImage_UVDT_Stretch {
SI_UVDT_STRETCH_ANGLE = 0,
SI_UVDT_STRETCH_AREA = 1,
} eSpaceImage_UVDT_Stretch;
/* SpaceImage.pixel_snap_mode */
typedef enum eSpaceImage_PixelSnapMode {
SI_PIXEL_SNAP_DISABLED = 0,
SI_PIXEL_SNAP_CENTER = 1,
SI_PIXEL_SNAP_CORNER = 2,
} eSpaceImage_Snap_Mode;
/* SpaceImage.mode */
typedef enum eSpaceImage_Mode {
SI_MODE_VIEW = 0,
SI_MODE_PAINT = 1,
SI_MODE_MASK = 2,
SI_MODE_UV = 3,
} eSpaceImage_Mode;
/* SpaceImage.sticky
* Note DISABLE should be 0, however would also need to re-arrange icon order,
* also, sticky loc is the default mode so this means we don't need to 'do_versions' */
typedef enum eSpaceImage_Sticky {
SI_STICKY_LOC = 0,
SI_STICKY_DISABLE = 1,
SI_STICKY_VERTEX = 2,
} eSpaceImage_Sticky;
/* SpaceImage.flag */
typedef enum eSpaceImage_Flag {
SI_FLAG_UNUSED_0 = (1 << 0), /* cleared */
SI_FLAG_UNUSED_1 = (1 << 1), /* cleared */
SI_CLIP_UV = (1 << 2),
SI_FLAG_UNUSED_3 = (1 << 3), /* cleared */
SI_NO_DRAWFACES = (1 << 4),
SI_DRAWSHADOW = (1 << 5),
SI_FLAG_UNUSED_6 = (1 << 6), /* cleared */
SI_FLAG_UNUSED_7 = (1 << 7), /* cleared */
SI_FLAG_UNUSED_8 = (1 << 8), /* cleared */
SI_COORDFLOATS = (1 << 9),
SI_FLAG_UNUSED_10 = (1 << 10),
SI_LIVE_UNWRAP = (1 << 11),
SI_USE_ALPHA = (1 << 12),
SI_SHOW_ALPHA = (1 << 13),
SI_SHOW_ZBUF = (1 << 14),
/* next two for render window display */
SI_PREVSPACE = (1 << 15),
SI_FULLWINDOW = (1 << 16),
SI_FLAG_UNUSED_17 = (1 << 17),
SI_FLAG_UNUSED_18 = (1 << 18), /* cleared */
/**
* This means that the image is drawn until it reaches the view edge,
* in the image view, it's unrelated to UDIM tiles.
*/
SI_DRAW_TILE = (1 << 19),
SI_FLAG_UNUSED_20 = (1 << 20), /* cleared */
SI_DRAW_STRETCH = (1 << 21),
SI_SHOW_GPENCIL = (1 << 22),
SI_FLAG_UNUSED_23 = (1 << 23), /* cleared */
SI_FLAG_UNUSED_24 = (1 << 24),
SI_NO_DRAW_TEXPAINT = (1 << 25),
SI_DRAW_METADATA = (1 << 26),
SI_SHOW_R = (1 << 27),
SI_SHOW_G = (1 << 28),
SI_SHOW_B = (1 << 29),
} eSpaceImage_Flag;
typedef enum eSpaceImageOverlay_Flag {
SI_OVERLAY_SHOW_OVERLAYS = (1 << 0),
} eSpaceImageOverlay_Flag;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Text Editor
* \{ */
typedef struct SpaceText_Runtime {
/** Actual line height, scaled by dpi. */
int lheight_px;
/** Runtime computed, character width. */
int cwidth_px;
/** The handle of the scroll-bar which can be clicked and dragged. */
struct rcti scroll_region_handle;
/** The region for selected text to show in the scrolling area. */
struct rcti scroll_region_select;
/** Number of digits to show in the line numbers column (when enabled). */
int line_number_display_digits;
/** Number of lines this window can display (even when they aren't used). */
int viewlines;
/** Use for drawing scroll-bar & calculating scroll operator motion scaling. */
float scroll_px_per_line;
/**
* Run-time for scroll increments smaller than a line (smooth scroll).
* Values must be between zero and the line, column width: (cwidth, TXT_LINE_HEIGHT(st)).
*/
int scroll_ofs_px[2];
char _pad1[4];
/** Cache for faster drawing. */
void *drawcache;
} SpaceText_Runtime;
/* Text Editor */
typedef struct SpaceText {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
struct Text *text;
/** Determines at what line the top of the text is displayed. */
int top;
/** Determines the horizontal scroll (in columns). */
int left;
char _pad1[4];
short flags;
/** User preference, is font_size! */
short lheight;
int tabnumber;
/* Booleans */
char wordwrap;
char doplugins;
char showlinenrs;
char showsyntax;
char line_hlight;
char overwrite;
/** Run python while editing, evil. */
char live_edit;
char _pad2[1];
/** ST_MAX_FIND_STR. */
char findstr[256];
/** ST_MAX_FIND_STR. */
char replacestr[256];
/** Column number to show right margin at. */
short margin_column;
char _pad3[2];
/** Keep last. */
SpaceText_Runtime runtime;
} SpaceText;
/* SpaceText flags (moved from DNA_text_types.h) */
typedef enum eSpaceText_Flags {
/* scrollable */
ST_SCROLL_SELECT = (1 << 0),
ST_FLAG_UNUSED_4 = (1 << 4), /* dirty */
ST_FIND_WRAP = (1 << 5),
ST_FIND_ALL = (1 << 6),
ST_SHOW_MARGIN = (1 << 7),
ST_MATCH_CASE = (1 << 8),
ST_FIND_ACTIVATE = (1 << 9),
} eSpaceText_Flags;
/* SpaceText.findstr/replacestr */
#define ST_MAX_FIND_STR 256
/** \} */
/* -------------------------------------------------------------------- */
/** \name Script View (Obsolete)
* \{ */
/* Script Runtime Data - Obsolete (pre 2.5) */
typedef struct Script {
ID id;
void *py_draw;
void *py_event;
void *py_button;
void *py_browsercallback;
void *py_globaldict;
int flags, lastspace;
/**
* Store the script file here so we can re-run it on loading blender,
* if "Enable Scripts" is on
*/
/** 1024 = FILE_MAX. */
char scriptname[1024];
/** 1024 = FILE_MAX. */
char scriptarg[256];
} Script;
#define SCRIPT_SET_NULL(_script) \
_script->py_draw = _script->py_event = _script->py_button = _script->py_browsercallback = \
_script->py_globaldict = NULL; \
_script->flags = 0
/* Script View - Obsolete (pre 2.5) */
typedef struct SpaceScript {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
struct Script *script;
short flags, menunr;
char _pad1[4];
void *but_refs;
} SpaceScript;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Nodes Editor
* \{ */
typedef struct bNodeTreePath {
struct bNodeTreePath *next, *prev;
struct bNodeTree *nodetree;
/** Base key for nodes in this tree instance. */
bNodeInstanceKey parent_key;
char _pad[4];
/** V2d center point, so node trees can have different offsets in editors. */
float view_center[2];
/** MAX_NAME. */
char node_name[64];
} bNodeTreePath;
typedef struct SpaceNode {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
/** Deprecated, copied to region. */
View2D v2d DNA_DEPRECATED;
/** Context, no need to save in file? well... pinning... */
struct ID *id, *from;
short flag;
/** Direction for offsetting nodes on insertion. */
char insert_ofs_dir;
char _pad1;
/** Offset for drawing the backdrop. */
float xof, yof;
/** Zoom for backdrop. */
float zoom;
/**
* XXX nodetree pointer info is all in the path stack now,
* remove later on and use bNodeTreePath instead.
* For now these variables are set when pushing/popping
* from path stack, to avoid having to update all the functions and operators.
* Can be done when design is accepted and everything is properly tested.
*/
ListBase treepath;
/* The tree farthest down in the group heirarchy. */
struct bNodeTree *edittree;
struct bNodeTree *nodetree;
/* tree type for the current node tree */
char tree_idname[64];
/** Treetype: as same nodetree->type. */
int treetype DNA_DEPRECATED;
/** Texfrom object, world or brush. */
short texfrom;
/** Shader from object or world. */
short shaderfrom;
/** Grease-pencil data. */
struct bGPdata *gpd;
SpaceNode_Runtime *runtime;
} SpaceNode;
/* SpaceNode.flag */
typedef enum eSpaceNode_Flag {
SNODE_BACKDRAW = (1 << 1),
SNODE_SHOW_GPENCIL = (1 << 2),
SNODE_USE_ALPHA = (1 << 3),
SNODE_SHOW_ALPHA = (1 << 4),
SNODE_SHOW_R = (1 << 7),
SNODE_SHOW_G = (1 << 8),
SNODE_SHOW_B = (1 << 9),
SNODE_AUTO_RENDER = (1 << 5),
SNODE_FLAG_UNUSED_6 = (1 << 6), /* cleared */
SNODE_FLAG_UNUSED_10 = (1 << 10), /* cleared */
SNODE_FLAG_UNUSED_11 = (1 << 11), /* cleared */
SNODE_PIN = (1 << 12),
/** automatically offset following nodes in a chain on insertion */
SNODE_SKIP_INSOFFSET = (1 << 13),
} eSpaceNode_Flag;
/* SpaceNode.texfrom */
typedef enum eSpaceNode_TexFrom {
/* SNODE_TEX_OBJECT = 0, */
SNODE_TEX_WORLD = 1,
SNODE_TEX_BRUSH = 2,
SNODE_TEX_LINESTYLE = 3,
} eSpaceNode_TexFrom;
/* SpaceNode.shaderfrom */
typedef enum eSpaceNode_ShaderFrom {
SNODE_SHADER_OBJECT = 0,
SNODE_SHADER_WORLD = 1,
SNODE_SHADER_LINESTYLE = 2,
} eSpaceNode_ShaderFrom;
/* SpaceNode.insert_ofs_dir */
enum {
SNODE_INSERTOFS_DIR_RIGHT = 0,
SNODE_INSERTOFS_DIR_LEFT = 1,
};
/** \} */
/* -------------------------------------------------------------------- */
/** \name Console
* \{ */
/* Console content */
typedef struct ConsoleLine {
struct ConsoleLine *next, *prev;
/* keep these 3 vars so as to share free, realloc funcs */
/** Allocated length. */
int len_alloc;
/** Real len - strlen(). */
int len;
char *line;
int cursor;
/** Only for use when in the 'scrollback' listbase. */
int type;
} ConsoleLine;
/* ConsoleLine.type */
typedef enum eConsoleLine_Type {
CONSOLE_LINE_OUTPUT = 0,
CONSOLE_LINE_INPUT = 1,
CONSOLE_LINE_INFO = 2, /* autocomp feedback */
CONSOLE_LINE_ERROR = 3,
} eConsoleLine_Type;
/* Console View */
typedef struct SpaceConsole {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
/* space vars */
int lheight;
char _pad[4];
/** ConsoleLine; output. */
ListBase scrollback;
/** ConsoleLine; command history, current edited line is the first. */
ListBase history;
char prompt[256];
/** Multiple consoles are possible, not just python. */
char language[32];
/** Selection offset in bytes. */
int sel_start;
int sel_end;
} SpaceConsole;
/** \} */
/* -------------------------------------------------------------------- */
/** \name User Preferences
* \{ */
typedef struct SpaceUserPref {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
char _pad1[7];
char filter_type;
/** Search term for filtering in the UI. */
char filter[64];
} SpaceUserPref;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Motion Tracking
* \{ */
/* Clip Editor */
typedef struct SpaceClip {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
char _pad1[4];
/** User defined offset, image is centered. */
float xof, yof;
/** User defined offset from locked position. */
float xlockof, ylockof;
/** User defined zoom level. */
float zoom;
/** User of clip. */
struct MovieClipUser user;
/** Clip data. */
struct MovieClip *clip;
/** Different scoped displayed in space panels. */
struct MovieClipScopes scopes;
/** Flags. */
int flag;
/** Editor mode (editing context being displayed). */
short mode;
/** Type of the clip editor view. */
short view;
/** Length of displaying path, in frames. */
int path_length;
/* current stabilization data */
/** Pre-composed stabilization data. */
float loc[2], scale, angle;
char _pad[4];
/**
* Current stabilization matrix and the same matrix in unified space,
* defined when drawing and used for mouse position calculation.
*/
float stabmat[4][4], unistabmat[4][4];
/* movie postprocessing */
int postproc_flag;
/* grease pencil */
short gpencil_src;
char _pad2[2];
/** Pivot point for transforms. */
int around;
char _pad4[4];
/** Mask editor 2d cursor. */
float cursor[2];
MaskSpaceInfo mask_info;
} SpaceClip;
/* SpaceClip.flag */
typedef enum eSpaceClip_Flag {
SC_SHOW_MARKER_PATTERN = (1 << 0),
SC_SHOW_MARKER_SEARCH = (1 << 1),
SC_LOCK_SELECTION = (1 << 2),
SC_SHOW_TINY_MARKER = (1 << 3),
SC_SHOW_TRACK_PATH = (1 << 4),
SC_SHOW_BUNDLES = (1 << 5),
SC_MUTE_FOOTAGE = (1 << 6),
SC_HIDE_DISABLED = (1 << 7),
SC_SHOW_NAMES = (1 << 8),
SC_SHOW_GRID = (1 << 9),
SC_SHOW_STABLE = (1 << 10),
SC_MANUAL_CALIBRATION = (1 << 11),
SC_SHOW_ANNOTATION = (1 << 12),
SC_SHOW_FILTERS = (1 << 13),
SC_SHOW_GRAPH_FRAMES = (1 << 14),
SC_SHOW_GRAPH_TRACKS_MOTION = (1 << 15),
/* SC_SHOW_PYRAMID_LEVELS = (1 << 16), */ /* UNUSED */
SC_LOCK_TIMECURSOR = (1 << 17),
SC_SHOW_SECONDS = (1 << 18),
SC_SHOW_GRAPH_SEL_ONLY = (1 << 19),
SC_SHOW_GRAPH_HIDDEN = (1 << 20),
SC_SHOW_GRAPH_TRACKS_ERROR = (1 << 21),
SC_SHOW_METADATA = (1 << 22),
} eSpaceClip_Flag;
/* SpaceClip.mode */
typedef enum eSpaceClip_Mode {
SC_MODE_TRACKING = 0,
/*SC_MODE_RECONSTRUCTION = 1,*/ /* DEPRECATED */
/*SC_MODE_DISTORTION = 2,*/ /* DEPRECATED */
SC_MODE_MASKEDIT = 3,
} eSpaceClip_Mode;
/* SpaceClip.view */
typedef enum eSpaceClip_View {
SC_VIEW_CLIP = 0,
SC_VIEW_GRAPH = 1,
SC_VIEW_DOPESHEET = 2,
} eSpaceClip_View;
/* SpaceClip.gpencil_src */
typedef enum eSpaceClip_GPencil_Source {
SC_GPENCIL_SRC_CLIP = 0,
SC_GPENCIL_SRC_TRACK = 1,
} eSpaceClip_GPencil_Source;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Top Bar
* \{ */
typedef struct SpaceTopBar {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
} SpaceTopBar;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Status Bar
* \{ */
typedef struct SpaceStatusBar {
SpaceLink *next, *prev;
/** Storage of regions for inactive spaces. */
ListBase regionbase;
char spacetype;
char link_flag;
char _pad0[6];
/* End 'SpaceLink' header. */
} SpaceStatusBar;
/** \} */
/* -------------------------------------------------------------------- */
/** \name Space Defines (eSpace_Type)
* \{ */
/* space types, moved from DNA_screen_types.h */
/* Do NOT change order, append on end. types are hardcoded needed */
typedef enum eSpace_Type {
SPACE_EMPTY = 0,
SPACE_VIEW3D = 1,
SPACE_GRAPH = 2,
SPACE_OUTLINER = 3,
SPACE_PROPERTIES = 4,
SPACE_FILE = 5,
SPACE_IMAGE = 6,
SPACE_INFO = 7,
SPACE_SEQ = 8,
SPACE_TEXT = 9,
#ifdef DNA_DEPRECATED_ALLOW
SPACE_IMASEL = 10, /* Deprecated */
SPACE_SOUND = 11, /* Deprecated */
#endif
SPACE_ACTION = 12,
SPACE_NLA = 13,
/* TODO: fully deprecate */
SPACE_SCRIPT = 14, /* Deprecated */
#ifdef DNA_DEPRECATED_ALLOW
SPACE_TIME = 15, /* Deprecated */
#endif
SPACE_NODE = 16,
#ifdef DNA_DEPRECATED_ALLOW
SPACE_LOGIC = 17, /* Deprecated */
#endif
SPACE_CONSOLE = 18,
SPACE_USERPREF = 19,
SPACE_CLIP = 20,
SPACE_TOPBAR = 21,
SPACE_STATUSBAR = 22,
#define SPACE_TYPE_LAST SPACE_STATUSBAR
} eSpace_Type;
/* use for function args */
#define SPACE_TYPE_ANY -1
#define IMG_SIZE_FALLBACK 256
/** \} */
#ifdef __cplusplus
}
#endif
|