[4680] | 1 | /*! |
---|
[4885] | 2 | * @file world_entity.h |
---|
| 3 | * Definition of the basic WorldEntity |
---|
[7711] | 4 | */ |
---|
[2036] | 5 | |
---|
[3224] | 6 | #ifndef _WORLD_ENTITY_H |
---|
| 7 | #define _WORLD_ENTITY_H |
---|
[2036] | 8 | |
---|
[3365] | 9 | #include "p_node.h" |
---|
[5996] | 10 | #include "synchronizeable.h" |
---|
| 11 | #include "model.h" |
---|
[2036] | 12 | |
---|
[7927] | 13 | #include "cr_engine.h" |
---|
[10013] | 14 | #include "collision_filter.h" |
---|
[6142] | 15 | #include "object_manager.h" |
---|
[5511] | 16 | #include "glincl.h" |
---|
[5995] | 17 | #include <vector> |
---|
[5511] | 18 | |
---|
[8724] | 19 | #include "aabb_tree_node.h" |
---|
| 20 | |
---|
[8190] | 21 | #include "physics_interface.h" |
---|
[7927] | 22 | |
---|
| 23 | |
---|
[8190] | 24 | |
---|
[4885] | 25 | // FORWARD DECLARATION |
---|
[7460] | 26 | namespace OrxSound { class SoundBuffer; class SoundSource; } |
---|
[8974] | 27 | namespace OrxGui { class GLGuiWidget; class GLGuiBar; class GLGuiEnergyWidget; }; |
---|
[10013] | 28 | namespace CoRe { class Collision; } |
---|
[7779] | 29 | |
---|
[5143] | 30 | class BVTree; |
---|
[8190] | 31 | class BoundingVolume; |
---|
[8724] | 32 | class AABBTreeNode; |
---|
[5511] | 33 | class Model; |
---|
[6440] | 34 | |
---|
[7927] | 35 | |
---|
[4885] | 36 | //! Basis-class all interactive stuff in the world is derived from |
---|
[6498] | 37 | class WorldEntity : public PNode |
---|
[4680] | 38 | { |
---|
[9869] | 39 | ObjectListDeclaration(WorldEntity); |
---|
[10013] | 40 | |
---|
[6430] | 41 | public: |
---|
| 42 | WorldEntity(); |
---|
[3221] | 43 | virtual ~WorldEntity (); |
---|
[3365] | 44 | |
---|
[6512] | 45 | virtual void loadParams(const TiXmlElement* root); |
---|
[5994] | 46 | |
---|
[7711] | 47 | void loadModel(const std::string& fileName, float scaling = 1.0f, unsigned int modelNumber = 0, unsigned int obbTreeDepth = 4); |
---|
[9235] | 48 | void loadModel2(const std::string& fileN, float scal = 1.0f){this->loadModel(fileN,scal,0,4);} |
---|
[5994] | 49 | void setModel(Model* model, unsigned int modelNumber = 0); |
---|
[10013] | 50 | Model* getModel(unsigned int modelNumber = 0) const { return (this->models.size() > modelNumber)? this->models[modelNumber] : NULL; }; |
---|
[5994] | 51 | |
---|
[7221] | 52 | inline void loadMD2Texture(const std::string& fileName) { this->md2TextureFileName = fileName; } |
---|
[6222] | 53 | |
---|
[4885] | 54 | /** @param visibility if the Entity should be visible (been draw) */ |
---|
| 55 | void setVisibiliy (bool visibility) { this->bVisible = visibility; }; |
---|
| 56 | /** @returns true if the entity is visible, false otherwise */ |
---|
[5511] | 57 | inline bool isVisible() const { return this->bVisible; }; |
---|
[5026] | 58 | |
---|
[7085] | 59 | virtual void reset(); |
---|
[3583] | 60 | |
---|
[3229] | 61 | virtual void postSpawn (); |
---|
[6959] | 62 | virtual void leaveWorld (); |
---|
[3583] | 63 | |
---|
[5501] | 64 | virtual void tick (float time); |
---|
| 65 | virtual void draw () const; |
---|
[6005] | 66 | |
---|
[7927] | 67 | /* --- Collision Detection Block --- */ |
---|
[7711] | 68 | bool buildObbTree(int depth); |
---|
[5029] | 69 | virtual void collidesWith (WorldEntity* entity, const Vector& location); |
---|
[8186] | 70 | virtual void collidesWithGround(const Vector& location); |
---|
| 71 | virtual void collidesWithGround(const Vector& feet, const Vector& ray_1, const Vector& ray_2); |
---|
| 72 | |
---|
[9869] | 73 | /** @returns a reference to the obb tree of this worldentity */ |
---|
[7711] | 74 | inline BVTree* getOBBTree() const { return this->obbTree; }; |
---|
[9235] | 75 | inline void setOBBTree(OBBTree* tree) { /*if( this->obbTree != NULL) delete this->obbTree;*/ this->obbTree = (BVTree*)tree; } |
---|
[7711] | 76 | void drawBVTree(int depth, int drawMode) const; |
---|
[9235] | 77 | inline AABB* getModelAABB() const { return (this->aabbNode)?this->aabbNode->getAABB():NULL;} |
---|
[5501] | 78 | |
---|
[10013] | 79 | virtual void hit(float damage, WorldEntity* killer); |
---|
| 80 | |
---|
| 81 | |
---|
[7927] | 82 | /* --- Collision Reaction Block --- */ |
---|
[10013] | 83 | void subscribeReaction(CoRe::CREngine::ReactionType type, const ClassID& target1); |
---|
| 84 | void subscribeReaction(CoRe::CREngine::ReactionType type, const ClassID& target1, const ClassID& target2); |
---|
| 85 | void subscribeReaction(CoRe::CREngine::ReactionType type, const ClassID& target1, const ClassID& target2, const ClassID& target3); |
---|
[6424] | 86 | |
---|
[10013] | 87 | void unsubscribeReaction(CoRe::CREngine::ReactionType type); |
---|
| 88 | void unsubscribeReactions(); |
---|
[6424] | 89 | |
---|
[8190] | 90 | /** @return true if there is at least on collision reaction subscribed */ |
---|
[10013] | 91 | inline bool isReactive() const { return this->_collisionFilter.isReactive(); } |
---|
[8190] | 92 | |
---|
[10013] | 93 | /** @param worldEntity the world entity to be checked @returns true if there is a collisionreaction registered for the worldEntity */ |
---|
| 94 | inline bool isReactive( const WorldEntity& worldEntity) const { return this->_collisionFilter(worldEntity); } |
---|
| 95 | /** @param worldEntity the world entity to be checked @param type special reaction type @returns true if collision reaction reg. */ |
---|
| 96 | inline bool isReactive( const WorldEntity& worldEntity, const CoRe::CREngine::ReactionType& type) const |
---|
| 97 | { return this->_collisionFilter(worldEntity, type); } |
---|
[8190] | 98 | |
---|
[10013] | 99 | |
---|
| 100 | const CoRe::CollisionFilter& getCollisionFilter(CoRe::CREngine::ReactionType type) const { return this->_collisionFilter; } |
---|
| 101 | |
---|
[9003] | 102 | /** @returns true if this entity is standing on ground (BSP model) */ |
---|
[10013] | 103 | bool isOnGround() const { return this->_bOnGround; } |
---|
[9003] | 104 | /** @param flag: marks if this entity is standing on ground */ |
---|
[10013] | 105 | void setOnGround(bool flag) { this->_bOnGround = flag; } |
---|
[9003] | 106 | |
---|
[9235] | 107 | virtual void destroy( WorldEntity* killer ); |
---|
[8190] | 108 | |
---|
[8724] | 109 | |
---|
[5510] | 110 | /* @returns the Count of Faces on this WorldEntity */ |
---|
| 111 | //unsigned int getFaceCount () const { return (this->model != NULL)?this->model->getFaceCount():0; }; |
---|
| 112 | // void addAbility(Ability* ability); |
---|
| 113 | // void removeAbility(Ability* ability); |
---|
| 114 | // void setCharacterAttributes(CharacterAttributes* charAttr); |
---|
| 115 | // CharacterAttributes* getCharacterAttributes(); |
---|
[4680] | 116 | |
---|
[7927] | 117 | /* --- Object Manager Block --- */ |
---|
[6142] | 118 | void toList(OM_LIST list); |
---|
[9656] | 119 | void toListS(const std::string& listName); |
---|
[8037] | 120 | |
---|
| 121 | void toReflectionList(); |
---|
| 122 | void removeFromReflectionList(); |
---|
| 123 | |
---|
[6142] | 124 | /** @returns a Reference to the objectListNumber to set. */ |
---|
| 125 | OM_LIST& getOMListNumber() { return this->objectListNumber; } |
---|
| 126 | /** @returns a Reference to the Iterator */ |
---|
[7370] | 127 | ObjectManager::EntityList::iterator& getEntityIterator() { return this->objectListIterator; } |
---|
[6222] | 128 | |
---|
[8894] | 129 | void hide() { if( this->objectListNumber != OM_DEAD) this->lastObjectListNumber = this->objectListNumber; this->toList(OM_DEAD); } |
---|
[10013] | 130 | void unhide() { if( this->objectListNumber != this->lastObjectListNumber) this->toList(this->lastObjectListNumber); } |
---|
[8894] | 131 | |
---|
| 132 | |
---|
[7927] | 133 | /* --- Character Attribute Block --- */ |
---|
[9298] | 134 | /** @returns the scaling of the model */ |
---|
[10013] | 135 | float getScaling(){return this->scaling;} |
---|
[8190] | 136 | /** @returns the damage dealt by this world entity */ |
---|
| 137 | float getDamage() const { return this->damage; } |
---|
| 138 | /** sets the damage dealt to @param damage damage per second */ |
---|
| 139 | void setDamage(float damage) { this->damage = damage; } |
---|
[6430] | 140 | /** @returns the Energy of the entity */ |
---|
[6700] | 141 | float getHealth() const { return this->health; }; |
---|
[6430] | 142 | /** @returns the Maximum energy this entity can be charged with */ |
---|
[6700] | 143 | float getHealthMax() const { return this->healthMax; } |
---|
| 144 | float increaseHealth(float health); |
---|
| 145 | float decreaseHealth(float health); |
---|
| 146 | void increaseHealthMax(float increaseHealth); |
---|
[7779] | 147 | OrxGui::GLGuiWidget* getHealthWidget(); |
---|
[7064] | 148 | bool hasHealthWidget() const { return this->healthWidget; }; |
---|
[8190] | 149 | |
---|
[7954] | 150 | virtual void varChangeHandler( std::list<int> & id ); |
---|
[6430] | 151 | |
---|
[8190] | 152 | |
---|
| 153 | //FIXME: the PhysicsInterface and the whole PEngine should probably be reviewed. Here its just used to store the vars |
---|
| 154 | /* --- Physics Interface --- */ |
---|
| 155 | inline PhysicsInterface getPhysicsInterface() const { return this->physicsInterface; } |
---|
| 156 | inline float getMass() const { return this->physicsInterface.getMass(); } |
---|
| 157 | inline float getTotalMass() const { return this->physicsInterface.getTotalMass(); } |
---|
[8490] | 158 | inline void setVelocity(const Vector& vel) { this->velocity = vel; } |
---|
[8190] | 159 | |
---|
| 160 | |
---|
[7927] | 161 | /* --- Misc Stuff Block --- */ |
---|
| 162 | void debugWE() { this->debugEntity(); } |
---|
| 163 | ; ///FIXME |
---|
| 164 | void debugEntity() const; |
---|
| 165 | |
---|
| 166 | |
---|
[6430] | 167 | protected: |
---|
[7095] | 168 | void setHealth(float health) { this->health = health; this->updateHealthWidget();}; |
---|
[6700] | 169 | void setHealthWidgetVisibilit(bool visibility); |
---|
| 170 | void setHealthMax(float healthMax); |
---|
| 171 | void createHealthWidget(); |
---|
[10013] | 172 | // CharacterAttributes* charAttr; //!< the character attributes of a world_entity |
---|
[7711] | 173 | |
---|
[10013] | 174 | |
---|
[6430] | 175 | private: |
---|
[6700] | 176 | void updateHealthWidget(); |
---|
[5994] | 177 | |
---|
[10013] | 178 | |
---|
[6430] | 179 | private: |
---|
| 180 | /// TODO maybe we will move the following three entries and the corresponding functions to Playable AND NPC |
---|
[8190] | 181 | float damage; //!< the damage dealt to other objects by colliding. |
---|
[6700] | 182 | float health; //!< The Energy of this Entity, if the Entity has any energy at all. |
---|
| 183 | float healthMax; //!< The Maximal energy this entity can take. |
---|
[8974] | 184 | OrxGui::GLGuiEnergyWidget* healthWidget; //!< The Slider (if wanted). |
---|
[6341] | 185 | |
---|
[6142] | 186 | std::vector<Model*> models; //!< The model that should be loaded for this entity. |
---|
[7221] | 187 | std::string md2TextureFileName; //!< the file name of the md2 model texture, only if this |
---|
| 188 | std::string modelLODName; //!< the name of the model lod file |
---|
[6142] | 189 | BVTree* obbTree; //!< this is the obb tree reference needed for collision detection |
---|
[8724] | 190 | AABBTreeNode* aabbNode; //!< the tree node of the first level of a axis aligned bounding boxes tree: model dimension |
---|
[4680] | 191 | |
---|
[6142] | 192 | bool bCollide; //!< If it should be considered for the collisiontest. |
---|
| 193 | bool bVisible; //!< If it should be visible. |
---|
| 194 | |
---|
[8190] | 195 | OM_LIST objectListNumber; //!< The ObjectList from ObjectManager this Entity is in. |
---|
| 196 | ObjectManager::EntityList::iterator objectListIterator; //!< The iterator position of this Entity in the given list of the ObjectManager. |
---|
[8894] | 197 | OM_LIST lastObjectListNumber; //!< the last ObjectList from the ObjectManager this Entity was is in |
---|
[6142] | 198 | |
---|
[10013] | 199 | /* collision reaction stuff */ |
---|
| 200 | CoRe::CollisionFilter _collisionFilter; //!< filter for collision event filtering (not every entity listens to all collisions) |
---|
| 201 | bool _bOnGround; //!< flag true if the object is on the ground |
---|
[6341] | 202 | |
---|
[10013] | 203 | PhysicsInterface physicsInterface; //!< the physics object of the WorldEntity |
---|
[6341] | 204 | |
---|
[10013] | 205 | /* network help structures */ |
---|
[8190] | 206 | float scaling; //!< model's scaling factor |
---|
| 207 | int scaling_handle; //!< handle for syncing var |
---|
| 208 | |
---|
| 209 | std::string modelFileName; //!< model's file name |
---|
| 210 | int modelFileName_handle; //!< handle for syncing var |
---|
| 211 | |
---|
[9008] | 212 | int list_write; //!< entity's list |
---|
| 213 | int list_handle; //!< handle for list changes |
---|
[9235] | 214 | |
---|
[9110] | 215 | float health_write; |
---|
| 216 | int health_handle; |
---|
[9235] | 217 | |
---|
[9110] | 218 | float healthMax_write; |
---|
| 219 | int healthMax_handle; |
---|
[9008] | 220 | |
---|
[8190] | 221 | |
---|
| 222 | |
---|
[9869] | 223 | protected: |
---|
[8490] | 224 | Vector velocity; //!< speed of the entity |
---|
| 225 | |
---|
[2036] | 226 | }; |
---|
| 227 | |
---|
[3224] | 228 | #endif /* _WORLD_ENTITY_H */ |
---|