Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/network/src/defs/class_id.h @ 5591

Last change on this file since 5591 was 5575, checked in by patrick, 19 years ago

network: now working with classlist
File size: 9.5 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: Patrick Boenzli
13   co-programmer: Benjamin Grauer
14
15   2005-06-10: (bensch) added new sturcture to support multiple inheritance
16*/
17
18/*!
19 * @file class_id.h
20 * @brief list of orxonox classID's
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 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. if it is a (SUB)SUPERCLASS also add the CLASS to BaseObject::whatIs() so we have nice output :)
29 *    3. check if the Number you add is not refered to twice, and that with (SUB)SUPERCLASSES there are no intersections
30 *    4. 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 * inheritance is done in the following way: Classes are identified by
39 * a HEX-number eg: 0x12345678
40 * The number has 8^4 entries.
41 * The first two: 1,2 superclass identifiers to
42 * The second three are for subclasses with inheritance:
43 *  the first of these numbers is defining the subclassType, it may be anything between 1-a
44 *  The following two may not be the same in any way,
45 * eg. the bits may not intersect (no 1, 2 and a 3; 01, 02 and 04, 08, 10  would be ok)
46 * The last three entries are for any classes in existence eg. SkyBox and so on
47 *
48 * -> # max SuperClass-count        = 7 (not intersecting)
49 *    # max SubSuperClass-count     = 15*7 = 105 (the 7 classes will be able to get derived from each other, but not over the SubSuperClass.)
50 *    # max lowerClasses-count      = 3^16 = enough (they are Leaves, and may NOT be derived by any other class.)
51 */
52typedef enum ClassID
53{
54  // the Nothing CLASS (NULL)
55  CL_NULL                       =    0x00000000,
56
57  // superclasses
58  CL_MASK_SUPER_CLASS           =    0xff000000,
59  CL_BASE_OBJECT                =    0xff000000,
60
61  CL_PARENT_NODE                =    0x01000000,
62
63  CL_STORY_ENTITY               =    0x02000000,
64
65  CL_PHYSICS_INTERFACE          =    0x04000000,
66
67  CL_EVENT_LISTENER             =    0x08000000,
68
69  CL_ELEMENT_2D                 =    0x10000000,
70
71  CL_SYNCHRONIZEABLE             =    0x20000000,
72
73  CL_WORLD_ENTITY               =    0x40000000,
74
75
76  // subsuper-classes
77  CL_MASK_SUBSUPER_CLASS        =    0x00fff000,
78  CL_MASK_SUBSUPER_CLASS_ID     =    0x00f00000,
79  CL_MASK_SUBSUPER_CLASS_ID2    =    0x000ff000,
80  CL_PLAYER                     =    0x00101000,
81  CL_NPC                        =    0x00102000,
82  CL_POWER_UP                   =    0x00104000,
83  CL_FIELD                      =    0x00108000,
84  CL_PROJECTILE                 =    0x00110000,
85  CL_WEAPON                     =    0x00120000,
86
87  // subsuper-classes derivations taken : 1, 5, a, b, c.     << THIS IS A LIST OF ALL THE DCL_MASK_SUBSUPERCLASS_ID's taken
88
89  // lowest level classes
90  CL_MASK_LOWLEVEL_CLASS        =    0x00000fff,
91
92  // singleton classes (range from 0x00000f00 to 0x00000fff)
93  CL_MASK_SINGLETON             =    0x00000f00,
94  CL_ORXONOX                    =    0x00000f01,
95  CL_NULL_PARENT                =    0x00000f02,
96  CL_PILOT_PARENT               =    0x00000f03,
97  CL_OBJECT_MANAGER             =    0x00000f04,
98  CL_RESOURCE_MANAGER           =    0x00000f05,
99  CL_GARBAGE_COLLECTOR          =    0x00000f06,
100  CL_GAME_LOADER                =    0x00000f07,
101  CL_GRAPHICS_ENGINE            =    0x00000f08,
102  CL_TEXT_ENGINE                =    0x00000f09,
103  CL_LIGHT_MANAGER              =    0x00000f0a,
104  CL_EVENT_HANDLER              =    0x00000f0b,
105  CL_PHYSICS_ENGINE             =    0x00000f0c,
106  CL_CD_ENGINE                  =    0x00000f0d,
107  CL_PARTICLE_ENGINE            =    0x00000f0e,
108  CL_SOUND_ENGINE               =    0x00000f0f,
109  CL_ANIMATION_PLAYER           =    0x00000f10,
110  CL_TRACK_MANAGER              =    0x00000f11,
111  CL_TRACK_NODE                 =    0x00000f12,
112  CL_STATE                      =    0x00000f13,
113  CL_FRAMEWORK                  =    0x00000f14,
114  CL_RENDER_2D                  =    0x00000f21,
115  CL_NULL_ELEMENT_2D            =    0x00000f22,
116  CL_SHELL_BUFFER               =    0x00000f32,
117  CL_GLGUI_HANDLER              =    0x00000f40,
118  CL_GLGUI_MAIN_WIDGET          =    0x00000f41,
119  CL_NETWORK_MANAGER            =    0x00000f50,
120
121
122  // StoryEntities (range from 0x00000100 to 0x000001ff)
123  CL_CAMPAIGN                   =    0x00000101,
124  CL_WORLD                      =    0x00000102,
125
126
127  // WorldEntities (range from 0x00000200 to 0x000004ff)
128  CL_CAMERA                     =    0x00000201,
129  CL_CAMERA_TARGET              =    0x00000202,
130
131  CL_ENVIRONEMENT               =    0x00000203,
132  CL_SATELLITE                  =    0x00000204,
133  CL_SKYBOX                     =    0x00000205,
134  CL_SKYSPHERE                  =    0x00000206,
135  CL_TERRAIN                    =    0x00000207,
136  CL_TEST_ENTITY                =    0x00000209,
137
138  CL_TURRET_POWER_UP            =    0x00000211,
139  CL_LASER_POWER_UP             =    0x00000212,
140
141  CL_TEST_GUN                   =    0x00000230,
142  CL_TURRET                     =    0x00000231,
143
144
145  CL_TEST_BULLET                =    0x00000240,
146  CL_ROCKET                     =    0x00000241,
147  CL_LASER                      =    0x00000242,
148
149
150  // gamePlay (range from 0x00000500 0x000005ff)
151  CL_EVENT                      =    0x00000501,
152  CL_KEY_MAPPER                 =    0x00000502,
153  CL_USER_CONTROL               =    0x00000511,
154  CL_CROSSHAIR                  =    0x00000512,
155
156  CL_WEAPON_MANAGER             =    0x00000503,
157
158  // Physics stuff (range from 0x00000600 to 0x000007ff)
159  CL_PHYSICS_CONNECTION         =    0x00000601,
160  CL_FIELD_GRAVITY              =    0x00000610,
161  CL_FIELD_POINT_GRAVITY        =    0x00000611,
162  CL_FIELD_TWIRL                =    0x00000612,
163
164
165  // Collision
166  CL_COLLISION                  =    0x00000611,
167  CL_BV_TREE                    =    0x00a01612,
168  CL_BV_TREE_NODE               =    0x00a02613,
169  CL_OBB_TREE                   =    0x00a04614,
170  CL_OBB_TREE_NODE              =    0x00a08615,
171  CL_BOUNDING_VOLUME            =    0x00a10616,
172  CL_OBB                        =    0x00a20617,
173  CL_BOUNDING_SPHERE            =    0x00a40618,
174
175  // graphical stuff (range from 0x00000800 to 0x000009ff)
176  CL_TEXT                       =    0x00b01801,
177  CL_FONT                       =    0x00000802,
178  CL_TEXTURE                    =    0x00000803,
179  CL_MATERIAL                   =    0x00000804,
180  CL_MODEL                      =    0x00000805, //!< @todo make this a SUBCLASS maybe
181  CL_OBJMODEL                   =    0x00000806,
182  CL_PROMITIVE_MODEL            =    0x00000807,
183  CL_MD2Model                   =    0x00000808,
184  CL_LIGHT                      =    0x00000809,
185  CL_PARTICLE_EMITTER           =    0x0000080a,
186  CL_PARTICLE_SYSTEM            =    0x0000080b,
187  CL_ENVIRONMENT                =    0x00000810,
188  CL_SHADER                     =    0x00000811,
189  // GL-GUI
190  CL_GLGUI_WIDGET               =    0x00501901,
191  CL_GLGUI_BUTTON               =    0x00502902,
192  CL_GLGUI_PUSHBUTTON           =    0x00000903,
193  CL_GLGUI_CHECKBUTTON          =    0x00000904,
194  CL_GLGUI_RADIOBUTTON          =    0x00000905,
195  CL_GLGUI_CONTAINER            =    0x00504906,
196  CL_GLGUI_BOX                  =    0x00000907,
197  CL_GLGUI_FRAME                =    0x00000908,
198  CL_GLGUI_WINDOW               =    0x00000909,
199  CL_GLMENU_IMAGE_SCREEN        =    0x00000920,
200
201  // sound stuff (range from 0x00000a00 to 0x00000aff)
202  CL_SOUND_BUFFER               =    0x00000a01,
203  CL_SOUND_SOURCE               =    0x00000a02,
204  CL_SOUND_OGG_PLAYER           =    0x00000a11,
205
206
207  // network stuff (range from 0x00000b00 to 0x00000bff)
208  CL_DATA_STREAM                =    0x00b01000,
209  CL_NETWORK_STREAM             =    0x00000b01,
210  CL_NETWORK_PROTOCOL           =    0x00000b02,
211  CL_NETWORK_SOCKET             =    0x00000b03,
212  CL_CONNECTION_MONITOR         =    0x00000b04,
213
214
215
216  // misc: (range from 0x00000d00 to 0x00000eff)
217  CL_ANIMATION                  =    0x00000d01,
218  //  CL_ANIMATION3D                =    0x00000b02,
219  CL_QUICK_ANIMATION            =    0x00000d02,
220  CL_FACTORY                    =    0x00000d03,
221  CL_INI_PARSER                 =    0x00000d04,
222  CL_LIST                       =    0x00000d05,
223  CL_SUBSTRING                  =    0x00000d06,
224  CL_LOAD_PARAM                 =    0x00000d07,
225  CL_CURVE                      =    0x00000d08,
226  CL_VECTOR                     =    0x00000d09,
227  CL_CHARACTER_ATTRIBUTES       =    0x00000d0a,
228  CL_TRACK_ELEMENT              =    0x00000d0b,
229  CL_NUMBER                     =    0x00000d0c,
230  CL_FAST_FACTORY               =    0x00000d01,
231  CL_SHELL                      =    0x00000d10,
232  CL_SHELL_COMMAND              =    0x00000d11,
233  CL_SHELL_COMMAND_CLASS        =    0x00000d12,
234  CL_SHELL_INPUT                =    0x00000d13,
235  CL_SHELL_COMPLETION           =    0x00000d14,
236  CL_SHELL_COMMAND_ALIAS        =    0x00000d15,
237
238  // Spatial Data Separation
239  CL_SPATIAL_SEPARATION         =    0x00000d0d,
240  CL_QUADTREE                   =    0x00000d0e,
241  CL_QUADTREE_NODE              =    0x00000d0f
242};
243
244
245#endif /* _CLASS_ID_H */
Note: See TracBrowser for help on using the repository browser.