Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 8194 was 8190, checked in by patrick, 19 years ago

trunk: merged the cr branche to trunk

File size: 16.1 KB
Line 
1
2/*
3   orxonox - the future of 3D-vertical-scrollers
4
5   Copyright (C) 2004 orx
6
7   This program is free software; you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation; either version 2, or (at your option)
10   any later version.
11
12### File Specific:
13   main-programmer: Benjamin Grauer
14   co-programmer: Patrick Boenzli
15
16   2005-06-10: (bensch) added new sturcture to support multiple inheritance
17*/
18
19/*!
20 * @file class_id.h
21 * @brief contains a list of orxonox ClassID's (identities to register classes and their SuperClasses)
22 *
23 *  this File is used to identify an Object with its Class and also with its sub/super-classes.
24 *  this is also used by the ObjectManager/Factory to identify and load important classes
25 *
26 *  !! important !!
27 *  When adding a new CLASS be sure about the following:
28 *    1. if it is a (SUB)SUPERCLASS make sure there is still space left (if not think of a new approach)
29 *    2. check if the Number you add is not refered twice, and that with (SUB)SUPERCLASSES there are no intersections
30 *    3. be sure to add you stuff in the right section, and don't interest yourself for the order of things. :)
31 */
32
33#ifndef _CLASS_ID_H
34#define _CLASS_ID_H
35
36//! list of all classes to be loadable in via the ObjectManager
37/**
38 *
39 * -------------------------------------------------------------------------------------------
40 * Consider the Identifiers 0xABCDEFGH
41 * The first two: A and B are superclass Identifiers !! THEY ARE ALREADY FULL !!
42 *
43 * The second three are for sub-superclass-groups inheritance:
44 *  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
45 *  D,E: Member within the Group, to specify further deriavtions within the Group.
46 *       These may be anything from 1,2,4,8 (at D and E)
47 *  !! consider, that you __may not__ have a derivated class from group a and group b.
48 *
49 * The last three entries F,G,H are for any leaf classes in existence.
50 * they are ordered in the following way:
51 *  F: LEAF-GroupSpecifier
52 *  G,H: UNIQUE NUMBER eithin F-Group.
53 *
54 * You only have to extend the Class with your ClassID-tag.
55 * If something goes Wrong, you get an Assertion-Warning in BaseObject.
56 * !! Abstrace/Non-total-leaf classes do not have a LEAF-part.
57 * -------------------------------------------------------------------------------------------
58 *
59 * COUNT:
60 * -> # max SuperClass-count        = 7 (not intersecting)
61 *    # max SubSuperClass-count     = 15*7 = 105 (the 7 classes will be able to get derived from each other, but not over the SubSuperClass.)
62 *    # max lowerClasses-count      = 3^16 = enough (they are Leaves, and may NOT be derived by any other class.)
63 */
64typedef enum ClassID
65{
66  // the Nothing CLASS (NULL)
67  CL_NULL                       =    0x00000000,
68
69  /// SUPER-classes
70  CL_MASK_SUPER_CLASS           =    0xff000000,
71  CL_BASE_OBJECT                =    0x00000000,
72
73  CL_PARENT_NODE                =    0x01000000,
74
75  CL_STORY_ENTITY               =    0x02000000,
76
77  CL_PHYSICS_INTERFACE          =    0x04000000,
78
79  CL_EVENT_LISTENER             =    0x08000000,
80
81  CL_ELEMENT_2D                 =    0x10000000,
82
83  CL_SYNCHRONIZEABLE            =    0x20000000,
84
85  CL_WORLD_ENTITY               =    0x40000000,
86
87  CL_RESOURCE                   =    0x80000000,
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  CL_PREFERENCES                =    0X00000f51,
100
101  /// SINGLETON classes (range from 0x00000000 to 0x000000ff)
102  CL_MASK_SINGLETON             =    0x00000000,
103  CL_ORXONOX                    =    0x00000001,
104  CL_NULL_PARENT                =    0x00000002,
105  CL_PILOT_PARENT               =    0x00000003,
106  CL_OBJECT_MANAGER             =    0x00000004,
107  CL_RESOURCE_MANAGER           =    0x00000005,
108  CL_GARBAGE_COLLECTOR          =    0x00000006,
109  CL_GAME_LOADER                =    0x00000007,
110  CL_GRAPHICS_ENGINE            =    0x00000008,
111  CL_TEXT_ENGINE                =    0x00000009,
112  CL_LIGHT_MANAGER              =    0x0000000a,
113  CL_EVENT_HANDLER              =    0x0000000b,
114  CL_PHYSICS_ENGINE             =    0x0000000c,
115  CL_CD_ENGINE                  =    0x0000000d,
116  CL_PARTICLE_ENGINE            =    0x0000000e,
117  CL_SOUND_ENGINE               =    0x0000000f,
118  CL_ANIMATION_PLAYER           =    0x00000010,
119  CL_TRACK_MANAGER              =    0x00000011,
120  CL_TRACK_NODE                 =    0x00000012,
121  CL_STATE                      =    0x00000013,
122  CL_FRAMEWORK                  =    0x00000014,
123  CL_CR_ENGINE                  =    0x00000015,                ///FIXME bensch i just added this id, verify if this is ok :D
124  CL_RENDER_2D                  =    0x00000021,
125  CL_NULL_ELEMENT_2D            =    0x00000022,
126  CL_SHELL_BUFFER               =    0x00000032,
127  CL_GLGUI_HANDLER              =    0x00000040,
128  CL_GLGUI_MAIN_WIDGET          =    0x00000041,
129  CL_NETWORK_MANAGER            =    0x00000050,
130  CL_SHARED_NETWORK_DATA        =    0x00000051,
131  CL_ATMOSPHERIC_ENGINE         =    0x00000061,
132
133  /// StoryEntities (range from 0x00000100 to 0x000001ff)
134  CL_GAME_WORLD                 =    0x00101000,
135  CL_GAME_WORLD_DATA            =    0x00102000,
136  CL_GAME_RULES                 =    0x00104000,
137  CL_NETWORK_GAME_RULES         =    0x00108000,
138  CL_MISSION_GOAL               =    0x00110000,
139
140  CL_CAMPAIGN                   =    0x00000101,
141  CL_CAMPAIGN_DATA              =    0x00000102,
142  CL_SIMPLE_GAME_MENU           =    0x00000103,
143  CL_SIMPLE_GAME_MENU_DATA      =    0x00000104,
144  CL_SINGLE_PLAYER_WORLD        =    0x00000105,
145  CL_SINGLE_PLAYER_WORLD_DATA   =    0x00000106,
146  CL_MULTI_PLAYER_WORLD         =    0x00000107,
147  CL_MULTI_PLAYER_WORLD_DATA    =    0x00000108,
148  CL_MOVIE_LOADER               =    0x00000109,
149
150  CL_MULTIPLAYER_TEAM_DEATHMATCH=    0x00000121,
151  CL_SINGLEPLAYER_SHOOTEMUP     =    0x00000122,
152
153  CL_KILL_TARGET                =    0x00105001,
154
155
156  /// SUPER-PNodes
157  CL_FIELD                      =    0x00201000,
158
159  /// PNodes
160  CL_CAMERA                     =    0x00000201,
161  CL_CAMERA_TARGET              =    0x00000202,
162
163
164  /// SUPER-WorldEntities
165  CL_PLAYER                     =    0x00302000,
166
167  CL_PLAYABLE                   =    0x00301000,
168  CL_NPC                        =    0x00304000,
169  CL_PROJECTILE                 =    0x00308000,
170  CL_WEAPON                     =    0x00310000,
171  CL_POWER_UP                   =    0x00320000,
172  CL_EXTENDABLE                 =    0x00340000,
173
174  /// WorldEntities (range from 0x00000300 to 0x000005ff)
175  // Environments
176  CL_ENVIRONMENT                =    0x00000303,
177  CL_SATELLITE                  =    0x00000304,
178  CL_SKYBOX                     =    0x00000305,
179  CL_SKYSPHERE                  =    0x00000306,
180  CL_TERRAIN                    =    0x00000307,
181  CL_WATER                      =    0x00000308,
182  CL_PLANET                     =    0x00000309,
183  CL_BUILDING                   =    0x00000310,
184  CL_MAPPED_WATER               =    0x00000311,
185  CL_BSP_ENTITY                 =    0x00000312,
186
187  // Playables
188  CL_SPACE_SHIP                 =    0x0000035a,
189  CL_HELICOPTER                 =    0x0000035b,
190  CL_SPAWNING_POINT             =    0x0000035c,
191  CL_MD2_CREATURE               =    0x0000035d,
192  CL_HOVER                      =    0x0000035e,
193  CL_TURBINE_HOVER              =    0x0000035f,
194  CL_SPECTATOR                  =    0x00000360,
195
196  // Powerups
197  CL_TURRET_POWER_UP            =    0x00000381,
198  CL_LASER_POWER_UP             =    0x00000382,
199  CL_WEAPON_POWER_UP            =    0x00000383,
200  CL_PARAM_POWER_UP             =    0x00000384,
201
202  // Weapons
203  CL_TEST_GUN                   =    0x000003a0,
204  CL_TURRET                     =    0x000003a1,
205  CL_AIMING_TURRET              =    0x000003a2,
206  CL_CANNON                     =    0x000003a3,
207  CL_TARGETING_TURRET           =    0x000003a4,
208  CL_HYPERBLASTER               =    0x000003a5,
209
210  // Projectiles
211  CL_TEST_BULLET                =    0x000003e0,
212  CL_ROCKET                     =    0x000003e1,
213  CL_LASER                      =    0x000003e2,
214  CL_BOMB                       =    0x000003e3,
215  CL_GROUND_TURRET              =    0x000003e4,
216  CL_GUIDED_MISSILE             =    0x000003e5,
217  CL_HYPERBLAST                 =    0x000003e6,
218
219  // NPC's
220  CL_NPC_TEST1                  =    0x00000401,
221  CL_NPC_TEST2                  =    0x00000402,
222
223  // Testing Entities
224  CL_TEST_ENTITY                =    0x00000409,
225
226  // misc
227  CL_MOVIE_ENTITY               =    0x00000511,
228  CL_RECORDER                   =    0x00000512,
229
230  CL_IMAGE_ENTITY               =    0x00000513,
231  CL_IMAGE_PLANE                =    0x00000514,
232  CL_MODEL_ENTITY               =    0x00000515,
233  CL_TEXT_ELEMENT               =    0x00000516, /// TODO MOVE
234
235
236  /// GamePlay (range from 0x00000600 0x000006ff)
237  CL_EVENT                      =    0x00000601,
238  CL_KEY_MAPPER                 =    0x00000602,
239  CL_CROSSHAIR                  =    0x00000612,
240
241  CL_WEAPON_MANAGER             =    0x00000603,
242  CL_AMMO_CONTAINER             =    0x00000604,
243  CL_HUD                        =    0x00000620,
244
245
246  /// Physics stuff (range from 0x00000700 to 0x000008ff)
247  CL_PHYSICS_CONNECTION         =    0x00000701,
248  CL_FIELD_GRAVITY              =    0x00000710,
249  CL_FIELD_POINT_GRAVITY        =    0x00000711,
250  CL_FIELD_TWIRL                =    0x00000712,
251
252
253  /// Collision
254  CL_COLLISION                  =    0x00000711,
255  CL_COLLISION_HANDLE           =    0x00000712,
256  CL_COLLISION_REACTION         =    0X00000713,
257  CL_CR_PHYSICS_MOMENTUM        =    0X00000714,
258  CL_CR_PHYSICS_GROUND          =    0X00000715,
259  CL_CR_PHYSICS_GROUND_WALK     =    0X00000716,
260  CL_CR_OBJECT_DAMAGE          =    0X00000717,
261  CL_CR_OBJECT_PICKUP           =    0X00000718,
262  CL_CR_VERTEX_TRAFO            =    0X00000719,
263  CL_CR_SPECIAL_CALLBACK        =    0X00000720,
264
265
266  CL_BV_TREE                    =    0x00701000,
267  CL_BV_TREE_NODE               =    0x00702000,
268  CL_OBB_TREE                   =    0x00000721,
269  CL_OBB_TREE_NODE              =    0x00000722,
270  CL_BOUNDING_VOLUME            =    0x00710000,
271  CL_OBB                        =    0x00720000,
272  CL_BOUNDING_SPHERE            =    0x00740000,
273 
274
275
276  /// Graphical stuff (range from 0x00000800 to 0x00000aff)
277  /// SUPER-Textures
278  CL_TEXTURE                    =    0x00801000,
279  CL_TEXTURE_SEQUENCE           =    0x00802000,
280  CL_TEXT                       =    0x00804000,
281  CL_MULTI_LINE_TEXT            =    0x00000840,
282
283  // Texutres.
284  CL_FONT                       =    0x00000802,
285  CL_MOVIE_PLAYER               =    0x00000805,
286  CL_MEDIA_CONTAINER            =    0x00000806,
287
288  /// Super-Models
289  CL_MODEL                      =    0x00901000,
290  CL_STATIC_MODEL               =    0x00902000,
291  CL_VERTEX_ARRAY_MODEL         =    0x00904000,
292
293  // Models
294  CL_OBJ_MODEL                  =    0x00000907,
295
296  CL_PRIMITIVE_MODEL            =    0x00000908,
297  CL_MD2_MODEL                  =    0x00000909,
298  CL_HEIGHT_MAP                 =    0x0000090a,
299  CL_GRID                       =    0x0000090b,
300  CL_BSP_MODEL                  =    0x0000090c, //!FIXME
301 
302  CL_MATERIAL                   =    0x00000810,
303  CL_SHADER                     =    0x00000811,
304  CL_LIGHT                      =    0x00000821,
305
306  CL_BILLBOARD                  =    0x00000a01,
307
308  CL_GRAPHICS_EFFECT            =    0x00a01000,
309  CL_WEATHER_EFFECT             =    0x00a10000,
310  CL_FOG_EFFECT                 =    0x00000a10,
311  CL_VOLFOG_EFFECT              =    0x00000a11,
312  CL_LENSE_FLARE                =    0x00000a12,
313  CL_RAIN_EFFECT                =    0x00000a13,
314  CL_SNOW_EFFECT                =    0x00000a14,
315  CL_CLOUD_EFFECT               =    0x00000a15,
316  CL_LIGHTENING_EFFECT          =    0x00000a16,
317  CL_EXPLOSION                  =    0x00000a20,
318  CL_LIGHTNING_BOLT             =    0x00000a21,
319
320
321
322  // Particles
323  CL_PARTICLE_SYSTEM            =    0x00a02000,
324  CL_DOT_PARTICLES              =    0x00000aa1,
325  CL_SPARK_PARTICLES            =    0x00000aa2,
326  CL_SPRITE_PARTICLES           =    0x00000aa3,
327  CL_MODEL_PARTICLES            =    0x00000aa4,
328  //  CL_PNODE_PARTICLES            =    0x00a20000,
329
330  CL_PARTICLE_EMITTER           =    0x00a04000,
331  CL_DOT_EMITTER                =    0x00000ab1,
332  CL_PLANE_EMITTER              =    0x00000ab2,
333  CL_BOX_EMITTER                =    0x00000ab3,
334  CL_SPHERE_EMITTER             =    0x00000ab4,
335  //  CL_MODEL_EMITTER              =    0x00000a25,
336
337  // Element2D's  (range from 0x00000b00 to 0x00000bff)
338  /// GL-GUI
339  CL_GLGUI_WIDGET               =    0x00b01000,
340  CL_GLGUI_BUTTON               =    0x00b02000,
341  CL_GLGUI_PUSHBUTTON           =    0x00000b03,
342  CL_GLGUI_CHECKBUTTON          =    0x00000b04,
343  CL_GLGUI_RADIOBUTTON          =    0x00000b05,
344  CL_GLGUI_SLIDER               =    0x00000b06,
345  CL_GLGUI_PROGRESSBAR          =    0x00000b07,
346  CL_GLGUI_CONTAINER            =    0x00b04000,
347  CL_GLGUI_BOX                  =    0x00000b17,
348  CL_GLGUI_FRAME                =    0x00000b18,
349  CL_GLGUI_WINDOW               =    0x00000b19,
350  CL_GLMENU_IMAGE_SCREEN        =    0x00000b20,
351  CL_GLGUI_BAR                  =    0x00000b30,
352  CL_GLGUI_CURSOR               =    0x00000b50,
353  CL_GLGUI_INPUTLINE            =    0x00000b60,
354  CL_GLGUI_TEXTFIELD            =    0x00000b61,
355  CL_GLGUI_IMAGE                =    0x00000b70,
356
357  // QT_GUI
358  CL_GUI_SAVEABLE               =    0x00b10000,
359  CL_QTGUI_BUTTON               =    0x00000ba0,
360  CL_QTGUI_PUSHBUTTON           =    0x00000ba3,
361  CL_QTGUI_CHECKBUTTON          =    0x00000ba4,
362  CL_QTGUI_RADIOBUTTON          =    0x00000ba5,
363  CL_QTGUI_CONTAINER            =    0x00b200a0,
364  CL_QTGUI_BOX                  =    0x00000ba7,
365  CL_QTGUI_FRAME                =    0x00000ba8,
366  CL_QTGUI_WINDOW               =    0x00000ba9,
367  CL_QTMENU_IMAGE_SCREEN        =    0x00000ba0,
368  CL_QTGUI_BAR                  =    0x00000ba0,
369
370  /// AUDIO stuff (range from 0x00000c00 to 0x00000cff)
371  CL_SOUND_BUFFER               =    0x00000c01,
372  CL_SOUND_SOURCE               =    0x00000c02,
373  CL_SOUND_OGG_PLAYER           =    0x00000c11,
374
375
376  /// NETWORK stuff (range from 0x00000d00 to 0x00000dff)
377  CL_DATA_STREAM                =    0x00d01000,
378  CL_NETWORK_STREAM             =    0x00000d01,
379  CL_NETWORK_PROTOCOL           =    0x00000d02,
380  CL_NETWORK_SOCKET             =    0x00000d03,
381  CL_SERVER_SOCKET              =    0X00000d04,
382  CL_CONNECTION_MONITOR         =    0x00000d05,
383  CL_HANDSHAKE                  =    0x00000d06,
384  CL_NETWORK_GAME_MANAGER       =    0x00000d07,
385  CL_MESSAGE_MANAGER            =    0x00000d08,
386  CL_PLAYER_STATS               =    0x00000d09,
387  CL_SIMPLE_SYNC                =    0x00000d0a,
388
389
390
391  /// MISCELANEOUS: (range from 0x00000e00 to 0x00000fff)
392  CL_ANIMATION                  =    0x00000e01,
393  //  CL_ANIMATION3D                =    0x00000b02,
394  CL_QUICK_ANIMATION            =    0x00000e02,
395
396  CL_FACTORY                    =    0x00e01000,
397  CL_FAST_FACTORY               =    0x00000ea2,
398  CL_LOAD_PARAM                 =    0x00000ea3,
399  CL_DYNAMIC_LOADER             =    0x00000ea8,
400
401  CL_INI_PARSER                 =    0x00000e04,
402
403  CL_SHELL                      =    0x00000e10,
404  CL_SHELL_COMMAND              =    0x00000e11,
405  CL_SHELL_COMMAND_CLASS        =    0x00000e12,
406  CL_SHELL_INPUT                =    0x00000e13,
407  CL_SHELL_COMPLETION           =    0x00000e14,
408  CL_SHELL_COMMAND_ALIAS        =    0x00000e15,
409
410  CL_TRACK_ELEMENT              =    0x00000e2b,
411  CL_LIST                       =    0x00000e25,
412  CL_SUBSTRING                  =    0x00000e26,
413  CL_CURVE                      =    0x00000e28,
414  CL_CHARACTER_ATTRIBUTES       =    0x00000e2a,
415  CL_NUMBER                     =    0x00000e2c,
416  CL_EXECUTOR                   =    0x00000e2d,
417
418  // Spatial Data Separation
419  CL_SPATIAL_SEPARATION         =    0x00000e0d,
420  CL_QUADTREE                   =    0x00000e0e,
421  CL_QUADTREE_NODE              =    0x00000e0f,
422};
423
424
425#endif /* _CLASS_ID_H */
Note: See TracBrowser for help on using the repository browser.