2.5
[blender.git] / source / blender / makesdna / DNA_ID.h
1 /**
2  * blenlib/DNA_ID.h (mar-2001 nzc)
3  *
4  * ID and Library types, which are fundamental for sdna,
5  *
6  * $Id$
7  *
8  * ***** BEGIN GPL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  *
24  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
25  * All rights reserved.
26  *
27  * The Original Code is: all of this file.
28  *
29  * Contributor(s): none yet.
30  *
31  * ***** END GPL LICENSE BLOCK *****
32  */
33 #ifndef DNA_ID_H
34 #define DNA_ID_H
35
36 #include "DNA_listBase.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct Library;
43 struct FileData;
44 struct ID;
45
46 typedef struct IDPropertyData {
47         void *pointer;
48         ListBase group;
49         int val, val2; /*note, we actually fit a double into these two ints*/
50 } IDPropertyData;
51
52 typedef struct IDProperty {
53         struct IDProperty *next, *prev;
54         char type, subtype;
55         short flag;
56         char name[32];
57         int saved; /*saved is used to indicate if this struct has been saved yet.
58                                 seemed like a good idea as a pad var was needed anyway :)*/
59         IDPropertyData data;    /* note, alignment for 64 bits */
60         int len; /* array length, also (this is important!) string length + 1.
61                     the idea is to be able to reuse array realloc functions on strings.*/
62         /*totallen is total length of allocated array/string, including a buffer.
63           Note that the buffering is mild; the code comes from python's list implementation.*/
64         int totallen; /*strings and arrays are both buffered, though the buffer isn't
65                         saved.*/
66 } IDProperty;
67
68 #define MAX_IDPROP_NAME 32
69 #define DEFAULT_ALLOC_FOR_NULL_STRINGS  64
70
71 /*->type*/
72 #define IDP_STRING              0
73 #define IDP_INT                 1
74 #define IDP_FLOAT               2
75 #define IDP_ARRAY               5
76 #define IDP_GROUP               6
77 /* the ID link property type hasn't been implemented yet, this will require
78    some cleanup of blenkernel, most likely.*/
79 #define IDP_ID                  7
80 #define IDP_DOUBLE              8
81 #define IDP_NUMTYPES    9
82
83 /* add any future new id property types here.*/
84
85 /* watch it: Sequence has identical beginning. */
86 /**
87  * ID is the first thing included in all serializable types. It
88  * provides a common handle to place all data in double-linked lists.
89  * */
90
91 #define MAX_ID_NAME     24
92
93 /* There's a nasty circular dependency here.... void* to the rescue! I
94  * really wonder why this is needed. */
95 typedef struct ID {
96         void *next, *prev;
97         struct ID *newid;
98         struct Library *lib;
99         char name[24];
100         short us;
101         /**
102          * LIB_... flags report on status of the datablock this ID belongs
103          * to.
104          */
105         short flag;
106         int icon_id;
107         IDProperty *properties;
108 } ID;
109
110 /**
111  * For each library file used, a Library struct is added to Main
112  * WARNING: readfile.c, expand_doit() reads this struct without DNA check!
113  */
114 typedef struct Library {
115         ID id;
116         ID *idblock;
117         struct FileData *filedata;
118         char name[240];                 /* reveiled in the UI, can store relative path */
119         char filename[240];             /* expanded name, not relative, used while reading */
120         int tot, pad;                   /* tot, idblock and filedata are only fo read and write */
121         struct Library *parent; /* for outliner, showing dependency */
122 } Library;
123
124 #define PREVIEW_MIPMAPS 2
125 #define PREVIEW_MIPMAP_ZERO 0
126 #define PREVIEW_MIPMAP_LARGE 1
127
128 typedef struct PreviewImage {
129         unsigned int w[2];
130         unsigned int h[2];      
131         short changed[2];
132         short pad0, pad1;
133         unsigned int * rect[2];
134 } PreviewImage;
135
136 /**
137  * Defines for working with IDs.
138  *
139  * The tags represent types! This is a dirty way of enabling RTTI. The
140  * sig_byte end endian defines aren't really used much.
141  *
142  **/
143
144 #if defined(__sgi) || defined(__sparc) || defined(__sparc__) || defined (__PPC__) || defined (__ppc__)  || defined (__hppa__) || defined (__BIG_ENDIAN__)
145 /* big endian */
146 #define MAKE_ID2(c, d)          ( (c)<<8 | (d) )
147 #define MOST_SIG_BYTE                           0
148 #define BBIG_ENDIAN
149 #else
150 /* little endian  */
151 #define MAKE_ID2(c, d)          ( (d)<<8 | (c) )
152 #define MOST_SIG_BYTE                           1
153 #define BLITTLE_ENDIAN
154 #endif
155
156 /* ID from database */
157 #define ID_SCE          MAKE_ID2('S', 'C')
158 #define ID_LI           MAKE_ID2('L', 'I')
159 #define ID_OB           MAKE_ID2('O', 'B')
160 #define ID_ME           MAKE_ID2('M', 'E')
161 #define ID_CU           MAKE_ID2('C', 'U')
162 #define ID_MB           MAKE_ID2('M', 'B')
163 #define ID_MA           MAKE_ID2('M', 'A')
164 #define ID_TE           MAKE_ID2('T', 'E')
165 #define ID_IM           MAKE_ID2('I', 'M')
166 #define ID_IK           MAKE_ID2('I', 'K')
167 #define ID_WV           MAKE_ID2('W', 'V')
168 #define ID_LT           MAKE_ID2('L', 'T')
169 #define ID_SE           MAKE_ID2('S', 'E')
170 #define ID_LF           MAKE_ID2('L', 'F')
171 #define ID_LA           MAKE_ID2('L', 'A')
172 #define ID_CA           MAKE_ID2('C', 'A')
173 #define ID_IP           MAKE_ID2('I', 'P')
174 #define ID_KE           MAKE_ID2('K', 'E')
175 #define ID_WO           MAKE_ID2('W', 'O')
176 #define ID_SCR          MAKE_ID2('S', 'R')
177 #define ID_SCRN         MAKE_ID2('S', 'N')
178 #define ID_VF           MAKE_ID2('V', 'F')
179 #define ID_TXT          MAKE_ID2('T', 'X')
180 #define ID_SO           MAKE_ID2('S', 'O')
181 #define ID_GR           MAKE_ID2('G', 'R')
182 #define ID_ID           MAKE_ID2('I', 'D')
183 #define ID_AR           MAKE_ID2('A', 'R')
184 #define ID_AC           MAKE_ID2('A', 'C')
185 #define ID_SCRIPT       MAKE_ID2('P', 'Y')
186 #define ID_NT           MAKE_ID2('N', 'T')
187 #define ID_BR           MAKE_ID2('B', 'R')
188 #define ID_PA           MAKE_ID2('P', 'A')
189 #define ID_WM           MAKE_ID2('W', 'M')
190
191         /* NOTE! Fake IDs, needed for g.sipo->blocktype or outliner */
192 #define ID_SEQ          MAKE_ID2('S', 'Q')
193                         /* constraint */
194 #define ID_CO           MAKE_ID2('C', 'O')
195                         /* pose (action channel, used to be ID_AC in code, so we keep code for backwards compat) */
196 #define ID_PO           MAKE_ID2('A', 'C')
197                         /* used in outliner... */
198 #define ID_NLA          MAKE_ID2('N', 'L')
199                         /* fluidsim Ipo */
200 #define ID_FLUIDSIM     MAKE_ID2('F', 'S')
201
202
203 /*#ifdef WITH_VERSE*/
204 #define ID_VS           MAKE_ID2('V', 'S')      /* fake id for VerseSession, needed for outliner */
205 #define ID_VN           MAKE_ID2('V', 'N')      /* fake id for VerseNode, needed for outliner */
206 #define ID_MS           MAKE_ID2('M', 'S')  /* fake id for VerseServer root entry, needed for outliner */
207 #define ID_SS           MAKE_ID2('S', 'S')  /* fake id for VerseServer entry, needed for ountliner */
208 /*#endif*/
209
210
211 /* id->flag: set frist 8 bits always at zero while reading */
212 #define LIB_LOCAL               0
213 #define LIB_EXTERN              1
214 #define LIB_INDIRECT    2
215 #define LIB_TEST                8
216 #define LIB_TESTEXT             9
217 #define LIB_TESTIND             10
218 #define LIB_READ                16
219 #define LIB_NEEDLINK    32
220
221 #define LIB_NEW                 256
222 #define LIB_FAKEUSER    512
223 /* free test flag */
224 #define LIB_DOIT                1024
225 /*  */
226 #define LIB_APPEND_TAG  2048 
227
228 #ifdef __cplusplus
229 }
230 #endif
231
232 #endif
233