Gamedev Framework (gf)  0.19.0
A C++17 framework for 2D games
SpatialTypes.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_SPATIAL_TYPES_H
22 #define GF_SPATIAL_TYPES_H
23 
24 #include <cstddef>
25 #include <functional>
26 
27 #include "CoreApi.h"
28 #include "Handle.h"
29 #include "Rect.h"
30 
31 namespace gf {
32 #ifndef DOXYGEN_SHOULD_SKIP_THIS
33 inline namespace v1 {
34 #endif
35 
42  enum SpatialId : std::size_t { };
43 
50  enum class SpatialStructureType {
51  Object,
52  Node,
53  };
54 
63  struct GF_CORE_API SpatialStructure {
66  int level;
67  };
68 
73  enum class SpatialQuery {
74  Contain,
75  Intersect,
76  };
77 
82  using SpatialQueryCallback = std::function<void(Handle)>;
83 
84 
85 #ifndef DOXYGEN_SHOULD_SKIP_THIS
86 }
87 #endif
88 }
89 
90 #endif // GF_SPATIAL_TYPES_H
The structure represents an internal node.
SpatialQuery
A kind of spatial query.
Definition: SpatialTypes.h:73
SpatialStructureType
A type of spatial structure.
Definition: SpatialTypes.h:50
SpatialId
A spatial id.
Definition: SpatialTypes.h:42
The structure represents an actuel object.
int level
The level of the structure.
Definition: SpatialTypes.h:66
A spatial structure.
Definition: SpatialTypes.h:63
Search for all objects that intersect the given bounds.
Search for all objects that contain the given bounds.
RectF bounds
The bounds of the structure.
Definition: SpatialTypes.h:64
The namespace for gf classes.
Definition: Action.h:35
std::function< void(Handle)> SpatialQueryCallback
A callback for spatial query.
Definition: SpatialTypes.h:82
SpatialStructureType type
The type of the structure.
Definition: SpatialTypes.h:65