| 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/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 | */ |
|---|
| 63 | typedef enum ClassID |
|---|
| 64 | { |
|---|
| 65 | // the Nothing CLASS (NULL) |
|---|
| 66 | CL_NULL = 0x00000000, |
|---|
| 67 | |
|---|
| 68 | // superclasses |
|---|
| 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 | // subsuper-classes derivations taken : 1, 2, 3, 5, a, b, c. << THIS IS A LIST OF ALL THE DCL_MASK_SUBSUPERCLASS_ID's taken |
|---|
| 87 | |
|---|
| 88 | // subsuper-classes |
|---|
| 89 | CL_MASK_SUBSUPER_CLASS = 0x00fff000, |
|---|
| 90 | CL_MASK_SUBSUPER_CLASS_IDA = 0x00f00000, |
|---|
| 91 | CL_MASK_SUBSUPER_CLASS_IDB = 0x000ff000, |
|---|
| 92 | // SUPER-PNodes |
|---|
| 93 | CL_FIELD = 0x00101000, |
|---|
| 94 | // SUPER-WorldEntities |
|---|
| 95 | CL_PLAYABLE = 0x00201000, |
|---|
| 96 | CL_PLAYER = 0x00202000, |
|---|
| 97 | CL_NPC = 0x00204000, |
|---|
| 98 | CL_PROJECTILE = 0x00208000, |
|---|
| 99 | CL_WEAPON = 0x00210000, |
|---|
| 100 | CL_POWER_UP = 0x00220000, |
|---|
| 101 | CL_EXTENDABLE = 0x00240000, |
|---|
| 102 | // SUPER-Modeling |
|---|
| 103 | CL_TEXTURE = 0x00c01000, |
|---|
| 104 | CL_TEXT = 0x00c02000, |
|---|
| 105 | |
|---|
| 106 | CL_MODEL = 0x00d01000, |
|---|
| 107 | CL_STATIC_MODEL = 0x00002000, |
|---|
| 108 | CL_VERTEX_ARRAY_MODEL = 0x00004000, |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | // subsuper-classes derivations taken : 1, 2, 5, a, b, c. << THIS IS A LIST OF ALL THE DCL_MASK_SUBSUPERCLASS_ID's taken |
|---|
| 112 | |
|---|
| 113 | // lowest level classes |
|---|
| 114 | CL_MASK_LOWLEVEL_CLASS = 0x00000fff, |
|---|
| 115 | |
|---|
| 116 | // singleton classes (range from 0x00000f00 to 0x00000fff) |
|---|
| 117 | CL_MASK_SINGLETON = 0x00000f00, |
|---|
| 118 | CL_ORXONOX = 0x00000f01, |
|---|
| 119 | CL_NULL_PARENT = 0x00000f02, |
|---|
| 120 | CL_PILOT_PARENT = 0x00000f03, |
|---|
| 121 | CL_OBJECT_MANAGER = 0x00000f04, |
|---|
| 122 | CL_RESOURCE_MANAGER = 0x00000f05, |
|---|
| 123 | CL_GARBAGE_COLLECTOR = 0x00000f06, |
|---|
| 124 | CL_GAME_LOADER = 0x00000f07, |
|---|
| 125 | CL_GRAPHICS_ENGINE = 0x00000f08, |
|---|
| 126 | CL_TEXT_ENGINE = 0x00000f09, |
|---|
| 127 | CL_LIGHT_MANAGER = 0x00000f0a, |
|---|
| 128 | CL_EVENT_HANDLER = 0x00000f0b, |
|---|
| 129 | CL_PHYSICS_ENGINE = 0x00000f0c, |
|---|
| 130 | CL_CD_ENGINE = 0x00000f0d, |
|---|
| 131 | CL_PARTICLE_ENGINE = 0x00000f0e, |
|---|
| 132 | CL_SOUND_ENGINE = 0x00000f0f, |
|---|
| 133 | CL_ANIMATION_PLAYER = 0x00000f10, |
|---|
| 134 | CL_TRACK_MANAGER = 0x00000f11, |
|---|
| 135 | CL_TRACK_NODE = 0x00000f12, |
|---|
| 136 | CL_STATE = 0x00000f13, |
|---|
| 137 | CL_FRAMEWORK = 0x00000f14, |
|---|
| 138 | CL_RENDER_2D = 0x00000f21, |
|---|
| 139 | CL_NULL_ELEMENT_2D = 0x00000f22, |
|---|
| 140 | CL_SHELL_BUFFER = 0x00000f32, |
|---|
| 141 | CL_GLGUI_HANDLER = 0x00000f40, |
|---|
| 142 | CL_GLGUI_MAIN_WIDGET = 0x00000f41, |
|---|
| 143 | CL_NETWORK_MANAGER = 0x00000f50, |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | // StoryEntities (range from 0x00000100 to 0x000001ff) |
|---|
| 148 | CL_CAMPAIGN = 0x00000101, |
|---|
| 149 | CL_CAMPAIGN_DATA = 0x00000102, |
|---|
| 150 | CL_GAME_WORLD = 0x00000103, |
|---|
| 151 | CL_GAME_WORLD_DATA = 0x00000104, |
|---|
| 152 | CL_SINGLE_PLAYER_WORLD = 0x00000105, |
|---|
| 153 | CL_SINGLE_PLAYER_WORLD_DATA = 0x00000106, |
|---|
| 154 | CL_MULTI_PLAYER_WORLD = 0x00000107, |
|---|
| 155 | CL_MULTI_PLAYER_WORLD_DATA = 0x00000108, |
|---|
| 156 | CL_MOVIE_LOADER = 0x00000109, |
|---|
| 157 | |
|---|
| 158 | // WorldEntities (range from 0x00000200 to 0x000004ff) |
|---|
| 159 | CL_CAMERA = 0x00000201, |
|---|
| 160 | CL_CAMERA_TARGET = 0x00000202, |
|---|
| 161 | |
|---|
| 162 | CL_ENVIRONEMENT = 0x00000203, |
|---|
| 163 | CL_SATELLITE = 0x00000204, |
|---|
| 164 | CL_SKYBOX = 0x00000205, |
|---|
| 165 | CL_SKYSPHERE = 0x00000206, |
|---|
| 166 | CL_TERRAIN = 0x00000207, |
|---|
| 167 | CL_WATER = 0x00000208, |
|---|
| 168 | |
|---|
| 169 | CL_TEST_ENTITY = 0x00000209, |
|---|
| 170 | CL_SPACE_SHIP = 0x0000020a, |
|---|
| 171 | CL_HELICOPTER = 0x0000020b, |
|---|
| 172 | CL_SPAWNING_POINT = 0x0000020c, |
|---|
| 173 | CL_MD2_CREATURE = 0x0000020d, |
|---|
| 174 | |
|---|
| 175 | CL_TURRET_POWER_UP = 0x00000211, |
|---|
| 176 | CL_LASER_POWER_UP = 0x00000212, |
|---|
| 177 | CL_WEAPON_POWER_UP = 0x00000213, |
|---|
| 178 | CL_PARAM_POWER_UP = 0x00000214, |
|---|
| 179 | |
|---|
| 180 | CL_TEST_GUN = 0x00000230, |
|---|
| 181 | CL_TURRET = 0x00000231, |
|---|
| 182 | CL_AIMING_TURRET = 0x00000232, |
|---|
| 183 | CL_CANNON = 0x00000233, |
|---|
| 184 | CL_TARGETING_TURRET = 0x00000234, |
|---|
| 185 | |
|---|
| 186 | CL_TEST_BULLET = 0x00000240, |
|---|
| 187 | CL_ROCKET = 0x00000241, |
|---|
| 188 | CL_LASER = 0x00000242, |
|---|
| 189 | CL_BOMB = 0x00000243, |
|---|
| 190 | CL_GROUND_TURRET = 0x00000244, |
|---|
| 191 | CL_GUIDED_MISSILE = 0x00000245, |
|---|
| 192 | |
|---|
| 193 | CL_NPC_TEST1 = 0x00000301, |
|---|
| 194 | CL_NPC_TEST2 = 0x00000302, |
|---|
| 195 | CL_MOVIE_ENTITY = 0x00000303, |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | // gamePlay (range from 0x00000500 0x000005ff) |
|---|
| 199 | CL_EVENT = 0x00000501, |
|---|
| 200 | CL_KEY_MAPPER = 0x00000502, |
|---|
| 201 | CL_CROSSHAIR = 0x00000512, |
|---|
| 202 | |
|---|
| 203 | CL_WEAPON_MANAGER = 0x00000503, |
|---|
| 204 | CL_HUD = 0x00000520, |
|---|
| 205 | |
|---|
| 206 | // Physics stuff (range from 0x00000600 to 0x000007ff) |
|---|
| 207 | CL_PHYSICS_CONNECTION = 0x00000601, |
|---|
| 208 | CL_FIELD_GRAVITY = 0x00000610, |
|---|
| 209 | CL_FIELD_POINT_GRAVITY = 0x00000611, |
|---|
| 210 | CL_FIELD_TWIRL = 0x00000612, |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | // Collision |
|---|
| 214 | CL_COLLISION = 0x00000611, |
|---|
| 215 | CL_BV_TREE = 0x00a01000, |
|---|
| 216 | CL_BV_TREE_NODE = 0x00002000, |
|---|
| 217 | CL_OBB_TREE = 0x00000614, |
|---|
| 218 | CL_OBB_TREE_NODE = 0x00000615, |
|---|
| 219 | CL_BOUNDING_VOLUME = 0x00a10000, |
|---|
| 220 | CL_OBB = 0x00020617, |
|---|
| 221 | CL_BOUNDING_SPHERE = 0x00040618, |
|---|
| 222 | |
|---|
| 223 | // graphical stuff (range from 0x00000800 to 0x000009ff) |
|---|
| 224 | CL_FONT = 0x00000802, |
|---|
| 225 | |
|---|
| 226 | CL_PARTICLE_EMITTER = 0x00201852, |
|---|
| 227 | CL_PARTICLE_SYSTEM = 0x00202000, |
|---|
| 228 | CL_SPRITE_PARTICLES = 0x00000853, |
|---|
| 229 | CL_SPARK_PARTICLES = 0x00000854, |
|---|
| 230 | CL_PNODE_PARTICLES = 0x00000855, |
|---|
| 231 | CL_DOT_PARTICLES = 0x00000856, |
|---|
| 232 | CL_MODEL_PARTICLES = 0x00000857, |
|---|
| 233 | // CL_TEMPLATE_PARTICLES = 0x00000857, |
|---|
| 234 | |
|---|
| 235 | CL_MATERIAL = 0x00000804, |
|---|
| 236 | CL_TEXTURE_SEQUENCE = 0x00004805, |
|---|
| 237 | CL_OBJ_MODEL = 0x00000807, |
|---|
| 238 | |
|---|
| 239 | CL_MOVIE_PLAYER = 0x00000805, |
|---|
| 240 | CL_MEDIA_CONTAINER = 0x00000806, |
|---|
| 241 | CL_PROMITIVE_MODEL = 0x00000808, |
|---|
| 242 | CL_MD2Model = 0x00000809, |
|---|
| 243 | CL_HEIGHT_MAP = 0x0000080a, |
|---|
| 244 | CL_GRID = 0x0000080b, |
|---|
| 245 | |
|---|
| 246 | CL_LIGHT = 0x00000811, |
|---|
| 247 | CL_ENVIRONMENT = 0x00000821, |
|---|
| 248 | CL_SHADER = 0x00000822, |
|---|
| 249 | // GL-GUI |
|---|
| 250 | CL_GLGUI_WIDGET = 0x00500000, |
|---|
| 251 | CL_GLGUI_BUTTON = 0x00501000, |
|---|
| 252 | CL_GLGUI_PUSHBUTTON = 0x00000903, |
|---|
| 253 | CL_GLGUI_CHECKBUTTON = 0x00000904, |
|---|
| 254 | CL_GLGUI_RADIOBUTTON = 0x00000905, |
|---|
| 255 | CL_GLGUI_CONTAINER = 0x00002906, |
|---|
| 256 | CL_GLGUI_BOX = 0x00000907, |
|---|
| 257 | CL_GLGUI_FRAME = 0x00000908, |
|---|
| 258 | CL_GLGUI_WINDOW = 0x00000909, |
|---|
| 259 | CL_GLMENU_IMAGE_SCREEN = 0x00000920, |
|---|
| 260 | CL_GLGUI_BAR = 0x00000930, |
|---|
| 261 | |
|---|
| 262 | // sound stuff (range from 0x00000a00 to 0x00000aff) |
|---|
| 263 | CL_SOUND_BUFFER = 0x00000a01, |
|---|
| 264 | CL_SOUND_SOURCE = 0x00000a02, |
|---|
| 265 | CL_SOUND_OGG_PLAYER = 0x00000a11, |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | // network stuff (range from 0x00000b00 to 0x00000bff) |
|---|
| 269 | CL_DATA_STREAM = 0x00b01b00, |
|---|
| 270 | CL_NETWORK_STREAM = 0x00000b01, |
|---|
| 271 | CL_NETWORK_PROTOCOL = 0x00000b02, |
|---|
| 272 | CL_NETWORK_SOCKET = 0x00000b03, |
|---|
| 273 | CL_SERVER_SOCKET = 0X00000b04, |
|---|
| 274 | CL_CONNECTION_MONITOR = 0x00000b05, |
|---|
| 275 | CL_HANDSHAKE = 0x00000b06, |
|---|
| 276 | CL_NETWORK_GAME_MANAGER = 0x00000b07, |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | // misc: (range from 0x00000d00 to 0x00000eff) |
|---|
| 281 | CL_ANIMATION = 0x00000d01, |
|---|
| 282 | // CL_ANIMATION3D = 0x00000b02, |
|---|
| 283 | CL_QUICK_ANIMATION = 0x00000d02, |
|---|
| 284 | CL_FACTORY = 0x00000d03, |
|---|
| 285 | CL_INI_PARSER = 0x00000d04, |
|---|
| 286 | CL_LIST = 0x00000d05, |
|---|
| 287 | CL_SUBSTRING = 0x00000d06, |
|---|
| 288 | CL_LOAD_PARAM = 0x00000d07, |
|---|
| 289 | CL_CURVE = 0x00000d08, |
|---|
| 290 | CL_VECTOR = 0x00000d09, |
|---|
| 291 | CL_CHARACTER_ATTRIBUTES = 0x00000d0a, |
|---|
| 292 | CL_TRACK_ELEMENT = 0x00000d0b, |
|---|
| 293 | CL_NUMBER = 0x00000d0c, |
|---|
| 294 | CL_EXECUTOR = 0x00000d0d, |
|---|
| 295 | CL_FAST_FACTORY = 0x00000d01, |
|---|
| 296 | CL_SHELL = 0x00000d10, |
|---|
| 297 | CL_SHELL_COMMAND = 0x00000d11, |
|---|
| 298 | CL_SHELL_COMMAND_CLASS = 0x00000d12, |
|---|
| 299 | CL_SHELL_INPUT = 0x00000d13, |
|---|
| 300 | CL_SHELL_COMPLETION = 0x00000d14, |
|---|
| 301 | CL_SHELL_COMMAND_ALIAS = 0x00000d15, |
|---|
| 302 | |
|---|
| 303 | // Spatial Data Separation |
|---|
| 304 | CL_SPATIAL_SEPARATION = 0x00000d0d, |
|---|
| 305 | CL_QUADTREE = 0x00000d0e, |
|---|
| 306 | CL_QUADTREE_NODE = 0x00000d0f, |
|---|
| 307 | }; |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | #endif /* _CLASS_ID_H */ |
|---|