neo/d3xp/physics/Force_Grab.h

   1 /*
   2 ===========================================================================
   3
   4 Doom 3 GPL Source Code
   5 Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
   6
   7 This file is part of the Doom 3 GPL Source Code (?Doom 3 Source Code?).
   8
   9 Doom 3 Source Code is free software: you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation, either version 3 of the License, or
  12 (at your option) any later version.
  13
  14 Doom 3 Source Code is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with Doom 3 Source Code.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code.  If not, please request a copy in writing from id Software at the address below.
  23
  24 If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
  25
  26 ===========================================================================
  27 */
  28
  29 #ifndef __FORCE_GRAB_H__
  30 #define __FORCE_GRAB_H__
  31
  32 #ifdef _D3XP
  33
  34 /*
  35 ===============================================================================
  36
  37         Drag force
  38
  39 ===============================================================================
  40 */
  41
  42 class idForce_Grab : public idForce {
  43
  44 public:
  45         CLASS_PROTOTYPE( idForce_Grab );
  46
  47         void                            Save( idSaveGame *savefile ) const;
  48         void                            Restore( idRestoreGame *savefile );
  49
  50                                                 idForce_Grab( void );
  51         virtual                         ~idForce_Grab( void );
  52                                                 // initialize the drag force
  53         void                            Init( float damping );
  54                                                 // set physics object being dragged
  55         void                            SetPhysics( idPhysics *physics, int id, const idVec3 &goal );
  56                                                 // update the goal position
  57         void                            SetGoalPosition( const idVec3 &goal );
  58
  59
  60 public: // common force interface
  61         virtual void            Evaluate( int time );
  62         virtual void            RemovePhysics( const idPhysics *phys );
  63
  64         // Get the distance from object to goal position
  65         float                           GetDistanceToGoal( void );
  66
  67 private:
  68
  69         // properties
  70         float                           damping;
  71         idVec3                          goalPosition;
  72
  73         float                           distanceToGoal;
  74
  75         // positioning
  76         idPhysics *                     physics;                // physics object
  77         int                                     id;                             // clip model id of physics object
  78 };
  79
  80 #endif /* _D3XP */
  81 #endif /* !__FORCE_GRAB_H__ */