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_starship_a_i.html | 789 +++++++++++++++++++++++++++++++ 1 file changed, 789 insertions(+) create mode 100644 Doc/doxygen/html/class_starship_a_i.html (limited to 'Doc/doxygen/html/class_starship_a_i.html') diff --git a/Doc/doxygen/html/class_starship_a_i.html b/Doc/doxygen/html/class_starship_a_i.html new file mode 100644 index 0000000..9f835d9 --- /dev/null +++ b/Doc/doxygen/html/class_starship_a_i.html @@ -0,0 +1,789 @@ + + + + + +Starshatter_Open: StarshipAI Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Protected Member Functions | +Protected Attributes
+
+
StarshipAI Class Reference
+
+
+ +

#include <StarshipAI.h>

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

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 StarshipAI (SimObject *s)
virtual ~StarshipAI ()
virtual void FindObjective ()
- Public Member Functions inherited from ShipAI
 ShipAI (SimObject *s)
virtual ~ShipAI ()
virtual void ExecFrame (double seconds)
virtual int Subframe () const
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 int Type () 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 void Navigator ()
virtual Steer SeekTarget ()
virtual Steer AvoidCollision ()
virtual Steer Seek (const Point &point)
virtual Steer Flee (const Point &point)
virtual Steer Avoid (const Point &point, float radius)
virtual Point Transform (const Point &pt)
virtual void FireControl ()
virtual void HelmControl ()
virtual void ThrottleControl ()
System * SelectSubtarget ()
bool AssessTargetPointDefense ()
- 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 AvoidTerrain ()
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 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

DWORD sub_select_time
DWORD point_defense_time
System * subtarget
bool tgt_point_defense
- Protected Attributes inherited from ShipAI
Ship * ship
Ship * support
Ship * rumor
Ship * threat
Shot * threat_missile
Instruction * navpt
Point obstacle
TacticalAI * tactical
Farcaster * farcaster
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
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 23 of file StarshipAI.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
StarshipAI::StarshipAI (SimObject * s)
+
+ +

Definition at line 38 of file StarshipAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
StarshipAI::~StarshipAI ()
+ 		+virtual
+
+ +

Definition at line 76 of file StarshipAI.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
bool StarshipAI::AssessTargetPointDefense ()
+ 		+protected
+
+ +

Definition at line 728 of file StarshipAI.cpp.

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

Reimplemented from SteerAI.

+ +

Definition at line 810 of file StarshipAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Steer StarshipAI::AvoidCollision ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 530 of file StarshipAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarshipAI::FindObjective ()
+ 		+virtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 82 of file StarshipAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarshipAI::FireControl ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 541 of file StarshipAI.cpp.

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

Reimplemented from SteerAI.

+ +

Definition at line 802 of file StarshipAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarshipAI::HelmControl ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 256 of file StarshipAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarshipAI::Navigator ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 210 of file StarshipAI.cpp.

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

Reimplemented from SteerAI.

+ +

Definition at line 777 of file StarshipAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Steer StarshipAI::SeekTarget ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 469 of file StarshipAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
System * StarshipAI::SelectSubtarget ()
+ 		+protected
+
+ +

Definition at line 640 of file StarshipAI.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarshipAI::ThrottleControl ()
+ 		+protectedvirtual
+
+ +

Reimplemented from ShipAI.

+ +

Definition at line 321 of file StarshipAI.cpp.

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

Reimplemented from SteerAI.

+ +

Definition at line 771 of file StarshipAI.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
DWORD StarshipAI::point_defense_time
+ 		+protected
+
+ +

Definition at line 54 of file StarshipAI.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD StarshipAI::sub_select_time
+ 		+protected
+
+ +

Definition at line 53 of file StarshipAI.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
System* StarshipAI::subtarget
+ 		+protected
+
+ +

Reimplemented from SteerAI.

+ +

Definition at line 55 of file StarshipAI.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool StarshipAI::tgt_point_defense
+ 		+protected
+
+ +

Definition at line 56 of file StarshipAI.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1