PortalEndPoint.h

Go to the documentation of this file.

/*
 *   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:
 *      Andreas Büchel
 *   Co-authors:
 *      ...
 *
 */

#ifndef _PortalEndPoint_H__
#define _PortalEndPoint_H__

#include "portals/PortalsPrereqs.h"

#include <map>
#include <set>
#include <string>

#include "core/EventIncludes.h"

#include "worldentities/StaticEntity.h"
#include "interfaces/RadarViewable.h"
#include "objects/triggers/DistanceMultiTrigger.h"

namespace orxonox
{
    class _PortalsExport PortalEndPoint : public StaticEntity, public RadarViewable
    {
        public:
            PortalEndPoint(Context* context);
            virtual ~PortalEndPoint();

            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;
            virtual void changedActivity(void) override;

            inline void setTarget(const std::string & target)                 
                { this->trigger_->addTarget(target); }

            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode) override;
            static std::map<unsigned int, PortalEndPoint *> idMap_s; 
            inline void setReenterDelay(unsigned int seconds)
                { this->reenterDelay_ = seconds; }
            inline unsigned int getReenterDelay()
                { return this->reenterDelay_; }
            inline void setID(unsigned int id)
                { this->id_ = id; }

            inline unsigned int getID() const
                { return this->id_; }

            inline void setTemplate(const std::string & name)
                { this->templateName_ = name; this->addTemplate(name); }

            inline const std::string & getTemplate()
                { return this->templateName_; }

            bool execute(bool bTriggered, BaseObject* trigger);

            void jumpOut(MobileEntity * entity);

            bool letsEnter(MobileEntity* entity);
        protected:

        private:
            static const std::string EVENTFUNCTIONNAME; 

            unsigned int id_;            
            DistanceMultiTrigger * trigger_;      
            std::string templateName_;            

            int reenterDelay_;
            std::map<MobileEntity *, time_t> jumpOutTimes_;   
            std::set<MobileEntity *> recentlyJumpedOut_;   

            WorldSound* portalSound_;
    };

}

#endif /* _Portals_H__ */