DOOM-3-BFG

DOOM 3 BFG Edition
Log | Files | Refs

AimAssist.h (3411B)

      1 /*
      2 ===========================================================================
      3 
      4 Doom 3 BFG Edition GPL Source Code
      5 Copyright (C) 1993-2012 id Software LLC, a ZeniMax Media company. 
      6 
      7 This file is part of the Doom 3 BFG Edition GPL Source Code ("Doom 3 BFG Edition Source Code").  
      8 
      9 Doom 3 BFG Edition 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 BFG Edition 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 BFG Edition Source Code.  If not, see <http://www.gnu.org/licenses/>.
     21 
     22 In addition, the Doom 3 BFG Edition 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 BFG Edition 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	__AIMASSIST_H__
     30 #define	__AIMASSIST_H__
     31 
     32 /*
     33 ================================================================================================
     34 Contains the AimAssist declaration.
     35 ================================================================================================
     36 */
     37 
     38 class idEntity;
     39 class idPlayer;
     40 
     41 /*
     42 ================================================
     43 idAimAssist modifies the angle of Weapon firing to help the Player 
     44 hit a Target.
     45 ================================================
     46 */
     47 class idAimAssist {
     48 public:
     49 
     50 				idAimAssist() : angleCorrection( ang_zero ), frictionScalar( 1.0f ), lastTargetPos( vec3_zero ), player( NULL ) {}
     51 
     52 	void		Init( idPlayer * player );
     53 	void		Update();
     54 	void		GetAngleCorrection( idAngles & correction ) const { correction = angleCorrection; }
     55 	float		GetFrictionScalar () const { return frictionScalar; }
     56 
     57 	idEntity *	GetLastTarget() { return targetEntity; }
     58 	idEntity *	FindAimAssistTarget( idVec3 & targetPos );
     59 
     60 private:
     61 	void		UpdateNewAimAssist();
     62 	float		ComputeEntityAimAssistScore( const idVec3 & targetPos, const idVec3 & cameraPos, const idMat3 & cameraAxis );
     63 	bool		ComputeTargetPos( idEntity * pTarget, idVec3 & primaryTargetPos, idVec3 & secondaryTargetPos );
     64 	float		ComputeFrictionRadius( float distanceToTarget );
     65 	void		UpdateAdhesion( idEntity * pTarget, const idVec3 & targetPos);
     66 	void		UpdateFriction( idEntity * pTarget, const idVec3 & targetPos);
     67 
     68 	idPlayer *				player;						// player associated with this object
     69 	idAngles				angleCorrection;			// the angle delta to apply for aim assistance
     70 	float					frictionScalar;				// friction scalar
     71 	idEntityPtr<idEntity>	targetEntity;				// the last target we had (updated every frame)
     72 	idVec3					lastTargetPos;				// the last target position ( updated every frame );
     73 };
     74 
     75 #endif // !__AIMASSIST_H__