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

#include <NavLight.h>

+
+Inheritance diagram for NavLight:
+
+
+ + +System + +
+ +

List of all members.

+ + + + + + + +

+Public Types

enum  Constants { MAX_LIGHTS = 8 + }
- Public Types inherited from System
enum  CATEGORY {
+  MISC_SYSTEM = 0, +DRIVE = 1, +WEAPON, +SHIELD, +
+  SENSOR, +COMPUTER, +POWER_SOURCE, +FLIGHT_DECK, +
+  FARCASTER +
+ }
enum  STATUS {
+  DESTROYED, +CRITICAL, +DEGRADED, +NOMINAL, +
+  MAINT +
+ }
enum  POWER_FLAGS { POWER_WATTS = 1, +POWER_CRITICAL = 2 + }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NavLight (double period, double scale)
 NavLight (const NavLight &rhs)
virtual ~NavLight ()
virtual void ExecFrame (double seconds)
int NumBeacons () const
Sprite * Beacon (int index) const
bool IsEnabled () const
virtual void Enable ()
virtual void Disable ()
virtual void AddBeacon (Point loc, DWORD pattern, int type=1)
virtual void SetPeriod (double p)
virtual void SetPattern (int index, DWORD p)
virtual void SetOffset (DWORD o)
virtual void Orient (const Physical *rep)
- Public Member Functions inherited from System
 System (CATEGORY t, int s, const char *n, int maxv, double energy=0, double capacity=100, double sink_rate=1)
 System (const System &s)
virtual ~System ()
int operator== (const System &s) const
CATEGORY Type () const
int Subtype () const
const char * Name () const
const char * Abbreviation () const
void SetName (const char *n)
void SetAbbreviation (const char *a)
void SetDesign (SystemDesign *d)
virtual int Value () const
int MaxValue () const
STATUS Status () const
double Availability () const
double Safety () const
double Stability () const
virtual void CalcStatus ()
virtual void Repair ()
double NetAvail () const
void SetNetAvail (double d)
List< Component > & GetComponents ()
virtual void ApplyDamage (double damage)
virtual void ExecMaintFrame (double seconds)
virtual void DoEMCON (int emcon)
virtual void Mount (Point loc, float radius, float hull_factor=0.5f)
virtual void Mount (const System &system)
Point MountLocation () const
double Radius () const
double HullProtection () const
bool IsPowerCritical () const
bool UsesWatts () const
virtual double GetRequest (double seconds) const
virtual void Distribute (double delivered_energy, double seconds)
int GetSourceIndex () const
void SetSourceIndex (int i)
virtual int Charge () const
bool IsPowerOn () const
virtual void PowerOn ()
virtual void PowerOff ()
virtual double GetPowerLevel () const
virtual void SetPowerLevel (double level)
virtual void SetOverride (bool over)
virtual void DrainPower (double to_level)
void SetCapacity (double c)
double GetCapacity () const
double GetEnergy () const
double GetSinkRate () const
void SetEMCONPower (int emcon, int power_level)
int GetEMCONPower (int emcon)
int GetExplosionType () const
void SetExplosionType (int t)
Ship * GetShip () const
void SetShip (Ship *s)
int GetID () const
void SetID (int n)
+ + + + + +

+Static Public Member Functions

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

+Protected Attributes

double period
double scale
bool enable
int nlights
Point loc [MAX_LIGHTS]
DriveSprite * beacon [MAX_LIGHTS]
DWORD pattern [MAX_LIGHTS]
int beacon_type [MAX_LIGHTS]
DWORD offset
- Protected Attributes inherited from System
CATEGORY type
Ship * ship
int id
int subtype
int max_value
Text name
Text abrv
STATUS status
float crit_level
float availability
float safety
float stability
float safety_overload
float net_avail
Point mount_loc
Point mount_rel
float radius
float hull_factor
float energy
float capacity
float sink_rate
float power_level
int source_index
DWORD power_flags
bool power_on
BYTE emcon_power [3]
BYTE emcon
int explosion_type
SystemDesign * design
List< Component > components
+

Detailed Description

+
+

Definition at line 25 of file NavLight.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum NavLight::Constants
+
+
Enumerator:
+ +
MAX_LIGHTS  +
+
+
+ +

Definition at line 28 of file NavLight.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NavLight::NavLight (double period,
double scale 
)
+
+ +

Definition at line 28 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NavLight::NavLight (const NavLight & rhs)
+
+ +

Definition at line 42 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
NavLight::~NavLight ()
+ 		+virtual
+
+ +

Definition at line 69 of file NavLight.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NavLight::AddBeacon (Point loc,
DWORD pattern,
int type = 1 
)
+ 		+virtual
+
+ +

Definition at line 138 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Sprite* NavLight::Beacon (int index) const
+ 		+inline
+
+ +

Definition at line 40 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NavLight::Close ()
+ 		+static
+
+ +

Definition at line 93 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NavLight::Disable ()
+ 		+virtual
+
+ +

Definition at line 132 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NavLight::Enable ()
+ 		+virtual
+
+ +

Definition at line 126 of file NavLight.cpp.

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

Reimplemented from System.

+ +

Definition at line 100 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NavLight::Initialize ()
+ 		+static
+
+ +

Definition at line 78 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool NavLight::IsEnabled () const
+ 		+inline
+
+ +

Definition at line 41 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int NavLight::NumBeacons () const
+ 		+inline
+
+ +

Definition at line 39 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NavLight::Orient (const Physical * rep)
+ 		+virtual
+
+ +

Reimplemented from System.

+ +

Definition at line 175 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NavLight::SetOffset (DWORD o)
+ 		+virtual
+
+ +

Definition at line 167 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void NavLight::SetPattern (int index,
DWORD p 
)
+ 		+virtual
+
+ +

Definition at line 160 of file NavLight.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NavLight::SetPeriod (double p)
+ 		+virtual
+
+ +

Definition at line 154 of file NavLight.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
DriveSprite* NavLight::beacon[MAX_LIGHTS]
+ 		+protected
+
+ +

Definition at line 60 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int NavLight::beacon_type[MAX_LIGHTS]
+ 		+protected
+
+ +

Definition at line 62 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool NavLight::enable
+ 		+protected
+
+ +

Definition at line 55 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point NavLight::loc[MAX_LIGHTS]
+ 		+protected
+
+ +

Definition at line 59 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int NavLight::nlights
+ 		+protected
+
+ +

Definition at line 57 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD NavLight::offset
+ 		+protected
+
+ +

Definition at line 63 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD NavLight::pattern[MAX_LIGHTS]
+ 		+protected
+
+ +

Definition at line 61 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double NavLight::period
+ 		+protected
+
+ +

Definition at line 53 of file NavLight.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double NavLight::scale
+ 		+protected
+
+ +

Definition at line 54 of file NavLight.h.

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