/* * ORXONOX - the hottest 3D action shooter ever to exist * > www.orxonox.net < * * * License notice: * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * Author: * Yuning Chai * Felix Schulthess * Co-authors: * Reto Grieder * Wolfgang Roenninger * */ #include "HUDRadar.h" #if OGRE_VERSION >= 0x010900 # include # include #else # include # include #endif #include "util/Math.h" #include "util/StringUtils.h" #include "core/CoreIncludes.h" #include "core/XMLPort.h" #include "tools/TextureGenerator.h" #include "worldentities/ControllableEntity.h" #include "Scene.h" #include "Radar.h" #include "core/config/ConfigValueIncludes.h" namespace orxonox { RegisterClass(HUDRadar); HUDRadar::HUDRadar(Context* context) : OrxonoxOverlay(context) { RegisterObject(HUDRadar); this->setConfigValues(); this->marker_ = static_cast(Ogre::OverlayManager::getSingleton() .createOverlayElement("Panel", "HUDRadar_marker_" + getUniqueNumberString())); this->marker_->setMaterialName("Orxonox/RadarMarker"); this->overlay_->add2D(this->marker_); this->marker_->hide(); this->setRadarSensitivity(1.0f); this->setHalfDotSizeDistance(3000.0f); this->setMaximumDotSize(0.1f); this->setMaximumDotSize3D(0.07f); this->shapeMaterials_[RadarViewable::Shape::Dot] = "RadarDot.png"; this->shapeMaterials_[RadarViewable::Shape::Triangle] = "RadarTriangle.png"; this->shapeMaterials_[RadarViewable::Shape::Square] = "RadarSquare.png"; this->owner_ = nullptr; this->map3DFront_ = static_cast(Ogre::OverlayManager::getSingleton() .createOverlayElement("Panel", "HUDRadar_mapDreiDFront_" + getUniqueNumberString())); this->map3DFront_->setMaterialName("Orxonox/Radar3DFront"); this->overlay_->add2D(this->map3DFront_); this->map3DFront_->hide(); this->map3DBack_ = static_cast(Ogre::OverlayManager::getSingleton() .createOverlayElement("Panel", "HUDRadar_mapDreiDBack_" + getUniqueNumberString())); this->map3DBack_->setMaterialName("Orxonox/Radar3DBack"); this->overlay_->add2D(this->map3DBack_); this->map3DBack_->hide(); } HUDRadar::~HUDRadar() { if (this->isInitialized()) { Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->marker_); Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->map3DFront_); Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->map3DBack_); for (const auto& mapEntry : this->radarObjects_) { Ogre::OverlayManager::getSingleton().destroyOverlayElement(mapEntry.second); } } } void HUDRadar::setConfigValues() { SetConfigValue(RadarMode_, true); } void HUDRadar::XMLPort(Element& xmlelement, XMLPort::Mode mode) { SUPER(HUDRadar, XMLPort, xmlelement, mode); XMLPortParam(HUDRadar, "sensitivity", setRadarSensitivity, getRadarSensitivity, xmlelement, mode); XMLPortParam(HUDRadar, "halfDotSizeDistance", setHalfDotSizeDistance, getHalfDotSizeDistance, xmlelement, mode); XMLPortParam(HUDRadar, "maximumDotSize", setMaximumDotSize, getMaximumDotSize, xmlelement, mode); XMLPortParam(HUDRadar, "maximumDotSize3D", setMaximumDotSize3D, getMaximumDotSize3D, xmlelement, mode); XMLPortParam(HUDRadar, "material2D", set2DMaterial, get2DMaterial, xmlelement, mode); XMLPortParam(HUDRadar, "material3DMiddle", set3DMaterial, get3DMaterial, xmlelement, mode); XMLPortParam(HUDRadar, "material3DFront", set3DMaterialFront, get3DMaterialFront, xmlelement, mode); XMLPortParam(HUDRadar, "material3DBack", set3DMaterialBack, get3DMaterialBack, xmlelement, mode); XMLPortParam(HUDRadar, "mapAngle3D", setMapAngle, getMapAngle, xmlelement, mode); XMLPortParam(HUDRadar, "detectionLimit", setDetectionLimit, getDetectionLimit, xmlelement, mode); } void HUDRadar::addObject(RadarViewable* object) { if (object == orxonox_cast(this->owner_)) return; if( showObject(object) == false ) //do not show objects that are "invisible" or "radar invisible" return; // Make sure the object hasn't been added yet assert( this->radarObjects_.find(object) == this->radarObjects_.end() ); // Create everything needed to display the object on the radar and add it to the map Ogre::PanelOverlayElement* panel; panel = static_cast( Ogre::OverlayManager::getSingleton().createOverlayElement("Panel", "RadarDot" + getUniqueNumberString())); this->overlay_->add2D(panel); // get right material panel->setMaterialName(TextureGenerator::getMaterialName( shapeMaterials_[object->getRadarObjectShape()], object->getRadarObjectColour())); panel->hide(); this->radarObjects_[object] = panel; } void HUDRadar::removeObject(RadarViewable* object) { // If object was added at all then remove it std::map::iterator it; it = this->radarObjects_.find( object ); if( it != this->radarObjects_.end() ) { Ogre::OverlayManager::getSingleton().destroyOverlayElement(it->second); this->radarObjects_.erase(it); } } void HUDRadar::objectChanged( RadarViewable* rv ) {// The new implementation behaves more precisely, since inactive RadarViewables are not displayed anymore. this->removeObject(rv); this->addObject(rv); } void HUDRadar::gatherObjects() { const std::set& objectSet = this->getCreator()->getScene()->getRadar()->getRadarObjects(); for( RadarViewable* viewable : objectSet ) this->addObject(viewable); this->radarTick(0); } void HUDRadar::radarTick(float dt) { // Make sure the owner of the radar was defined if( !this->owner_ ) return; this->marker_->hide(); // in case that no object is in focus // get the focus object Radar* radar = this->getOwner()->getScene()->getRadar(); const RadarViewable* focusObject = radar->getFocus(); // update the distances for all objects if(RadarMode_) { this->setBackgroundMaterial(material3D_); this->map3DFront_->_notifyZOrder(this->overlay_->getZOrder() * 100 + 250); // it seems that the ZOrder of overlayelements is 100 times the ZOrder of the overlay 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 this->map3DFront_->show(); this->map3DBack_->show(); } else { this->setBackgroundMaterial(material2D_); this->map3DFront_->hide(); this->map3DBack_->hide(); } for( const auto& mapEntry : this->radarObjects_ ) { // Make sure the object really is a WorldEntity const WorldEntity* wePointer = mapEntry.first->getWorldEntity(); if( !wePointer ) { orxout(internal_error) << "Cannot display a non-WorldEntitiy on the radar" << endl; assert(0); } bool isFocus = (mapEntry.first == focusObject); // set size to fit distance... float distance = (wePointer->getWorldPosition() - this->owner_->getPosition()).length(); // calculate the size with 1/distance dependency for simplicity (instead of exp(-distance * lambda) float size; if(RadarMode_) size = maximumDotSize3D_ * halfDotSizeDistance_ / (halfDotSizeDistance_ + distance) * mapEntry.first->getRadarObjectScale(); else size = maximumDotSize_ * halfDotSizeDistance_ / (halfDotSizeDistance_ + distance) * mapEntry.first->getRadarObjectScale(); mapEntry.second->setDimensions(size, size); // calc position on radar... Vector2 coord; if(RadarMode_) { coord = get3DProjection(this->owner_->getPosition(), this->owner_->getOrientation() * WorldEntity::FRONT, this->owner_->getOrientation() * WorldEntity::UP, wePointer->getWorldPosition(), 0.6435011, detectionLimit_); // set zOrder on screen bool overXZPlain = isObjectHigherThanShipOnMap(this->owner_->getPosition(), this->owner_->getOrientation() * WorldEntity::FRONT, this->owner_->getOrientation() * WorldEntity::UP, wePointer->getWorldPosition(), this->mapAngle_); int zOrder = determineMap3DZOrder(this->owner_->getPosition(), this->owner_->getOrientation() * WorldEntity::FRONT, this->owner_->getOrientation() * WorldEntity::UP, wePointer->getWorldPosition(), detectionLimit_); 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 mapEntry.second->_notifyZOrder(this->overlay_->getZOrder() * 100 - 70 + zOrder); if(overXZPlain == true /*&& (it->second->getZOrder() <= 100 * this->overlay_->getZOrder())*/) mapEntry.second->_notifyZOrder(this->overlay_->getZOrder() * 100 + 70 + zOrder); } else coord = get2DViewCoordinates(this->owner_->getPosition(), this->owner_->getOrientation() * WorldEntity::FRONT, this->owner_->getOrientation() * WorldEntity::UP, wePointer->getWorldPosition()); coord *= math::pi / 3.5f; // small adjustment to make it fit the texture mapEntry.second->setPosition((1.0f + coord.x - size) * 0.5f, (1.0f - coord.y - size) * 0.5f); if( distance < detectionLimit_ || detectionLimit_ < 0 ) mapEntry.second->show(); else mapEntry.second->hide(); // if this object is in focus, then set the focus marker if (isFocus) { this->marker_->setDimensions(size * 1.5f, size * 1.5f); this->marker_->setPosition((1.0f + coord.x - size * 1.5f) * 0.5f, (1.0f - coord.y - size * 1.5f) * 0.5f); if(RadarMode_) this->marker_->_notifyZOrder(mapEntry.second->getZOrder() -1); this->marker_->show(); } } } bool HUDRadar::showObject(RadarViewable* rv) { if ( rv == orxonox_cast ( this->getOwner() ) ) return false; assert( rv->getWorldEntity() ); if ( rv->getWorldEntity()->isVisible()==false || rv->getRadarVisibility()==false ) return false; return true; } void HUDRadar::changedOwner() { SUPER(HUDRadar, changedOwner); this->owner_ = orxonox_cast(this->getOwner()); assert(this->radarObjects_.size() == 0); this->gatherObjects(); } }