Merge with trunk/2.5 at r25563
[blender-staging.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_IDPARRAY    9
82 #define IDP_NUMTYPES    10
83
84 /* add any future new id property types here.*/
85
86 /* watch it: Sequence has identical beginning. */
87 /**
88  * ID is the first thing included in all serializable types. It
89  * provides a common handle to place all data in double-linked lists.
90  * */
91
92 #define MAX_ID_NAME     24
93
94 /* There's a nasty circular dependency here.... void* to the rescue! I
95  * really wonder why this is needed. */
96 typedef struct ID {
97         void *next, *prev;
98         struct ID *newid;
99         struct Library *lib;
100         char name[24];
101         short us;
102         /**
103          * LIB_... flags report on status of the datablock this ID belongs
104          * to.
105          */
106         short flag;
107         int icon_id;
108         IDProperty *properties;
109 } ID;
110
111 /**
112  * For each library file used, a Library struct is added to Main
113  * WARNING: readfile.c, expand_doit() reads this struct without DNA check!
114  */
115 typedef struct Library {
116         ID id;
117         ID *idblock;
118         struct FileData *filedata;
119         char name[240];                 /* revealed in the UI, can store relative path */
120         char filename[240];             /* expanded name, not relative, used while reading */
121         int tot, pad;                   /* tot, idblock and filedata are only fo read and write */
122         struct Library *parent; /* for outliner, showing dependency */
123 } Library;
124
125 #define PREVIEW_MIPMAPS 2
126 #define PREVIEW_MIPMAP_ZERO 0
127 #define PREVIEW_MIPMAP_LARGE 1
128
129 typedef struct PreviewImage {
130         unsigned int w[2];
131         unsigned int h[2];      
132         short changed[2];
133         short pad0, pad1;
134         unsigned int * rect[2];
135 } PreviewImage;
136
137 /**
138  * Defines for working with IDs.
139  *
140  * The tags represent types! This is a dirty way of enabling RTTI. The
141  * sig_byte end endian defines aren't really used much.
142  *
143  **/
144
145 #if defined(__sgi) || defined(__sparc) || defined(__sparc__) || defined (__PPC__) || defined (__ppc__)  || defined (__hppa__) || defined (__BIG_ENDIAN__)
146 /* big endian */
147 #define MAKE_ID2(c, d)          ( (c)<<8 | (d) )
148 #define MOST_SIG_BYTE                           0
149 #define BBIG_ENDIAN
150 #else
151 /* little endian  */
152 #define MAKE_ID2(c, d)          ( (d)<<8 | (c) )
153 #define MOST_SIG_BYTE                           1
154 #define BLITTLE_ENDIAN
155 #endif
156
157 /* ID from database */
158 #define ID_SCE          MAKE_ID2('S', 'C') /* Scene */
159 #define ID_LI           MAKE_ID2('L', 'I') /* Library */
160 #define ID_OB           MAKE_ID2('O', 'B') /* Object */
161 #define ID_ME           MAKE_ID2('M', 'E') /* Mesh */
162 #define ID_CU           MAKE_ID2('C', 'U') /* Curve */
163 #define ID_MB           MAKE_ID2('M', 'B') /* MetaBall */
164 #define ID_MA           MAKE_ID2('M', 'A') /* Material */
165 #define ID_TE           MAKE_ID2('T', 'E') /* Texture */
166 #define ID_IM           MAKE_ID2('I', 'M') /* Image */
167 #define ID_WV           MAKE_ID2('W', 'V') /* Wave (unused) */
168 #define ID_LT           MAKE_ID2('L', 'T') /* Lattice */
169 #define ID_LA           MAKE_ID2('L', 'A') /* Lamp */
170 #define ID_CA           MAKE_ID2('C', 'A') /* Camera */
171 #define ID_IP           MAKE_ID2('I', 'P') /* Ipo (depreciated, replaced by FCurves) */
172 #define ID_KE           MAKE_ID2('K', 'E') /* Key (shape key) */
173 #define ID_WO           MAKE_ID2('W', 'O') /* World */
174 #define ID_SCR          MAKE_ID2('S', 'R') /* Screen */
175 #define ID_SCRN         MAKE_ID2('S', 'N') /* (depreciated?) */
176 #define ID_VF           MAKE_ID2('V', 'F') /* VectorFont */
177 #define ID_TXT          MAKE_ID2('T', 'X') /* Text */
178 #define ID_SO           MAKE_ID2('S', 'O') /* Sound */
179 #define ID_GR           MAKE_ID2('G', 'R') /* Group */
180 #define ID_ID           MAKE_ID2('I', 'D') /* (internal use only) */
181 #define ID_AR           MAKE_ID2('A', 'R') /* Armature */
182 #define ID_AC           MAKE_ID2('A', 'C') /* Action */
183 #define ID_SCRIPT       MAKE_ID2('P', 'Y') /* Script (depreciated) */
184 #define ID_NT           MAKE_ID2('N', 'T') /* NodeTree */
185 #define ID_BR           MAKE_ID2('B', 'R') /* Brush */
186 #define ID_PA           MAKE_ID2('P', 'A') /* ParticleSettings */
187 #define ID_GD           MAKE_ID2('G', 'D') /* GreasePencil */
188 #define ID_WM           MAKE_ID2('W', 'M') /* WindowManager */
189
190         /* NOTE! Fake IDs, needed for g.sipo->blocktype or outliner */
191 #define ID_SEQ          MAKE_ID2('S', 'Q')
192                         /* constraint */
193 #define ID_CO           MAKE_ID2('C', 'O')
194                         /* pose (action channel, used to be ID_AC in code, so we keep code for backwards compat) */
195 #define ID_PO           MAKE_ID2('A', 'C')
196                         /* used in outliner... */
197 #define ID_NLA          MAKE_ID2('N', 'L')
198                         /* fluidsim Ipo */
199 #define ID_FLUIDSIM     MAKE_ID2('F', 'S')
200
201 /* id->flag: set frist 8 bits always at zero while reading */
202 #define LIB_LOCAL               0
203 #define LIB_EXTERN              1
204 #define LIB_INDIRECT    2
205 #define LIB_TEST                8
206 #define LIB_TESTEXT             9
207 #define LIB_TESTIND             10
208 #define LIB_READ                16
209 #define LIB_NEEDLINK    32
210
211 #define LIB_NEW                 256
212 #define LIB_FAKEUSER    512
213 /* free test flag */
214 #define LIB_DOIT                1024
215 /*  */
216 #define LIB_APPEND_TAG  2048 
217
218 #ifdef __cplusplus
219 }
220 #endif
221
222 #endif
223