1 /*************************************************************************/
2 /*  broad_phase_sw.h                                                     */
3 /*************************************************************************/
4 /*                       This file is part of:                           */
5 /*                           GODOT ENGINE                                */
6 /*                      https://godotengine.org                          */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
9 /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
10 /*                                                                       */
11 /* Permission is hereby granted, free of charge, to any person obtaining */
12 /* a copy of this software and associated documentation files (the       */
13 /* "Software"), to deal in the Software without restriction, including   */
14 /* without limitation the rights to use, copy, modify, merge, publish,   */
15 /* distribute, sublicense, and/or sell copies of the Software, and to    */
16 /* permit persons to whom the Software is furnished to do so, subject to */
17 /* the following conditions:                                             */
18 /*                                                                       */
19 /* The above copyright notice and this permission notice shall be        */
20 /* included in all copies or substantial portions of the Software.       */
21 /*                                                                       */
22 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
23 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
24 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
25 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
26 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
27 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
28 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
29 /*************************************************************************/
30 
31 #ifndef BROAD_PHASE_SW_H
32 #define BROAD_PHASE_SW_H
33 
34 #include "core/math/aabb.h"
35 #include "core/math/math_funcs.h"
36 
37 class CollisionObjectSW;
38 
39 class BroadPhaseSW {
40 
41 public:
42 	typedef BroadPhaseSW *(*CreateFunction)();
43 
44 	static CreateFunction create_func;
45 
46 	typedef uint32_t ID;
47 
48 	typedef void *(*PairCallback)(CollisionObjectSW *A, int p_subindex_A, CollisionObjectSW *B, int p_subindex_B, void *p_userdata);
49 	typedef void (*UnpairCallback)(CollisionObjectSW *A, int p_subindex_A, CollisionObjectSW *B, int p_subindex_B, void *p_data, void *p_userdata);
50 
51 	// 0 is an invalid ID
52 	virtual ID create(CollisionObjectSW *p_object_, int p_subindex = 0) = 0;
53 	virtual void move(ID p_id, const AABB &p_aabb) = 0;
54 	virtual void set_static(ID p_id, bool p_static) = 0;
55 	virtual void remove(ID p_id) = 0;
56 
57 	virtual CollisionObjectSW *get_object(ID p_id) const = 0;
58 	virtual bool is_static(ID p_id) const = 0;
59 	virtual int get_subindex(ID p_id) const = 0;
60 
61 	virtual int cull_point(const Vector3 &p_point, CollisionObjectSW **p_results, int p_max_results, int *p_result_indices = NULL) = 0;
62 	virtual int cull_segment(const Vector3 &p_from, const Vector3 &p_to, CollisionObjectSW **p_results, int p_max_results, int *p_result_indices = NULL) = 0;
63 	virtual int cull_aabb(const AABB &p_aabb, CollisionObjectSW **p_results, int p_max_results, int *p_result_indices = NULL) = 0;
64 
65 	virtual void set_pair_callback(PairCallback p_pair_callback, void *p_userdata) = 0;
66 	virtual void set_unpair_callback(UnpairCallback p_unpair_callback, void *p_userdata) = 0;
67 
68 	virtual void update() = 0;
69 
70 	virtual ~BroadPhaseSW();
71 };
72 
73 #endif // BROAD_PHASE__SW_H
74