From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_nav_a_i.html | 909 ++++++++++++++++++++++++++++++++++++ 1 file changed, 909 insertions(+) create mode 100644 Doc/doxygen/html/class_nav_a_i.html (limited to 'Doc/doxygen/html/class_nav_a_i.html') diff --git a/Doc/doxygen/html/class_nav_a_i.html b/Doc/doxygen/html/class_nav_a_i.html new file mode 100644 index 0000000..abf4c95 --- /dev/null +++ b/Doc/doxygen/html/class_nav_a_i.html @@ -0,0 +1,909 @@ + + + + + +Starshatter_Open: NavAI Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Protected Member Functions | +Protected Attributes
+
+
NavAI Class Reference
+
+
+ +

#include <NavAI.h>

+
+Inheritance diagram for NavAI:
+
+
+ + +ShipAI +SteerAI +Director +SimObserver + +
+ +

List of all members.

+ + + +

+Public Types

enum  { DIR_TYPE = 2000 + }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NavAI (Ship *s)
virtual ~NavAI ()
virtual int Type () const
virtual void ExecFrame (double seconds)
virtual int Subframe () const
void Disengage ()
bool Complete () const
- Public Member Functions inherited from ShipAI
 ShipAI (SimObject *s)
virtual ~ShipAI ()
virtual Ship * GetShip () const
virtual Ship * GetWard () const
virtual void SetWard (Ship *s)
virtual Ship * GetThreat () const
virtual void SetThreat (Ship *s)
virtual Ship * GetSupport () const
virtual void SetSupport (Ship *s)
virtual Ship * GetRumor () const
virtual void SetRumor (Ship *s)
virtual Shot * GetThreatMissile () const
virtual void SetThreatMissile (Shot *s)
virtual Instruction * GetNavPoint () const
virtual void SetNavPoint (Instruction *n)
virtual Point GetPatrol () const
virtual void SetPatrol (const Point &p)
virtual void ClearPatrol ()
virtual void ClearRumor ()
virtual void ClearTactical ()
virtual Farcaster * GetFarcaster ()
virtual void Splash (const Ship *targ)
virtual void SetTarget (SimObject *targ, System *sub=0)
virtual void DropTarget (double drop_time=1.5)
virtual double DropTime () const
virtual void SetBracket (bool bracket)
virtual void SetIdentify (bool identify)
virtual void SetFormationDelta (const Point &point)
virtual bool Update (SimObject *obj)
virtual const char * GetObserverName () const
virtual int GetAILevel () const
- Public Member Functions inherited from SteerAI
 SteerAI (SimObject *self)
virtual ~SteerAI ()
virtual SimObject * GetTarget () const
virtual System * GetSubTarget () const
virtual Point GetObjective () const
virtual SimObject * GetOther () const
- Public Member Functions inherited from Director
 Director ()
virtual ~Director ()
- Public Member Functions inherited from SimObserver
virtual ~SimObserver ()
int operator== (const SimObserver &o) const
virtual void Observe (SimObject *obj)
virtual void Ignore (SimObject *obj)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

virtual Steer SeekTarget ()
virtual Point Transform (const Point &pt)
virtual Steer Seek (const Point &point)
virtual Steer Flee (const Point &point)
virtual Steer Avoid (const Point &point, float radius)
virtual Steer AvoidTerrain ()
virtual void Navigator ()
virtual void FindObjective ()
virtual void HelmControl ()
virtual void ThrottleControl ()
- Protected Member Functions inherited from ShipAI
virtual bool AvoidTestSingleObject (SimObject *obj, const Point &bearing, double avoid_dist, double &avoid_time, Steer &steer)
virtual Steer AvoidCloseObject (SimObject *obj)
virtual Steer AvoidCollision ()
virtual Steer EvadeThreat ()
virtual Point ClosingVelocity ()
virtual void FindObjectiveTarget (SimObject *tgt)
virtual void FindObjectiveNavPoint ()
virtual void FindObjectiveFormation ()
virtual void FindObjectivePatrol ()
virtual void FindObjectiveQuantum ()
virtual void FindObjectiveFarcaster (SimRegion *src, SimRegion *dst)
virtual void AdjustDefenses ()
virtual void FireControl ()
virtual void NavlightControl ()
virtual void CheckTarget ()
- Protected Member Functions inherited from SteerAI
virtual int Accumulate (const Steer &steer)
virtual Steer Evade (const Point &point, const Point &vel)
virtual Point AimTransform (const Point &pt)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

bool complete
int drop_state
int quantum_state
int terrain_warning
double brakes
Farcaster * farcaster
- Protected Attributes inherited from ShipAI
Ship * ship
Ship * support
Ship * rumor
Ship * threat
Shot * threat_missile
Instruction * navpt
Point obstacle
TacticalAI * tactical
int engaged_ship_id
int splash_count
Point formation_delta
double slot_dist
double throttle
double old_throttle
double seconds
double drop_time
double brake
DWORD last_avoid_time
DWORD last_call_time
int element_index
int too_close
bool bracket
bool identify
bool hold
bool takeoff
int patrol
Point patrol_loc
int ai_level
- Protected Attributes inherited from SteerAI
int seeking
SimObject * self
SimObject * target
System * subtarget
SimObject * other
Point obj_w
Point objective
double distance
double az [3]
double el [3]
Steer accumulator
double magnitude
DWORD evade_time
double seek_gain
double seek_damp
int ai_type
- Protected Attributes inherited from SimObserver
List< SimObject > observe_list
+

Detailed Description

+
+

Definition at line 30 of file NavAI.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
anonymous enum
+
+
Enumerator:
+ +
DIR_TYPE  +
+
+
+ +

Definition at line 36 of file NavAI.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
NavAI::NavAI (Ship * s)
+
+ +

Definition at line 37 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
NavAI::~NavAI ()
+ 		+virtual
+
+ +

Definition at line 50 of file NavAI.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Steer NavAI::Avoid (const Point & point,
float radius 
)
+ 		+protectedvirtual
+
+ +

Reimplemented from SteerAI.

+ +

Definition at line 567 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Steer NavAI::AvoidTerrain ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 586 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool NavAI::Complete () const
+ 		+inline
+
+ +

Definition at line 42 of file NavAI.h.

+ +
+
+ +
+
+ + + + + + + +
void NavAI::Disengage ()
+
+ +

Definition at line 508 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NavAI::ExecFrame (double seconds)
+ 		+virtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 56 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NavAI::FindObjective ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 161 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Steer NavAI::Flee (const Point & point)
+ 		+protectedvirtual
+
+ +

Reimplemented from SteerAI.

+ +

Definition at line 554 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NavAI::HelmControl ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 336 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NavAI::Navigator ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 303 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Steer NavAI::Seek (const Point & point)
+ 		+protectedvirtual
+
+ +

Reimplemented from SteerAI.

+ +

Definition at line 525 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Steer NavAI::SeekTarget ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 468 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual int NavAI::Subframe () const
+ 		+inlinevirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 40 of file NavAI.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NavAI::ThrottleControl ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 401 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Point NavAI::Transform (const Point & pt)
+ 		+protectedvirtual
+
+ +

Reimplemented from SteerAI.

+ +

Definition at line 516 of file NavAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual int NavAI::Type () const
+ 		+inlinevirtual
+
+ +

Reimplemented from SteerAI.

+ +

Definition at line 37 of file NavAI.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
double NavAI::brakes
+ 		+protected
+
+ +

Definition at line 66 of file NavAI.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool NavAI::complete
+ 		+protected
+
+ +

Definition at line 62 of file NavAI.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int NavAI::drop_state
+ 		+protected
+
+ +

Definition at line 63 of file NavAI.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Farcaster* NavAI::farcaster
+ 		+protected
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 67 of file NavAI.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int NavAI::quantum_state
+ 		+protected
+
+ +

Definition at line 64 of file NavAI.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int NavAI::terrain_warning
+ 		+protected
+
+ +

Definition at line 65 of file NavAI.h.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • D:/SRC/StarshatterSVN/Stars45/NavAI.h
    • +
  • D:/SRC/StarshatterSVN/Stars45/NavAI.cpp
    • +
+
+
+ + + + -- cgit v1.1