[7196] | 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 | * Fabian 'x3n' Landau |
---|
| 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
[7401] | 29 | /** |
---|
| 30 | @file |
---|
| 31 | @ingroup Command FunctorExecutor |
---|
| 32 | @brief Typedefs and definitions of FunctorPtr, FunctorMemberPtr, FunctorStaticPtr, and FunctorPointerPtr |
---|
| 33 | |
---|
[11071] | 34 | Instances of orxonox::Functor are usually managed by an std::shared_ptr. This ensures |
---|
[7401] | 35 | that Functors will be destroyed after usage. To make things easier, there's a typedef |
---|
[11071] | 36 | that defines FunctorPtr as std::shared_ptr<Functor>. |
---|
[7401] | 37 | |
---|
| 38 | Because there's not only orxonox::Functor, but also orxonox::FunctorStatic, and |
---|
| 39 | orxonox::FunctorMember, the shared pointers need to store them all and also reflect |
---|
| 40 | their hierarchy - FunctorStatic and FunctorMember should not be mixed, but both can |
---|
| 41 | be converted to Functor. This is achieved by using orxonox::SharedChildPtr. |
---|
| 42 | |
---|
| 43 | Because it's not possible to use a typedef for a template, we have to define the |
---|
| 44 | helper class FunctorMemberPtr<T> that makes it easier to use FunctorMember. The |
---|
| 45 | same is also done for FunctorPointerPtr<T>, which can be converted to both, |
---|
| 46 | FunctorMemberPtr<T> as well as FunctorPtr. |
---|
| 47 | */ |
---|
| 48 | |
---|
[7196] | 49 | #ifndef _FunctorPtr_H__ |
---|
| 50 | #define _FunctorPtr_H__ |
---|
| 51 | |
---|
[7203] | 52 | #include "core/CorePrereqs.h" |
---|
[11071] | 53 | #include <memory> |
---|
[7196] | 54 | |
---|
| 55 | namespace orxonox |
---|
| 56 | { |
---|
[11071] | 57 | using FunctorPtr = std::shared_ptr<Functor>; |
---|
[7196] | 58 | template <class T> |
---|
[11071] | 59 | using FunctorMemberPtr = std::shared_ptr<FunctorMember<T>>; |
---|
| 60 | using FunctorStaticPtr = std::shared_ptr<FunctorMember<void>>; |
---|
[7212] | 61 | template <class F, class T> |
---|
[11071] | 62 | using FunctorPointerPtr = std::shared_ptr<FunctorPointer<F, T>>; |
---|
[7196] | 63 | } |
---|
| 64 | |
---|
| 65 | #endif /* _FunctorPtr_H__ */ |
---|