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_drone.html | 906 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 906 insertions(+) create mode 100644 Doc/doxygen/html/class_drone.html (limited to 'Doc/doxygen/html/class_drone.html') diff --git a/Doc/doxygen/html/class_drone.html b/Doc/doxygen/html/class_drone.html new file mode 100644 index 0000000..1943b6a --- /dev/null +++ b/Doc/doxygen/html/class_drone.html @@ -0,0 +1,906 @@ + + + + + +Starshatter_Open: Drone Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Static Public Member Functions | +Protected Attributes
+
+
Drone Class Reference
+
+
+ +

#include <Drone.h>

+
+Inheritance diagram for Drone:
+
+
+ + +Shot +SimObject +SimObserver +Physical + +
+ +

List of all members.

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

+Public Member Functions

 Drone (const Point &pos, const Camera &cam, WeaponDesign *design, const Ship *ship=0)
virtual ~Drone ()
virtual void SeekTarget (SimObject *target, System *sub=0)
virtual void ExecFrame (double factor)
virtual bool IsDrone () const
virtual bool IsDecoy () const
virtual bool IsProbe () const
virtual void Disarm ()
virtual void Destroy ()
virtual double PCS () const
virtual double ACS () const
virtual const char * ClassName () const
virtual int Class () const
void SetLife (int seconds)
virtual int HitBy (Shot *shot, Point &impact)
- Public Member Functions inherited from Shot
 Shot (const Point &pos, const Camera &cam, WeaponDesign *design, const Ship *ship=0)
virtual ~Shot ()
virtual void Activate (Scene &scene)
virtual void Deactivate (Scene &scene)
const Ship * Owner () const
double Damage () const
int ShotType () const
virtual SimObject * GetTarget () const
virtual bool IsPrimary () const
virtual bool IsMissile () const
virtual bool IsArmed () const
virtual bool IsBeam () const
virtual bool IsFlak () const
virtual bool IsHostileTo (const SimObject *o) const
bool HitTarget () const
void SetHitTarget (bool h)
virtual bool IsTracking (Ship *tgt) const
virtual int GetIFF () const
virtual Color MarkerColor () const
const Point & Origin () const
float Charge () const
void SetCharge (float c)
double Length () const
Graphic * GetTrail () const
void SetFuse (double seconds)
void SetBeamPoints (const Point &from, const Point &to)
const WeaponDesign * Design () const
const char * DesignName () const
int GetEta () const
void SetEta (int t)
double AltitudeMSL () const
double AltitudeAGL () const
virtual bool Update (SimObject *obj)
virtual const char * GetObserverName () const
int operator== (const Shot &s) const
- Public Member Functions inherited from SimObject
 SimObject ()
 SimObject (const char *n, int t=0)
virtual ~SimObject ()
virtual SimRegion * GetRegion () const
virtual void SetRegion (SimRegion *rgn)
virtual void Notify ()
virtual void Register (SimObserver *obs)
virtual void Unregister (SimObserver *obs)
virtual DWORD GetObjID () const
virtual void SetObjID (DWORD id)
- Public Member Functions inherited from Physical
 Physical ()
 Physical (const char *n, int t=0)
virtual ~Physical ()
int operator== (const Physical &p) const
virtual void AeroFrame (double seconds)
virtual void ArcadeFrame (double seconds)
virtual void AngularFrame (double seconds)
virtual void LinearFrame (double seconds)
virtual void CalcFlightPath ()
virtual void MoveTo (const Point &new_loc)
virtual void TranslateBy (const Point &ref)
virtual void ApplyForce (const Point &force)
virtual void ApplyTorque (const Point &torque)
virtual void SetThrust (double t)
virtual void SetTransX (double t)
virtual void SetTransY (double t)
virtual void SetTransZ (double t)
virtual void SetHeading (double r, double p, double y)
virtual void LookAt (const Point &dst)
virtual void ApplyRoll (double roll_acc)
virtual void ApplyPitch (double pitch_acc)
virtual void ApplyYaw (double yaw_acc)
virtual int CollidesWith (Physical &o)
virtual void InflictDamage (double damage, int type=0)
int Identity () const
int Type () const
const char * Name () const
Point Location () const
Point Heading () const
Point LiftLine () const
Point BeamLine () const
Point Velocity () const
Point Acceleration () const
double Thrust () const
double TransX () const
double TransY () const
double TransZ () const
double Drag () const
double Roll () const
double Pitch () const
double Yaw () const
Point Rotation () const
double Alpha () const
double FlightPathYawAngle () const
double FlightPathPitchAngle () const
double Radius () const
double Mass () const
double Integrity () const
double Life () const
double Shake () const
const Point & Vibration () const
const Camera & Cam () const
Graphic * Rep () const
Light * LightSrc () const
Director * GetDirector () const
virtual void SetAngularRates (double r, double p, double y)
virtual void GetAngularRates (double &r, double &p, double &y)
virtual void SetAngularDrag (double r, double p, double y)
virtual void GetAngularDrag (double &r, double &p, double &y)
virtual void GetAngularThrust (double &r, double &p, double &y)
virtual void SetVelocity (const Point &v)
virtual void SetAbsoluteOrientation (double roll, double pitch, double yaw)
virtual void CloneCam (const Camera &cam)
virtual void SetDrag (double d)
virtual void SetPrimary (const Point &loc, double mass)
virtual void SetGravity (double g)
virtual void SetBaseDensity (double d)
virtual double GetBaseDensity () const
virtual double GetDensity () const
- Public Member Functions inherited from SimObserver
virtual ~SimObserver ()
int operator== (const SimObserver &o) const
virtual void Observe (SimObject *obj)
virtual void Ignore (SimObject *obj)
+ + + + + +

+Static Public Member Functions

static const char * TYPENAME ()
- Static Public Member Functions inherited from Shot
static void Initialize ()
static void Close ()
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

int iff_code
int decoy_type
int probe
- Protected Attributes inherited from Shot
const Ship * owner
int type
float base_damage
float charge
float offset
float altitude_agl
short eta
bool first_frame
bool primary
bool beam
bool armed
bool hit_target
Sprite * flash
Sprite * flare
Trail * trail
Sound * sound
WeaponDesign * design
Point origin
- Protected Attributes inherited from SimObject
SimRegion * region
List< SimObserver > observers
DWORD objid
bool active
bool notifying
- Protected Attributes inherited from Physical
int id
int obj_type
char name [NAMELEN]
Camera cam
Point velocity
Point arcade_velocity
Point accel
float thrust
float trans_x
float trans_y
float trans_z
float drag
float roll
float pitch
float yaw
float dr
float dp
float dy
float dr_acc
float dp_acc
float dy_acc
float dr_drg
float dp_drg
float dy_drg
float flight_path_yaw
float flight_path_pitch
Point primary_loc
double primary_mass
float g_accel
float Do
float CL
float CD
float alpha
float stall
bool lat_thrust
bool straight
float shake
Point vibration
float roll_rate
float pitch_rate
float yaw_rate
double life
float radius
float mass
float integrity
Graphic * rep
Light * light
Director * dir
- Protected Attributes inherited from SimObserver
List< SimObject > observe_list
+

Detailed Description

+
+

Definition at line 34 of file Drone.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Drone::Drone (const Point & pos,
const Camera & cam,
WeaponDesign * design,
const Ship * ship = 0 
)
+
+ +

Definition at line 33 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Drone::~Drone ()
+ 		+virtual
+
+ +

Definition at line 49 of file Drone.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
double Drone::ACS () const
+ 		+virtual
+
+ +

Reimplemented from Shot.

+ +

Definition at line 98 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Drone::Class () const
+ 		+virtual
+
+ +

Definition at line 115 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char * Drone::ClassName () const
+ 		+virtual
+
+ +

Definition at line 109 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Drone::Destroy ()
+ 		+virtual
+
+ +

Reimplemented from Shot.

+ +

Definition at line 81 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Drone::Disarm ()
+ 		+virtual
+
+ +

Reimplemented from Shot.

+ +

Definition at line 73 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Drone::ExecFrame (double factor)
+ 		+virtual
+
+ +

Reimplemented from Shot.

+ +

Definition at line 65 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int Drone::HitBy (Shot * shot,
Point & impact 
)
+ 		+virtual
+
+ +

Definition at line 123 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual bool Drone::IsDecoy () const
+ 		+inlinevirtual
+
+ +

Reimplemented from Shot.

+ +

Definition at line 46 of file Drone.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual bool Drone::IsDrone () const
+ 		+inlinevirtual
+
+ +

Reimplemented from Shot.

+ +

Definition at line 45 of file Drone.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual bool Drone::IsProbe () const
+ 		+inlinevirtual
+
+ +

Reimplemented from Shot.

+ +

Definition at line 47 of file Drone.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double Drone::PCS () const
+ 		+virtual
+
+ +

Reimplemented from Shot.

+ +

Definition at line 89 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void Drone::SeekTarget (SimObject * target,
System * sub = 0 
)
+ 		+virtual
+
+ +

Reimplemented from Shot.

+ +

Definition at line 56 of file Drone.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Drone::SetLife (int seconds)
+ 		+inline
+
+ +

Definition at line 59 of file Drone.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* Drone::TYPENAME ()
+ 		+inlinestatic
+
+ +

Reimplemented from Shot.

+ +

Definition at line 37 of file Drone.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
int Drone::decoy_type
+ 		+protected
+
+ +

Definition at line 64 of file Drone.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Drone::iff_code
+ 		+protected
+
+ +

Reimplemented from Shot.

+ +

Definition at line 63 of file Drone.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Drone::probe
+ 		+protected
+
+ +

Definition at line 65 of file Drone.h.

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