Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/portals/PortalLink.h @ 11071

Last change on this file since 11071 was 11071, checked in by landauf, 8 years ago

merged branch cpp11_v3 back to trunk

  • Property svn:eol-style set to native
File size: 3.0 KB
Line 
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
40#include <map>
41
42#include "PortalEndPoint.h"
43
44#include "core/BaseObject.h"
45
46namespace 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(Context* context);
57            virtual ~PortalLink();
58            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;
59
60            inline void setFromID(unsigned int from)    //!< set the ID of the PortalEndPoint which should act as the entrance of this link
61                { this->fromID_ = from; }
62            inline unsigned int getFromID(unsigned int) const
63                { return this->fromID_; }
64            inline void setToID(unsigned int to)     //!< set the ID of the PortalEndPoint which should act as the exit of this link
65                { this->toID_ = to; }
66            inline unsigned int getToID(unsigned int) const
67                { return this->toID_; }
68            /*! \brief Let an entity enter a certain PortalEndPoint
69                \param entity pointer to the entity which is entering a PortalEndPoint
70                \param entrance pointer to the PortalEndPoint to enter
71             */
72            static void use(MobileEntity * entity, PortalEndPoint * entrance);   //!< let entity enter the PortalEndPoint pointed to by entrance
73        protected:
74        private:
75            static std::map<PortalEndPoint *, PortalEndPoint *> links_s;   //!< maps entrances to exits
76            unsigned int fromID_;   //!< id of the entrance of this Link
77            unsigned int toID_;   //!< id of the exit of this Link
78            PortalEndPoint* from_;   //!< pointer to this Link's entrance
79            PortalEndPoint* to_;   //!< pointer to this Link's exit
80    };
81}
82
83#endif /* _Portals_H__ */
Note: See TracBrowser for help on using the repository browser.