Gamedev Framework (gf)  0.17.0
A C++14 framework for 2D games
spatial/Types.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2019 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 <gf/Handle.h>
28 #include <gf/Rect.h>
29 
30 namespace gf {
31 #ifndef DOXYGEN_SHOULD_SKIP_THIS
32 inline namespace v1 {
33 #endif
34 
41  enum SpatialId : std::size_t { };
42 
49  enum class SpatialStructureType {
50  Object,
51  Node,
52  };
53 
65  int level;
66  };
67 
72  enum class SpatialQuery {
73  Contain,
74  Intersect,
75  };
76 
81  using SpatialQueryCallback = std::function<void(Handle)>;
82 
83 
84 #ifndef DOXYGEN_SHOULD_SKIP_THIS
85 }
86 #endif
87 }
88 
89 #endif // GF_SPATIAL_TYPES_H
The structure represents an internal node.
SpatialStructureType
A type of spatial structure.
Definition: spatial/Types.h:49
int level
The level of the structure.
Definition: spatial/Types.h:65
Search for all objects that contain the given bounds.
std::function< void(Handle)> SpatialQueryCallback
A callback for spatial query.
Definition: spatial/Types.h:81
A spatial structure.
Definition: spatial/Types.h:62
SpatialId
A spatial id.
Definition: spatial/Types.h:41
Search for all objects that intersect the given bounds.
RectF bounds
The bounds of the structure.
Definition: spatial/Types.h:63
The namespace for gf classes.
Definition: Action.h:35
The structure represents an actuel object.
SpatialQuery
A kind of spatial query.
Definition: spatial/Types.h:72
SpatialStructureType type
The type of the structure.
Definition: spatial/Types.h:64