| 1 | /* |
|---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
|---|
| 3 | * > www.orxonox.net < |
|---|
| 4 | * |
|---|
| 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 | * |
|---|
| 22 | * Author: |
|---|
| 23 | * Andreas Büchel |
|---|
| 24 | * Co-authors: |
|---|
| 25 | * ... |
|---|
| 26 | * |
|---|
| 27 | */ |
|---|
| 28 | |
|---|
| 29 | /** |
|---|
| 30 | @file PortalLink.h |
|---|
| 31 | @brief Declaration of the PortalLink class |
|---|
| 32 | @ingroup Portals |
|---|
| 33 | */ |
|---|
| 34 | |
|---|
| 35 | #ifndef _PortalLink_H__ |
|---|
| 36 | #define _PortalLink_H__ |
|---|
| 37 | |
|---|
| 38 | #include "portals/PortalsPrereqs.h" |
|---|
| 39 | #include "tools/interfaces/Tickable.h" |
|---|
| 40 | #include "core/BaseObject.h" |
|---|
| 41 | #include "PortalEndPoint.h" |
|---|
| 42 | #include "objects/eventsystem/EventListener.h" |
|---|
| 43 | |
|---|
| 44 | #include <map> |
|---|
| 45 | |
|---|
| 46 | namespace orxonox |
|---|
| 47 | { |
|---|
| 48 | /** |
|---|
| 49 | @brief |
|---|
| 50 | A PortalLink represents the connection between two @ref orxonox::PortalEndPoint "PortalEndPoints" |
|---|
| 51 | @ingroup Portals |
|---|
| 52 | */ |
|---|
| 53 | class _PortalsExport PortalLink : public BaseObject |
|---|
| 54 | { |
|---|
| 55 | public: |
|---|
| 56 | PortalLink(BaseObject* creator); |
|---|
| 57 | virtual ~PortalLink(); |
|---|
| 58 | virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); |
|---|
| 59 | inline void setFromID(unsigned int from) //!< set the ID of the PortalEndPoint which should act as the entrance of this link |
|---|
| 60 | { |
|---|
| 61 | this->fromID_ = from; |
|---|
| 62 | } |
|---|
| 63 | inline unsigned int getFromID(unsigned int) const |
|---|
| 64 | { |
|---|
| 65 | return this->fromID_; |
|---|
| 66 | } |
|---|
| 67 | inline void setToID(unsigned int to) //!< set the ID of the PortalEndPoint which should act as the exit of this link |
|---|
| 68 | { |
|---|
| 69 | this->toID_ = to; |
|---|
| 70 | } |
|---|
| 71 | inline unsigned int getToID(unsigned int) const |
|---|
| 72 | { |
|---|
| 73 | return this->toID_; |
|---|
| 74 | } |
|---|
| 75 | /*! \brief Let an entity enter a certain PortalEndPoint |
|---|
| 76 | \param entity pointer to the entity which is entering a PortalEndPoint |
|---|
| 77 | \param entrance pointer to the PortalEndPoint to enter |
|---|
| 78 | */ |
|---|
| 79 | static void use(MobileEntity * entity, PortalEndPoint * entrance); //!< let entity enter the PortalEndPoint pointed to by entrance |
|---|
| 80 | protected: |
|---|
| 81 | private: |
|---|
| 82 | static std::map<PortalEndPoint *, PortalEndPoint *> links_s; //!< maps entrances to exits |
|---|
| 83 | unsigned int fromID_; //!< id of the entrance of this Link |
|---|
| 84 | unsigned int toID_; //!< id of the exit of this Link |
|---|
| 85 | PortalEndPoint* from_; //!< pointer to this Link's entrance |
|---|
| 86 | PortalEndPoint* to_; //!< pointer to this Link's exit |
|---|
| 87 | }; |
|---|
| 88 | } |
|---|
| 89 | |
|---|
| 90 | #endif /* _Portals_H__ */ |
|---|
