Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/defs/class_id.h @ 6818

Last change on this file since 6818 was 6818, checked in by bensch, 19 years ago

trunk: classID-cleanup

File size: 12.9 KB
Line 
1/*
2   orxonox - the future of 3D-vertical-scrollers
3
4   Copyright (C) 2004 orx
5
6   This program is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 2, or (at your option)
9   any later version.
10
11### File Specific:
12   main-programmer: Benjamin Grauer
13   co-programmer: Patrick Boenzli
14
15   2005-06-10: (bensch) added new sturcture to support multiple inheritance
16*/
17
18/*!
19 * @file class_id.h
20 * @brief contains a list of orxonox ClassID's (identities to register classes and their SuperClasses)
21 *
22 *  this File is used to identify an Object with its Class and also with its sub/super-classes.
23 *  this is also used by the ObjectManager/Factory to identify and load important classes
24 *
25 *  !! important !!
26 *  When adding a new CLASS be sure about the following:
27 *    1. if it is a (SUB)SUPERCLASS make sure there is still space left (if not think of a new approach)
28 *    2. check if the Number you add is not refered twice, and that with (SUB)SUPERCLASSES there are no intersections
29 *    3. be sure to add you stuff in the right section, and don't interest yourself for the order of things. :)
30 */
31
32#ifndef _CLASS_ID_H
33#define _CLASS_ID_H
34
35//! list of all classes to be loadable in via the ObjectManager
36/**
37 *
38 * -------------------------------------------------------------------------------------------
39 * Consider the Identifiers 0xABCDEFGH
40 * The first two: A and B are superclass Identifiers !! THEY ARE ALREADY FULL !!
41 *
42 * The second three are for sub-superclass-groups inheritance:
43 *  C: a Group identifier: can be anything from 1,2,3,4,5,6,7,8,9,a,b,c,d,e,f,g,h
44 *  D,E: Member within the Group, to specify further deriavtions within the Group.
45 *       These may be anything from 1,2,4,8 (at D and E)
46 *  !! consider, that you __may not__ have a derivated class from group a and group b.
47 *
48 * The last three entries F,G,H are for any leaf classes in existence.
49 * they are ordered in the following way:
50 *  F: LEAF-GroupSpecifier
51 *  G,H: UNIQUE NUMBER eithin F-Group.
52 *
53 * You only have to extend the Class with your ClassID-tag.
54 * If something goes Wrong, you get an Assertion-Warning in BaseObject.
55 * !! Abstrace/Non-total-leaf classes do not have a LEAF-part.
56 * -------------------------------------------------------------------------------------------
57 *
58 * COUNT:
59 * -> # max SuperClass-count        = 7 (not intersecting)
60 *    # max SubSuperClass-count     = 15*7 = 105 (the 7 classes will be able to get derived from each other, but not over the SubSuperClass.)
61 *    # max lowerClasses-count      = 3^16 = enough (they are Leaves, and may NOT be derived by any other class.)
62 */
63typedef enum ClassID
64{
65  // the Nothing CLASS (NULL)
66  CL_NULL                       =    0x00000000,
67
68  /// SUPER-classes
69  CL_MASK_SUPER_CLASS           =    0xff000000,
70  CL_BASE_OBJECT                =    0x00000000,
71
72  CL_PARENT_NODE                =    0x01000000,
73
74  CL_STORY_ENTITY               =    0x02000000,
75
76  CL_PHYSICS_INTERFACE          =    0x04000000,
77
78  CL_EVENT_LISTENER             =    0x08000000,
79
80  CL_ELEMENT_2D                 =    0x10000000,
81
82  CL_SYNCHRONIZEABLE            =    0x20000000,
83
84  CL_WORLD_ENTITY               =    0x40000000,
85
86  CL_GRAPHICS_EFFECT            =    0x80000000,
87
88
89  /// subsuper-classes
90  // subsuper-classes derivations taken : 1, 2, 5, a, b, c.   << THIS IS A LIST OF ALL THE DCL_MASK_SUBSUPERCLASS_ID's taken
91  CL_MASK_SUBSUPER_CLASS        =    0x00fff000,
92  CL_MASK_SUBSUPER_CLASS_IDA    =    0x00f00000,
93  CL_MASK_SUBSUPER_CLASS_IDB    =    0x000ff000,
94
95  // lowest level classes
96  // These are also referenced to as Leaf-classes
97  CL_MASK_LOWLEVEL_CLASS        =    0x00000fff,
98
99
100  /// SINGLETON classes (range from 0x00000f00 to 0x00000fff)
101  CL_MASK_SINGLETON             =    0x00000f00,
102  CL_ORXONOX                    =    0x00000f01,
103  CL_NULL_PARENT                =    0x00000f02,
104  CL_PILOT_PARENT               =    0x00000f03,
105  CL_OBJECT_MANAGER             =    0x00000f04,
106  CL_RESOURCE_MANAGER           =    0x00000f05,
107  CL_GARBAGE_COLLECTOR          =    0x00000f06,
108  CL_GAME_LOADER                =    0x00000f07,
109  CL_GRAPHICS_ENGINE            =    0x00000f08,
110  CL_TEXT_ENGINE                =    0x00000f09,
111  CL_LIGHT_MANAGER              =    0x00000f0a,
112  CL_EVENT_HANDLER              =    0x00000f0b,
113  CL_PHYSICS_ENGINE             =    0x00000f0c,
114  CL_CD_ENGINE                  =    0x00000f0d,
115  CL_PARTICLE_ENGINE            =    0x00000f0e,
116  CL_SOUND_ENGINE               =    0x00000f0f,
117  CL_ANIMATION_PLAYER           =    0x00000f10,
118  CL_TRACK_MANAGER              =    0x00000f11,
119  CL_TRACK_NODE                 =    0x00000f12,
120  CL_STATE                      =    0x00000f13,
121  CL_FRAMEWORK                  =    0x00000f14,
122  CL_RENDER_2D                  =    0x00000f21,
123  CL_NULL_ELEMENT_2D            =    0x00000f22,
124  CL_SHELL_BUFFER               =    0x00000f32,
125  CL_GLGUI_HANDLER              =    0x00000f40,
126  CL_GLGUI_MAIN_WIDGET          =    0x00000f41,
127  CL_NETWORK_MANAGER            =    0x00000f50,
128  CL_SHARED_NETWORK_DATA        =    0x00000f51,
129
130
131
132  /// SUPER-Modeling
133  CL_TEXTURE                    =    0x00c01000,
134  CL_TEXTURE_SEQUENCE           =    0x00c04000,
135  CL_TEXT                       =    0x00c02000,
136
137  CL_MODEL                      =    0x00d01000,
138  CL_STATIC_MODEL               =    0x00d02000,
139  CL_VERTEX_ARRAY_MODEL         =    0x00d04000,
140
141  /// StoryEntities (range from 0x00000100 to 0x000001ff)
142  CL_GAME_WORLD                 =    0x00101000,
143  CL_GAME_WORLD_DATA            =    0x00102000,
144
145  CL_CAMPAIGN                   =    0x00000101,
146  CL_CAMPAIGN_DATA              =    0x00000102,
147  CL_SIMPLE_GAME_MENU           =    0x00000103,
148  CL_SIMPLE_GAME_MENU_DATA      =    0x00000104,
149  CL_SINGLE_PLAYER_WORLD        =    0x00000105,
150  CL_SINGLE_PLAYER_WORLD_DATA   =    0x00000106,
151  CL_MULTI_PLAYER_WORLD         =    0x00000107,
152  CL_MULTI_PLAYER_WORLD_DATA    =    0x00000108,
153  CL_MOVIE_LOADER               =    0x00000109,
154
155  /// SUPER-PNodes
156  CL_FIELD                      =    0x00101000,
157
158  /// PNodes
159  CL_CAMERA                     =    0x00000101,
160  CL_CAMERA_TARGET              =    0x00000102,
161
162
163  /// SUPER-WorldEntities
164  CL_PLAYER                     =    0x00202000,
165
166  CL_PLAYABLE                   =    0x00201000,
167  CL_NPC                        =    0x00204000,
168  CL_PROJECTILE                 =    0x00208000,
169  CL_WEAPON                     =    0x00210000,
170  CL_POWER_UP                   =    0x00220000,
171  CL_EXTENDABLE                 =    0x00240000,
172
173  /// WorldEntities (range from 0x00000200 to 0x000004ff)
174  // Environments
175  CL_ENVIRONEMENT               =    0x00000203,
176  CL_SATELLITE                  =    0x00000204,
177  CL_SKYBOX                     =    0x00000205,
178  CL_SKYSPHERE                  =    0x00000206,
179  CL_TERRAIN                    =    0x00000207,
180  CL_WATER                      =    0x00000208,
181  CL_PLANET                     =    0x00000209,
182
183  // Playables
184  CL_SPACE_SHIP                 =    0x0000020a,
185  CL_HELICOPTER                 =    0x0000020b,
186  CL_SPAWNING_POINT             =    0x0000020c,
187  CL_MD2_CREATURE               =    0x0000020d,
188  CL_HOVER                      =    0x0000020e,
189
190  // Powerups
191  CL_TURRET_POWER_UP            =    0x00000211,
192  CL_LASER_POWER_UP             =    0x00000212,
193  CL_WEAPON_POWER_UP            =    0x00000213,
194  CL_PARAM_POWER_UP             =    0x00000214,
195
196  // Weapons
197  CL_TEST_GUN                   =    0x00000230,
198  CL_TURRET                     =    0x00000231,
199  CL_AIMING_TURRET              =    0x00000232,
200  CL_CANNON                     =    0x00000233,
201  CL_TARGETING_TURRET           =    0x00000234,
202  CL_HYPERBLASTER               =    0x00000235,
203
204  // Projectiles
205  CL_TEST_BULLET                =    0x00000240,
206  CL_ROCKET                     =    0x00000241,
207  CL_LASER                      =    0x00000242,
208  CL_BOMB                       =    0x00000243,
209  CL_GROUND_TURRET              =    0x00000244,
210  CL_GUIDED_MISSILE             =    0x00000245,
211  CL_HYPERBLAST                 =    0x00000246,
212
213  // NPC's
214  CL_NPC_TEST1                  =    0x00000301,
215  CL_NPC_TEST2                  =    0x00000302,
216
217  // Testing Entities
218  CL_TEST_ENTITY                =    0x00000209,
219
220  // misc
221  CL_MOVIE_ENTITY               =    0x00000310,
222  CL_RECORDER                   =    0x00000311,
223
224  CL_IMAGE_ENTITY               =    0x00000312,
225  CL_BILLBOARD                  =    0x00000313,
226
227
228  // GamePlay (range from 0x00000500 0x000005ff)
229  CL_EVENT                      =    0x00000501,
230  CL_KEY_MAPPER                 =    0x00000502,
231  CL_CROSSHAIR                  =    0x00000512,
232
233  CL_WEAPON_MANAGER             =    0x00000503,
234  CL_AMMO_CONTAINER             =    0x00000504,
235  CL_HUD                        =    0x00000520,
236
237
238  /// Physics stuff (range from 0x00000600 to 0x000007ff)
239  CL_PHYSICS_CONNECTION         =    0x00000601,
240  CL_FIELD_GRAVITY              =    0x00000610,
241  CL_FIELD_POINT_GRAVITY        =    0x00000611,
242  CL_FIELD_TWIRL                =    0x00000612,
243
244
245  /// Collision
246  CL_COLLISION                  =    0x00000611,
247  CL_BV_TREE                    =    0x00a01000,
248  CL_BV_TREE_NODE               =    0x00002000,
249  CL_OBB_TREE                   =    0x00000614,
250  CL_OBB_TREE_NODE              =    0x00000615,
251  CL_BOUNDING_VOLUME            =    0x00a10000,
252  CL_OBB                        =    0x00020617,
253  CL_BOUNDING_SPHERE            =    0x00040618,
254
255  /// Graphical stuff (range from 0x00000800 to 0x000009ff)
256  CL_FONT                       =    0x00000802,
257
258  CL_PARTICLE_EMITTER           =    0x00201852,
259  CL_PARTICLE_SYSTEM            =    0x00202000,
260  CL_SPRITE_PARTICLES           =    0x00000853,
261  CL_SPARK_PARTICLES            =    0x00000854,
262  CL_PNODE_PARTICLES            =    0x00000855,
263  CL_DOT_PARTICLES              =    0x00000856,
264  CL_MODEL_PARTICLES            =    0x00000857,
265//  CL_TEMPLATE_PARTICLES         =    0x00000857,
266
267  CL_MATERIAL                   =    0x00000804,
268  CL_OBJ_MODEL                  =    0x00000807,
269
270  CL_MOVIE_PLAYER               =    0x00000805,
271  CL_MEDIA_CONTAINER            =    0x00000806,
272  CL_PROMITIVE_MODEL            =    0x00000808,
273  CL_MD2Model                   =    0x00000809,
274  CL_HEIGHT_MAP                 =    0x0000080a,
275  CL_GRID                       =    0x0000080b,
276
277  CL_LIGHT                      =    0x00000811,
278  CL_ENVIRONMENT                =    0x00000821,
279  CL_SHADER                     =    0x00000822,
280  CL_FOG_EFFECT                 =    0x70000001,
281  CL_LENSE_FLARE                =    0x70000002,
282
283  /// GL-GUI
284  CL_GLGUI_WIDGET               =    0x00500000,
285  CL_GLGUI_BUTTON               =    0x00501000,
286  CL_GLGUI_PUSHBUTTON           =    0x00000903,
287  CL_GLGUI_CHECKBUTTON          =    0x00000904,
288  CL_GLGUI_RADIOBUTTON          =    0x00000905,
289  CL_GLGUI_CONTAINER            =    0x00002906,
290  CL_GLGUI_BOX                  =    0x00000907,
291  CL_GLGUI_FRAME                =    0x00000908,
292  CL_GLGUI_WINDOW               =    0x00000909,
293  CL_GLMENU_IMAGE_SCREEN        =    0x00000920,
294  CL_GLGUI_BAR                  =    0x00000930,
295
296  /// AUDIO stuff (range from 0x00000a00 to 0x00000aff)
297  CL_SOUND_BUFFER               =    0x00000a01,
298  CL_SOUND_SOURCE               =    0x00000a02,
299  CL_SOUND_OGG_PLAYER           =    0x00000a11,
300
301
302  /// NETWORK stuff (range from 0x00000b00 to 0x00000bff)
303  CL_DATA_STREAM                =    0x00b01b00,
304  CL_NETWORK_STREAM             =    0x00000b01,
305  CL_NETWORK_PROTOCOL           =    0x00000b02,
306  CL_NETWORK_SOCKET             =    0x00000b03,
307  CL_SERVER_SOCKET              =    0X00000b04,
308  CL_CONNECTION_MONITOR         =    0x00000b05,
309  CL_HANDSHAKE                  =    0x00000b06,
310  CL_NETWORK_GAME_MANAGER       =    0x00000b07,
311
312
313
314  /// MISCELANEOUS: (range from 0x00000d00 to 0x00000eff)
315  CL_ANIMATION                  =    0x00000d01,
316  //  CL_ANIMATION3D                =    0x00000b02,
317  CL_QUICK_ANIMATION            =    0x00000d02,
318  CL_FACTORY                    =    0x00000d03,
319  CL_INI_PARSER                 =    0x00000d04,
320  CL_LIST                       =    0x00000d05,
321  CL_SUBSTRING                  =    0x00000d06,
322  CL_LOAD_PARAM                 =    0x00000d07,
323  CL_CURVE                      =    0x00000d08,
324  CL_CHARACTER_ATTRIBUTES       =    0x00000d0a,
325  CL_TRACK_ELEMENT              =    0x00000d0b,
326  CL_NUMBER                     =    0x00000d0c,
327  CL_EXECUTOR                   =    0x00000d0d,
328  CL_FAST_FACTORY               =    0x00000d01,
329  CL_SHELL                      =    0x00000d10,
330  CL_SHELL_COMMAND              =    0x00000d11,
331  CL_SHELL_COMMAND_CLASS        =    0x00000d12,
332  CL_SHELL_INPUT                =    0x00000d13,
333  CL_SHELL_COMPLETION           =    0x00000d14,
334  CL_SHELL_COMMAND_ALIAS        =    0x00000d15,
335
336  // Spatial Data Separation
337  CL_SPATIAL_SEPARATION         =    0x00000d0d,
338  CL_QUADTREE                   =    0x00000d0e,
339  CL_QUADTREE_NODE              =    0x00000d0f,
340};
341
342
343#endif /* _CLASS_ID_H */
Note: See TracBrowser for help on using the repository browser.