svn merge -r 13452:14721 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / gameengine / Ketsji / KX_RayCast.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef __KX_RAYCAST_H__
31 #define __KX_RAYCAST_H__
32
33 class MT_Point3;
34 class MT_Vector3;
35 class KX_IPhysicsController;
36 class PHY_IPhysicsEnvironment;
37
38 struct KX_ClientObjectInfo;
39
40 /**
41  *  Defines a function for doing a ray cast.
42  *
43  *  eg KX_RayCast::RayTest(ignore_physics_controller, physics_environment, frompoint, topoint, result_point, result_normal, KX_RayCast::Callback<KX_MyClass>(this, data)
44  *
45  *  Calls myclass->RayHit(client, hit_point, hit_normal, data) for all client
46  *  between frompoint and topoint
47  *
48  *  myclass->RayHit should return true to end the raycast, false to ignore the current client.
49  *
50  *  Returns true if a client was accepted, false if nothing found.
51  */
52 class KX_RayCast
53 {
54 protected:
55         KX_RayCast() {};
56 public:
57         virtual ~KX_RayCast() {}
58
59         /** ray test callback.
60          *  either override this in your class, or use a callback wrapper.
61          */
62         virtual bool RayHit(KX_ClientObjectInfo* client, MT_Point3& hit_point, MT_Vector3& hit_normal) const = 0;
63
64         /** 
65          *  Callback wrapper.
66          *
67          *  Construct with KX_RayCast::Callback<MyClass>(this, data)
68          *  and pass to KX_RayCast::RayTest
69          */
70         template<class T> class Callback;
71         
72         /// Public interface.
73         /// Implement bool RayHit in your class to receive ray callbacks.
74         static bool RayTest(KX_IPhysicsController* physics_controller, 
75                 PHY_IPhysicsEnvironment* physics_environment, 
76                 const MT_Point3& _frompoint, 
77                 const MT_Point3& topoint, 
78                 MT_Point3& result_point, 
79                 MT_Vector3& result_normal, 
80                 const KX_RayCast& callback);
81         
82 };
83
84 template<class T> class KX_RayCast::Callback : public KX_RayCast
85 {
86         T *self;
87         void *data;
88 public:
89         Callback(T *_self, void *_data = NULL)
90                 : self(_self),
91                 data(_data)
92         {
93         }
94         
95         ~Callback() {}
96         
97         virtual bool RayHit(KX_ClientObjectInfo* client, MT_Point3& hit_point, MT_Vector3& hit_normal) const
98         {
99                 return self->RayHit(client, hit_point, hit_normal, data);
100         }
101 };
102         
103
104 #endif