Gamedev Framework (gf)  0.19.0
A C++17 framework for 2D games
Handle.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2021 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_HANDLE_H
22 #define GF_HANDLE_H
23 
24 #include "CoreApi.h"
25 #include "Id.h"
26 
27 namespace gf {
28 #ifndef DOXYGEN_SHOULD_SKIP_THIS
29 inline namespace v1 {
30 #endif
31 
40  class GF_CORE_API Handle {
41  public:
45  Handle() = default;
46 
50  explicit Handle(Id id)
51  : m_id(id)
52  {
53  }
54 
58  template<typename T>
59  explicit Handle(T& object)
60  : m_ptr(&object)
61  {
62  }
63 
67  Id asId() const {
68  return m_id;
69  }
70 
74  template<typename T>
75  T& as() {
76  return *static_cast<T*>(m_ptr);
77  }
78 
82  template<typename T>
83  const T& as() const {
84  return *static_cast<const T*>(m_ptr);
85  }
86 
87  private:
88  union {
90  void * m_ptr;
91  };
92  };
93 
94 
95 #ifndef DOXYGEN_SHOULD_SKIP_THIS
96 }
97 #endif
98 }
99 
100 #endif // GF_HANDLE_H
void * m_ptr
Definition: Handle.h:90
Id asId() const
Get the contained id.
Definition: Handle.h:67
const T & as() const
Get the reference to the object.
Definition: Handle.h:83
Id m_id
Definition: Handle.h:89
The namespace for gf classes.
Definition: Action.h:35
uint64_t Id
An identifier.
Definition: Id.h:37
T & as()
Get the reference to the object.
Definition: Handle.h:75
A handle to an object or an id.
Definition: Handle.h:40
Handle(Id id)
Constructor with an id.
Definition: Handle.h:50
Handle(T &object)
Coonstructor with an object.
Definition: Handle.h:59