propclass/steer.h Source File (CEL: Crystal Entity Layer 2.0 Public API Reference)

00001 /*
00002     Crystal Space Entity Layer
00003     Copyright (C) 2001 by Jorrit Tyberghein
00004   
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009   
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014   
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef __CEL_PF_STEER__
00021 #define __CEL_PF_STEER__
00022 
00023 #include "cstypes.h"
00024 #include "csutil/scf.h"
00025 #include "physicallayer/entity.h"
00026 
00027 struct iPcLinearMovement;
00028 
00067 struct iPcSteer : public virtual iBase
00068 {
00069   SCF_INTERFACE (iPcSteer, 1, 0, 0);
00070 
00075   virtual bool Vigilant () = 0;
00087   virtual bool Seek (iSector* sector, const csVector3& position) = 0;
00088 
00098   virtual bool Flee (iSector* sector, const csVector3& position) = 0;
00099 
00115   virtual bool Pursue (iCelEntity* target, float max_prediction)=0;
00116 
00121   virtual void CheckArrivalOn (float radius) = 0;
00122 
00126   virtual void CheckArrivalOff () = 0;
00127 
00133   virtual void CollisionAvoidanceOn (float lookahead, float weight) = 0;
00134 
00138   virtual void CollisionAvoidanceOff () = 0;
00139 
00140 
00148   virtual void CohesionOn (iCelEntityList* targets, float radius, float max_radius, float weight) = 0;
00149 
00153   virtual void CohesionOff () = 0;
00154 
00161   virtual void SeparationOn (iCelEntityList* targets, float radius, float weight) = 0;
00162 
00166   virtual void SeparationOff () = 0;
00167 
00173   virtual void DirectionMatchingOn (iCelEntityList* targets, float weight) = 0;
00174 
00178   virtual void DirectionMatchingOff () = 0;
00179 
00184   virtual void Interrupt () = 0;
00185 
00189   virtual iSector* GetSector () const = 0;
00190 
00194   virtual const csVector3& GetPosition () const = 0;
00195 
00199   virtual float RandomBinomial (float rate) = 0;
00200 
00205   virtual void SetDelayRecheck (int delay) = 0;
00206 
00210   virtual bool IsMoving () const = 0;
00211 };
00212 
00213 #endif // __CEL_PF_STEER__