Merge from trunk 16122-16307
[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 #include "PHY_IPhysicsEnvironment.h"
34 #include "PHY_IPhysicsController.h"
35 #include "MT_Point3.h"
36 #include "MT_Vector3.h"
37
38 class RAS_MeshObject; 
39 struct KX_ClientObjectInfo;
40 class KX_IPhysicsController;
41
42 /**
43  *  Defines a function for doing a ray cast.
44  *
45  *  eg KX_RayCast::RayTest(ignore_physics_controller, physics_environment, frompoint, topoint, result_point, result_normal, KX_RayCast::Callback<KX_MyClass>(this, data)
46  *
47  *  Calls myclass->RayHit(client, hit_point, hit_normal, data) for all client
48  *  between frompoint and topoint
49  *
50  *  myclass->RayHit should return true to end the raycast, false to ignore the current client.
51  *
52  *  Returns true if a client was accepted, false if nothing found.
53  */
54 class KX_RayCast : public PHY_IRayCastFilterCallback
55 {
56 public:
57         bool                                    m_hitFound;
58         MT_Point3                               m_hitPoint;
59         MT_Vector3                              m_hitNormal;
60         const RAS_MeshObject*   m_hitMesh;
61         int                                             m_hitPolygon;
62
63         KX_RayCast(KX_IPhysicsController* ignoreController, bool faceNormal);
64         virtual ~KX_RayCast() {}
65
66         /**
67          * The physic environment returns the ray casting result through this function
68          */
69         virtual void reportHit(PHY_RayCastResult* result);
70
71         /** ray test callback.
72          *  either override this in your class, or use a callback wrapper.
73          */
74         virtual bool RayHit(KX_ClientObjectInfo* client) = 0;
75
76         /** 
77          *  Callback wrapper.
78          *
79          *  Construct with KX_RayCast::Callback<MyClass>(this, data)
80          *  and pass to KX_RayCast::RayTest
81          */
82         template<class T> class Callback;
83         
84         /// Public interface.
85         /// Implement bool RayHit in your class to receive ray callbacks.
86         static bool RayTest(
87                 PHY_IPhysicsEnvironment* physics_environment, 
88                 const MT_Point3& frompoint, 
89                 const MT_Point3& topoint, 
90                 KX_RayCast& callback);
91         
92 };
93
94 template<class T> class KX_RayCast::Callback : public KX_RayCast
95 {
96         T *self;
97         void *data;
98 public:
99         Callback(T *_self, KX_IPhysicsController* controller=NULL, void *_data = NULL, bool faceNormal=false)
100                 : KX_RayCast(controller, faceNormal),
101                 self(_self),
102                 data(_data)
103         {
104         }
105         
106         ~Callback() {}
107
108         virtual bool RayHit(KX_ClientObjectInfo* client)
109         {
110                 return self->RayHit(client, this, data);
111         }
112
113         virtual bool needBroadphaseRayCast(PHY_IPhysicsController* controller)
114         {
115                 KX_ClientObjectInfo* info = static_cast<KX_ClientObjectInfo*>(controller->getNewClientInfo());
116                 
117                 if (!info)
118                 {
119                         MT_assert(info && "Physics controller with no client object info");
120                         return false;
121                 }
122                 return self->NeedRayCast(info);
123         }
124
125 };
126         
127
128 #endif