engine/include/physics/RayCallback.h

   1 /*
   2 Copyright (C) 2008   Christian Reiser
   3
   4 Permission is hereby granted, free of charge, to any person obtaining a copy of
   5 this software and associated documentation files (the "Software"), to deal in the
   6 Software without restriction, including without limitation the rights to use,
   7 copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
   8 Software, and to permit persons to whom the Software is furnished to do so,
   9 subject to the following conditions:
  10
  11 The above copyright notice and this permission notice shall be included in all
  12 copies or substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  15 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  16 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  17 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  18 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  19 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20 */
  21
  22 #ifndef _RAY_CALLBACK_H_
  23 #define _RAY_CALLBACK_H_
  24
  25 #include "physics/Callback.h"
  26 #include "core/Vector3D.h"
  27
  28 #include <string>
  29
  30 //tolua_begin
  31 namespace peak
  32 {
  33         class Body;
  34         class Script;
  35
  36         /**
  37          * \brief Structure which contains infos about collisions
  38          *
  39          * A callback gets this structure as parameter, so the collision
  40          * info is avaible in the script, too.
  41          *
  42          */
  43         struct CollisionInfo
  44         {
  45                 CollisionInfo()
  46                 {
  47                         lambda = 0;
  48                         object = 0;
  49                 }
  50                 /**
  51                  * \brief (Only for rays) that's the way from the ray origin to the collision point.
  52                  *
  53                  */
  54                 float lambda;
  55                 /**
  56                  * \brief The position where the collision has occured.
  57                  *
  58                  */
  59                 Vector3D point;
  60                 /**
  61                  * \brief The object with which the ray/convex intersects.
  62                  *
  63                  * That's very useful to findout with which entity the ray/convex has intersect.
  64                  * Use Body::getEntity to finally find out.
  65                  *
  66                  */
  67                 Body *object;
  68         };
  69
  70         /**
  71          * \brief Class for custom ray callbacks.
  72          *
  73          * Example:
  74          * \code
  75          * (lua_start)
  76          * -- We need a a script, in which the callback will be called.
  77          * samplescript = entity:getScript();
  78          *
  79          * raycallback = peak.RayCallback:new();
  80          * raycallback:create(peak.Vector3D(0, 1, 0), peak.Vector3D(0, -1, 0), samplescript, MyRayCallback);
  81          *
  82          * -- This is our callback function, it ll be called when the ray had intersected.
  83          * function MyRayCallback()
  84          *      print("The Ray had intersected!!");
  85          *      -- That'll print "The Ray had intersected!!" every time in the console when the ray had intersected(logical!).
  86          * (lua_end)
  87          * \endcode
  88          *
  89          * You see: It's very easy to create a custom ray callback and you need that for very many things.
  90          *
  91          */
  92         class RayCallback : public Callback
  93         {
  94                 public:
  95                         RayCallback();
  96                         virtual ~RayCallback();
  97
  98                         /**
  99                          * \brief Creates a custom ray callback and defines it.
 100                          *
 101                          * \param rayto The Point where the ray ends.
 102                          * \param rayfrom The Point where the ray starts.
 103                          * \param script The Script where the callback function will be called.
 104                          * \param callbackname The name of the callback in the script. This function will be called when the ray had intersected.
 105                          *
 106                          */
 107                         bool create(Vector3D rayto, Vector3D rayfrom, Script *script, std::string callbackname);
 108                         /**
 109                          * \brief Creates a custom ray callback and defines it.
 110                          *
 111                          * \param script The Script where the callback function will be called.
 112                          * \param callbackname The name of the callback in the script. This function will be called when the ray had intersected.
 113                          *
 114                          */
 115                         bool create(Script *script, std::string callbackname);
 116                         /**
 117                          * \brief Destroys the callback.
 118                          *
 119                          * When this function is called the callback won't be called again.
 120                          */
 121                         bool destroy();
 122
 123                         /**
 124                          * \brief Updates the callback, for internal use only.
 125                          */
 126                         void update();
 127
 128                         /**
 129                          * \brief Returns true when the ray had intersected and false if not.
 130                          */
 131                         bool isCollision();
 132
 133                         /**
 134                          * \brief Sets the ray start position AND end position new.
 135                          *
 136                          * \param rayto The point where the ray ends.
 137                          * \param rayfrom The point where the ray starts.
 138                          *
 139                          * If you only want to change one of the both components you can do something like that:
 140                          * \code
 141                          * (lua_start)
 142                          * raycallback:setRay(peak.Vector3D(1, 0, 0), raycallback:getRay(1));
 143                          * (lua_end)
 144                          * \endcode
 145                          */
 146                         void setRay(Vector3D rayto, Vector3D rayfrom);
 147                         /**
 148                          * \brief Gets the start position OR the end position of the ray.
 149                          *
 150                          * \param index If index is true the end position is returned and if index is false the start positon is returned.
 151                          *
 152                          * \return The return value depends on the "index" parameter. For more info see parameter documentation.
 153                          */
 154                         Vector3D getRay(bool index);
 155
 156                         /**
 157                          * \brief Sets the collision info.
 158                          */
 159                         void setInfo(CollisionInfo info);
 160                         /**
 161                          * \brief Gets the collision info.
 162                          */
 163                         CollisionInfo getInfo(void);
 164                 private:
 165                         //tolua_end
 166                         std::string callbackname;
 167                         Script *script;
 168
 169                         Vector3D rayto;
 170                         Vector3D rayfrom;
 171
 172                         CollisionInfo info;
 173                         bool collision;
 174                         //tolua_begin
 175         };
 176 }
 177 //tolua_end
 178
 179 #endif