[1505] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * > www.orxonox.net < |
---|
[1502] | 4 | * |
---|
[1505] | 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
[1502] | 22 | * Author: |
---|
| 23 | * Yuning Chai |
---|
[1614] | 24 | * Felix Schulthess |
---|
[1502] | 25 | * Co-authors: |
---|
[1614] | 26 | * Reto Grieder |
---|
[9939] | 27 | * Wolfgang Roenninger |
---|
[1502] | 28 | * |
---|
| 29 | */ |
---|
[1283] | 30 | |
---|
[1604] | 31 | #include "HUDRadar.h" |
---|
[1283] | 32 | |
---|
[1502] | 33 | #include <OgreOverlayManager.h> |
---|
[1614] | 34 | #include <OgrePanelOverlayElement.h> |
---|
[1502] | 35 | |
---|
[1614] | 36 | #include "util/Math.h" |
---|
[3280] | 37 | #include "util/StringUtils.h" |
---|
[1616] | 38 | #include "core/CoreIncludes.h" |
---|
| 39 | #include "core/XMLPort.h" |
---|
[3196] | 40 | #include "tools/TextureGenerator.h" |
---|
[7880] | 41 | #include "worldentities/ControllableEntity.h" |
---|
[7163] | 42 | #include "Scene.h" |
---|
| 43 | #include "Radar.h" |
---|
[9939] | 44 | #include "core/config/ConfigValueIncludes.h" |
---|
[1502] | 45 | |
---|
[1283] | 46 | namespace orxonox |
---|
| 47 | { |
---|
[9667] | 48 | RegisterClass(HUDRadar); |
---|
[1604] | 49 | |
---|
[9667] | 50 | HUDRadar::HUDRadar(Context* context) |
---|
| 51 | : OrxonoxOverlay(context) |
---|
[1604] | 52 | { |
---|
| 53 | RegisterObject(HUDRadar); |
---|
[9939] | 54 | this->setConfigValues(); |
---|
[2087] | 55 | |
---|
[2662] | 56 | this->marker_ = static_cast<Ogre::PanelOverlayElement*>(Ogre::OverlayManager::getSingleton() |
---|
[2087] | 57 | .createOverlayElement("Panel", "HUDRadar_marker_" + getUniqueNumberString())); |
---|
[2662] | 58 | this->marker_->setMaterialName("Orxonox/RadarMarker"); |
---|
| 59 | this->overlay_->add2D(this->marker_); |
---|
| 60 | this->marker_->hide(); |
---|
[2087] | 61 | |
---|
[2662] | 62 | this->setRadarSensitivity(1.0f); |
---|
| 63 | this->setHalfDotSizeDistance(3000.0f); |
---|
| 64 | this->setMaximumDotSize(0.1f); |
---|
[9939] | 65 | this->setMaximumDotSize3D(0.07f); |
---|
[2087] | 66 | |
---|
[7368] | 67 | this->shapeMaterials_[RadarViewable::Dot] = "RadarDot.png"; |
---|
| 68 | this->shapeMaterials_[RadarViewable::Triangle] = "RadarTriangle.png"; |
---|
| 69 | this->shapeMaterials_[RadarViewable::Square] = "RadarSquare.png"; |
---|
[2662] | 70 | this->owner_ = 0; |
---|
[9939] | 71 | |
---|
| 72 | this->map3DFront_ = static_cast<Ogre::PanelOverlayElement*>(Ogre::OverlayManager::getSingleton() |
---|
[9945] | 73 | .createOverlayElement("Panel", "HUDRadar_mapDreiDFront_" + getUniqueNumberString())); |
---|
[9939] | 74 | this->map3DFront_->setMaterialName("Orxonox/Radar3DFront"); |
---|
| 75 | this->overlay_->add2D(this->map3DFront_); |
---|
| 76 | this->map3DFront_->hide(); |
---|
| 77 | |
---|
| 78 | this->map3DBack_ = static_cast<Ogre::PanelOverlayElement*>(Ogre::OverlayManager::getSingleton() |
---|
[9945] | 79 | .createOverlayElement("Panel", "HUDRadar_mapDreiDBack_" + getUniqueNumberString())); |
---|
[9939] | 80 | this->map3DBack_->setMaterialName("Orxonox/Radar3DBack"); |
---|
| 81 | this->overlay_->add2D(this->map3DBack_); |
---|
| 82 | this->map3DBack_->hide(); |
---|
| 83 | |
---|
[1302] | 84 | } |
---|
[1283] | 85 | |
---|
[1604] | 86 | HUDRadar::~HUDRadar() |
---|
| 87 | { |
---|
[2087] | 88 | if (this->isInitialized()) |
---|
| 89 | { |
---|
[1615] | 90 | Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->marker_); |
---|
[9939] | 91 | Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->map3DFront_); |
---|
| 92 | Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->map3DBack_); |
---|
| 93 | |
---|
[7163] | 94 | for (std::map<RadarViewable*,Ogre::PanelOverlayElement*>::iterator it = this->radarObjects_.begin(); |
---|
| 95 | it != this->radarObjects_.end(); ++it) |
---|
[2087] | 96 | { |
---|
[7163] | 97 | Ogre::OverlayManager::getSingleton().destroyOverlayElement(it->second); |
---|
[2087] | 98 | } |
---|
[1604] | 99 | } |
---|
[1302] | 100 | } |
---|
[1283] | 101 | |
---|
[9939] | 102 | |
---|
| 103 | |
---|
| 104 | void HUDRadar::setConfigValues() |
---|
| 105 | { |
---|
| 106 | SetConfigValue(RadarMode_, true); |
---|
| 107 | } |
---|
| 108 | |
---|
[7401] | 109 | void HUDRadar::XMLPort(Element& xmlelement, XMLPort::Mode mode) |
---|
[1604] | 110 | { |
---|
[7401] | 111 | SUPER(HUDRadar, XMLPort, xmlelement, mode); |
---|
[1283] | 112 | |
---|
[7401] | 113 | XMLPortParam(HUDRadar, "sensitivity", setRadarSensitivity, getRadarSensitivity, xmlelement, mode); |
---|
| 114 | XMLPortParam(HUDRadar, "halfDotSizeDistance", setHalfDotSizeDistance, getHalfDotSizeDistance, xmlelement, mode); |
---|
| 115 | XMLPortParam(HUDRadar, "maximumDotSize", setMaximumDotSize, getMaximumDotSize, xmlelement, mode); |
---|
[9939] | 116 | XMLPortParam(HUDRadar, "maximumDotSize3D", setMaximumDotSize3D, getMaximumDotSize3D, xmlelement, mode); |
---|
| 117 | XMLPortParam(HUDRadar, "material2D", set2DMaterial, get2DMaterial, xmlelement, mode); |
---|
| 118 | XMLPortParam(HUDRadar, "material3DMiddle", set3DMaterial, get3DMaterial, xmlelement, mode); |
---|
| 119 | XMLPortParam(HUDRadar, "material3DFront", set3DMaterialFront, get3DMaterialFront, xmlelement, mode); |
---|
| 120 | XMLPortParam(HUDRadar, "material3DBack", set3DMaterialBack, get3DMaterialBack, xmlelement, mode); |
---|
| 121 | XMLPortParam(HUDRadar, "mapAngle3D", setMapAngle, getMapAngle, xmlelement, mode); |
---|
| 122 | XMLPortParam(HUDRadar, "detectionLimit", setDetectionLimit, getDetectionLimit, xmlelement, mode); |
---|
[1609] | 123 | } |
---|
[1302] | 124 | |
---|
[7163] | 125 | void HUDRadar::addObject(RadarViewable* object) |
---|
[1604] | 126 | { |
---|
[9348] | 127 | if (object == orxonox_cast<RadarViewable*>(this->owner_)) |
---|
[2662] | 128 | return; |
---|
[8891] | 129 | if( showObject(object) == false ) //do not show objects that are "invisible" or "radar invisible" |
---|
| 130 | return; |
---|
[2662] | 131 | |
---|
[7163] | 132 | // Make sure the object hasn't been added yet |
---|
| 133 | assert( this->radarObjects_.find(object) == this->radarObjects_.end() ); |
---|
[1604] | 134 | |
---|
[7163] | 135 | // Create everything needed to display the object on the radar and add it to the map |
---|
| 136 | Ogre::PanelOverlayElement* panel; |
---|
| 137 | panel = static_cast<Ogre::PanelOverlayElement*>( |
---|
| 138 | Ogre::OverlayManager::getSingleton().createOverlayElement("Panel", "RadarDot" + getUniqueNumberString())); |
---|
| 139 | this->overlay_->add2D(panel); |
---|
| 140 | // get right material |
---|
| 141 | panel->setMaterialName(TextureGenerator::getMaterialName( |
---|
| 142 | shapeMaterials_[object->getRadarObjectShape()], object->getRadarObjectColour())); |
---|
[8738] | 143 | panel->hide(); |
---|
[7163] | 144 | this->radarObjects_[object] = panel; |
---|
| 145 | } |
---|
| 146 | |
---|
| 147 | void HUDRadar::removeObject(RadarViewable* object) |
---|
| 148 | { |
---|
| 149 | // If object was added at all then remove it |
---|
| 150 | std::map<RadarViewable*,Ogre::PanelOverlayElement*>::iterator it; |
---|
| 151 | it = this->radarObjects_.find( object ); |
---|
| 152 | if( it != this->radarObjects_.end() ) |
---|
[1609] | 153 | { |
---|
[7163] | 154 | Ogre::OverlayManager::getSingleton().destroyOverlayElement(it->second); |
---|
| 155 | this->radarObjects_.erase(it); |
---|
[1609] | 156 | } |
---|
[7163] | 157 | } |
---|
[2662] | 158 | |
---|
[7163] | 159 | void HUDRadar::objectChanged( RadarViewable* rv ) |
---|
[8891] | 160 | {// The new implementation behaves more precisely, since inactive RadarViewables are not displayed anymore. |
---|
| 161 | this->removeObject(rv); |
---|
| 162 | this->addObject(rv); |
---|
[7163] | 163 | } |
---|
| 164 | |
---|
| 165 | void HUDRadar::gatherObjects() |
---|
| 166 | { |
---|
| 167 | const std::set<RadarViewable*>& objectSet = this->getCreator()->getScene()->getRadar()->getRadarObjects(); |
---|
| 168 | std::set<RadarViewable*>::const_iterator it; |
---|
| 169 | for( it=objectSet.begin(); it!=objectSet.end(); ++it ) |
---|
| 170 | this->addObject(*it); |
---|
[8737] | 171 | this->radarTick(0); |
---|
[7163] | 172 | } |
---|
| 173 | |
---|
| 174 | void HUDRadar::radarTick(float dt) |
---|
| 175 | { |
---|
| 176 | // Make sure the owner of the radar was defined |
---|
| 177 | if( !this->owner_ ) |
---|
[7880] | 178 | return; |
---|
[7163] | 179 | |
---|
| 180 | this->marker_->hide(); // in case that no object is in focus |
---|
| 181 | // get the focus object |
---|
| 182 | Radar* radar = this->getOwner()->getScene()->getRadar(); |
---|
| 183 | const RadarViewable* focusObject = radar->getFocus(); |
---|
| 184 | |
---|
| 185 | // update the distances for all objects |
---|
| 186 | std::map<RadarViewable*,Ogre::PanelOverlayElement*>::iterator it; |
---|
[9939] | 187 | |
---|
| 188 | |
---|
| 189 | if(RadarMode_) |
---|
| 190 | { |
---|
[9945] | 191 | this->setBackgroundMaterial(material3D_); |
---|
| 192 | this->map3DFront_->_notifyZOrder(this->overlay_->getZOrder() * 100 + 250); // it seems that the ZOrder of overlayelements is 100 times the ZOrder of the overlay |
---|
| 193 | this->map3DBack_->_notifyZOrder(this->overlay_->getZOrder() * 100 - 250); // 250 a little bit buffer so that the two shels are displayed all in the front / in the back |
---|
| 194 | this->map3DFront_->show(); |
---|
| 195 | this->map3DBack_->show(); |
---|
[9939] | 196 | } |
---|
| 197 | else |
---|
| 198 | { |
---|
[9945] | 199 | this->setBackgroundMaterial(material2D_); |
---|
| 200 | this->map3DFront_->hide(); |
---|
| 201 | this->map3DBack_->hide(); |
---|
[9939] | 202 | } |
---|
| 203 | |
---|
[7163] | 204 | for( it = this->radarObjects_.begin(); it != this->radarObjects_.end(); ++it ) |
---|
[1614] | 205 | { |
---|
[7163] | 206 | // Make sure the object really is a WorldEntity |
---|
| 207 | const WorldEntity* wePointer = it->first->getWorldEntity(); |
---|
| 208 | if( !wePointer ) |
---|
| 209 | { |
---|
[8858] | 210 | orxout(internal_error) << "Cannot display a non-WorldEntitiy on the radar" << endl; |
---|
[7163] | 211 | assert(0); |
---|
| 212 | } |
---|
| 213 | bool isFocus = (it->first == focusObject); |
---|
| 214 | // set size to fit distance... |
---|
| 215 | float distance = (wePointer->getWorldPosition() - this->owner_->getPosition()).length(); |
---|
| 216 | // calculate the size with 1/distance dependency for simplicity (instead of exp(-distance * lambda) |
---|
[9939] | 217 | |
---|
| 218 | float size; |
---|
| 219 | if(RadarMode_) |
---|
[9945] | 220 | size = maximumDotSize3D_ * halfDotSizeDistance_ / (halfDotSizeDistance_ + distance) * it->first->getRadarObjectScale(); |
---|
[9939] | 221 | else |
---|
[9945] | 222 | size = maximumDotSize_ * halfDotSizeDistance_ / (halfDotSizeDistance_ + distance) * it->first->getRadarObjectScale(); |
---|
[7163] | 223 | it->second->setDimensions(size, size); |
---|
[2662] | 224 | |
---|
[7163] | 225 | // calc position on radar... |
---|
[9939] | 226 | Vector2 coord; |
---|
| 227 | |
---|
| 228 | if(RadarMode_) |
---|
| 229 | { |
---|
[9945] | 230 | coord = get3DProjection(this->owner_->getPosition(), this->owner_->getOrientation() * WorldEntity::FRONT, this->owner_->getOrientation() * WorldEntity::UP, wePointer->getWorldPosition(), 0.6435011, detectionLimit_); |
---|
[9939] | 231 | |
---|
[9945] | 232 | // set zOrder on screen |
---|
| 233 | bool overXZPlain = isObjectHigherThanShipOnMap(this->owner_->getPosition(), this->owner_->getOrientation() * WorldEntity::FRONT, this->owner_->getOrientation() * WorldEntity::UP, wePointer->getWorldPosition(), this->mapAngle_); |
---|
[9939] | 234 | |
---|
[9945] | 235 | int zOrder = determineMap3DZOrder(this->owner_->getPosition(), this->owner_->getOrientation() * WorldEntity::FRONT, this->owner_->getOrientation() * WorldEntity::UP, wePointer->getWorldPosition(), detectionLimit_); |
---|
| 236 | if(overXZPlain == false /*&& (it->second->getZOrder() > 100 * this->overlay_->getZOrder())*/) // it appears that zOrder of attached Overlayelements is 100 times the zOrder of the Overlay |
---|
| 237 | it->second->_notifyZOrder(this->overlay_->getZOrder() * 100 - 70 + zOrder); |
---|
| 238 | if(overXZPlain == true /*&& (it->second->getZOrder() <= 100 * this->overlay_->getZOrder())*/) |
---|
| 239 | it->second->_notifyZOrder(this->overlay_->getZOrder() * 100 + 70 + zOrder); |
---|
[9939] | 240 | } |
---|
| 241 | else |
---|
[10970] | 242 | coord = get2DViewCoordinates(this->owner_->getPosition(), this->owner_->getOrientation() * WorldEntity::FRONT, this->owner_->getOrientation() * WorldEntity::UP, wePointer->getWorldPosition()); |
---|
[9939] | 243 | |
---|
[7184] | 244 | coord *= math::pi / 3.5f; // small adjustment to make it fit the texture |
---|
[7163] | 245 | it->second->setPosition((1.0f + coord.x - size) * 0.5f, (1.0f - coord.y - size) * 0.5f); |
---|
[9939] | 246 | |
---|
[8891] | 247 | if( distance < detectionLimit_ || detectionLimit_ < 0 ) |
---|
| 248 | it->second->show(); |
---|
| 249 | else |
---|
| 250 | it->second->hide(); |
---|
[1613] | 251 | |
---|
[7163] | 252 | // if this object is in focus, then set the focus marker |
---|
| 253 | if (isFocus) |
---|
| 254 | { |
---|
| 255 | this->marker_->setDimensions(size * 1.5f, size * 1.5f); |
---|
| 256 | this->marker_->setPosition((1.0f + coord.x - size * 1.5f) * 0.5f, (1.0f - coord.y - size * 1.5f) * 0.5f); |
---|
[9939] | 257 | if(RadarMode_) |
---|
[9945] | 258 | this->marker_->_notifyZOrder(it->second->getZOrder() -1); |
---|
[7163] | 259 | this->marker_->show(); |
---|
| 260 | } |
---|
[1613] | 261 | } |
---|
[1604] | 262 | } |
---|
| 263 | |
---|
[8891] | 264 | bool HUDRadar::showObject(RadarViewable* rv) |
---|
| 265 | { |
---|
[9348] | 266 | if ( rv == orxonox_cast<RadarViewable*> ( this->getOwner() ) ) |
---|
[8891] | 267 | return false; |
---|
| 268 | assert( rv->getWorldEntity() ); |
---|
| 269 | if ( rv->getWorldEntity()->isVisible()==false || rv->getRadarVisibility()==false ) |
---|
| 270 | return false; |
---|
| 271 | return true; |
---|
| 272 | } |
---|
| 273 | |
---|
| 274 | |
---|
[2662] | 275 | void HUDRadar::changedOwner() |
---|
| 276 | { |
---|
[7880] | 277 | SUPER(HUDRadar, changedOwner); |
---|
[2662] | 278 | |
---|
[7880] | 279 | this->owner_ = orxonox_cast<ControllableEntity*>(this->getOwner()); |
---|
| 280 | assert(this->radarObjects_.size() == 0); |
---|
| 281 | this->gatherObjects(); |
---|
| 282 | } |
---|
[1283] | 283 | } |
---|