[2036] | 1 | |
---|
| 2 | |
---|
| 3 | /* |
---|
| 4 | orxonox - the future of 3D-vertical-scrollers |
---|
| 5 | |
---|
| 6 | Copyright (C) 2004 orx |
---|
| 7 | |
---|
| 8 | This program is free software; you can redistribute it and/or modify |
---|
| 9 | it under the terms of the GNU General Public License as published by |
---|
| 10 | the Free Software Foundation; either version 2, or (at your option) |
---|
| 11 | any later version. |
---|
| 12 | |
---|
| 13 | ### File Specific: |
---|
| 14 | main-programmer: Patrick Boenzli |
---|
[2190] | 15 | co-programmer: Christian Meyer |
---|
[2036] | 16 | */ |
---|
| 17 | |
---|
| 18 | #include <iostream> |
---|
| 19 | |
---|
| 20 | #include "world_entity.h" |
---|
[2190] | 21 | #include "stdincl.h" |
---|
[3474] | 22 | //#include "collision.h" |
---|
[2036] | 23 | |
---|
| 24 | using namespace std; |
---|
| 25 | |
---|
[2043] | 26 | /** |
---|
[2190] | 27 | \brief standard constructor |
---|
| 28 | |
---|
| 29 | Every derived contructor HAS to call the previous one supplying the isFree parameter. This is necessary to distunguish |
---|
| 30 | between free and bound entities. The difference between them is simply the fact that the movement of a free entity is |
---|
| 31 | not bound to the track of a world. Use this to implement projectile or effect classes that do not have to travel along the track. |
---|
| 32 | To specify an entity to be free or bound set the default parameter in the declaration of the constructor. |
---|
| 33 | Theoretically you should never have to call the constructor of an Entity directly, for it is called by the spawn() function of the World |
---|
| 34 | class. So if you want to create a new entity at any time, call World::spawn(). It will handle everything that is necessary. |
---|
[2043] | 35 | */ |
---|
[2190] | 36 | WorldEntity::WorldEntity (bool isFree) : bFree(isFree) |
---|
| 37 | { |
---|
[3365] | 38 | this->setClassName ("WorldEntity"); |
---|
[2822] | 39 | this->bDraw = true; |
---|
[3564] | 40 | this->model = NULL; |
---|
[3474] | 41 | // collisioncluster = NULL; |
---|
[2190] | 42 | } |
---|
[2043] | 43 | |
---|
| 44 | /** |
---|
[3245] | 45 | \brief standard destructor |
---|
[2043] | 46 | */ |
---|
[2190] | 47 | WorldEntity::~WorldEntity () |
---|
[2036] | 48 | { |
---|
[3474] | 49 | // if( collisioncluster != NULL) delete collisioncluster; |
---|
[2036] | 50 | |
---|
[3531] | 51 | } |
---|
| 52 | |
---|
| 53 | /** |
---|
[2822] | 54 | \brief get the Location of the WorldEntity |
---|
| 55 | \return a pointer to location |
---|
[2043] | 56 | */ |
---|
[3365] | 57 | /*PN |
---|
[3229] | 58 | Location* WorldEntity::getLocation () |
---|
[2190] | 59 | { |
---|
[2822] | 60 | return &loc; |
---|
[2190] | 61 | } |
---|
[3365] | 62 | */ |
---|
[2036] | 63 | |
---|
[2043] | 64 | /** |
---|
[2822] | 65 | \brief get the Placement of the WorldEntity |
---|
| 66 | \return a pointer to placement |
---|
[2043] | 67 | */ |
---|
[3365] | 68 | /*PN |
---|
[3229] | 69 | Placement* WorldEntity::getPlacement () |
---|
[2036] | 70 | { |
---|
[2822] | 71 | return &place; |
---|
[2036] | 72 | } |
---|
[3365] | 73 | */ |
---|
[2043] | 74 | /** |
---|
[2822] | 75 | \brief query whether the WorldEntity in question is free |
---|
| 76 | \return true if the WorldEntity is free or false if it isn't |
---|
[2043] | 77 | */ |
---|
[2190] | 78 | bool WorldEntity::isFree () |
---|
[2036] | 79 | { |
---|
[2190] | 80 | return bFree; |
---|
[2036] | 81 | } |
---|
| 82 | |
---|
[2043] | 83 | /** |
---|
[2822] | 84 | \brief set the WorldEntity's collision hull |
---|
| 85 | \param newhull: a pointer to a completely assembled CollisionCluster |
---|
| 86 | |
---|
| 87 | Any previously assigned collision hull will be deleted on reassignment |
---|
[2043] | 88 | */ |
---|
[3474] | 89 | /* |
---|
[3229] | 90 | void WorldEntity::setCollision (CollisionCluster* newhull) |
---|
[2036] | 91 | { |
---|
[2822] | 92 | if( newhull == NULL) return; |
---|
| 93 | if( collisioncluster != NULL) delete collisioncluster; |
---|
| 94 | collisioncluster = newhull; |
---|
[2036] | 95 | } |
---|
[3474] | 96 | */ |
---|
[2036] | 97 | |
---|
[2043] | 98 | /** |
---|
[2822] | 99 | \brief this method is called every frame |
---|
| 100 | \param time: the time in seconds that has passed since the last tick |
---|
| 101 | |
---|
| 102 | Handle all stuff that should update with time inside this method (movement, animation, etc.) |
---|
[2043] | 103 | */ |
---|
[2190] | 104 | void WorldEntity::tick(float time) |
---|
[2036] | 105 | { |
---|
| 106 | } |
---|
| 107 | |
---|
[3365] | 108 | |
---|
| 109 | /** |
---|
| 110 | \brief process draw function |
---|
| 111 | */ |
---|
| 112 | void WorldEntity::processDraw () |
---|
| 113 | { |
---|
| 114 | this->draw (); |
---|
| 115 | PNode* pn = this->children->enumerate (); |
---|
| 116 | while( pn != NULL) |
---|
| 117 | { |
---|
| 118 | ((WorldEntity*)pn)->processDraw (); |
---|
| 119 | pn = this->children->nextElement(); |
---|
| 120 | } |
---|
| 121 | } |
---|
| 122 | |
---|
[3449] | 123 | /** |
---|
| 124 | \brief sets the drawable state of this entity. |
---|
| 125 | \param bDraw TRUE if draweable, FALSE otherwise |
---|
| 126 | */ |
---|
[3365] | 127 | void WorldEntity::setDrawable (bool bDraw) |
---|
| 128 | { |
---|
| 129 | this->bDraw = bDraw; |
---|
| 130 | } |
---|
| 131 | |
---|
| 132 | |
---|
[2043] | 133 | /** |
---|
[2190] | 134 | \brief the entity is drawn onto the screen with this function |
---|
[2822] | 135 | |
---|
[2190] | 136 | This is a central function of an entity: call it to let the entity painted to the screen. Just override this function with whatever you want to be drawn. |
---|
[2043] | 137 | */ |
---|
[2190] | 138 | void WorldEntity::draw() |
---|
[3365] | 139 | {} |
---|
[2036] | 140 | |
---|
[2043] | 141 | /** |
---|
[2822] | 142 | \brief this function is called, when two entities collide |
---|
| 143 | \param other: the world entity with whom it collides |
---|
| 144 | \param ownhitflags: flags to the CollisionCluster subsections that registered an impact |
---|
| 145 | \param otherhitflags: flags to the CollisionCluster subsections of the other entity that registered an impact |
---|
[2043] | 146 | |
---|
[2822] | 147 | Implement behaviour like damage application or other miscellaneous collision stuff in this function |
---|
[2043] | 148 | */ |
---|
[2190] | 149 | void WorldEntity::collide(WorldEntity* other, Uint32 ownhitflags, Uint32 otherhitflags) {} |
---|
[2036] | 150 | |
---|
[2043] | 151 | /** |
---|
| 152 | \brief this function is called, when the ship is hit by a waepon |
---|
| 153 | \param weapon: the laser/rocket/shoot that hits. |
---|
| 154 | \param loc: place where it is hit |
---|
[2036] | 155 | |
---|
[2043] | 156 | calculate the damage depending |
---|
| 157 | */ |
---|
| 158 | void WorldEntity::hit(WorldEntity* weapon, Vector loc) {} |
---|
| 159 | |
---|
| 160 | |
---|
[2190] | 161 | |
---|
[2043] | 162 | /** |
---|
[2822] | 163 | \brief this is called immediately after the Entity has been constructed and initialized |
---|
| 164 | |
---|
| 165 | Put any initialisation code that requires knowledge of location (placement if the Entity is free) and owner of the entity here. |
---|
| 166 | DO NOT place such code in the constructor, those variables are set AFTER the entity is constucted. |
---|
[2043] | 167 | */ |
---|
[3229] | 168 | void WorldEntity::postSpawn () |
---|
[2190] | 169 | { |
---|
| 170 | } |
---|
[2043] | 171 | |
---|
| 172 | /** |
---|
[2822] | 173 | \brief this handles incoming command messages |
---|
| 174 | \param cmd: a pointer to the incoming Command structure |
---|
| 175 | |
---|
| 176 | Put all code that handles Command messages here, this will mainly be called by the assigned CommandNode but can also be used |
---|
| 177 | to send commands from one WorldEntity to another. |
---|
[2190] | 178 | */ |
---|
| 179 | void WorldEntity::command (Command* cmd) |
---|
| 180 | { |
---|
| 181 | } |
---|
[2043] | 182 | |
---|
[2190] | 183 | /** |
---|
[2822] | 184 | \brief this is called by the local Camera to determine the point it should look at on the WorldEntity |
---|
| 185 | \param locbuf: a pointer to the buffer to fill with a location to look at |
---|
[2190] | 186 | |
---|
[2822] | 187 | You may put any Location you want into locbuf, the Camera will determine via the corresponding Track how |
---|
| 188 | to look at the location you return with this. |
---|
[2043] | 189 | */ |
---|
[3365] | 190 | /*PN |
---|
[3229] | 191 | void WorldEntity::getLookat (Location* locbuf) |
---|
[2190] | 192 | { |
---|
| 193 | } |
---|
[3365] | 194 | */ |
---|
[2043] | 195 | |
---|
| 196 | /** |
---|
[2822] | 197 | \brief this method is called by the world if the WorldEntity leaves valid gamespace |
---|
| 198 | |
---|
| 199 | For free entities this means it left the Track boundaries. With bound entities it means its Location adresses a |
---|
| 200 | place that is not in the world anymore. In both cases you might have to take extreme measures (a.k.a. call destroy). |
---|
[2043] | 201 | */ |
---|
[3229] | 202 | void WorldEntity::leftWorld () |
---|
[2190] | 203 | { |
---|
| 204 | } |
---|