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

#include <StarSystem.h>

+
+Inheritance diagram for OrbitalRegion:
+
+
+ + +Orbital +TerrainRegion + +
+ +

List of all members.

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

+Public Member Functions

 OrbitalRegion (StarSystem *sys, const char *n, double m, double r, double o, Orbital *prime=0)
virtual ~OrbitalRegion ()
double GridSpace () const
double Inclination () const
int Asteroids () const
List< Text > & Links ()
- Public Member Functions inherited from Orbital
 Orbital (StarSystem *sys, const char *n, OrbitalType t, double m, double r, double o, Orbital *p=0)
virtual ~Orbital ()
int operator== (const Orbital &o) const
int operator< (const Orbital &o) const
int operator<= (const Orbital &o) const
virtual void Update ()
Point PredictLocation (double delta_t)
const char * Name () const
OrbitalType Type () const
int SubType () const
const char * Description () const
double Mass () const
double Radius () const
double Rotation () const
double RotationPhase () const
double Orbit () const
bool Retrograde () const
double Phase () const
double Period () const
Point Location () const
Graphic * Rep () const
const Bitmap & GetMapIcon () const
void SetMapIcon (const Bitmap &img)
StarSystem * System () const
Orbital * Primary () const
ListIter< OrbitalRegion > Regions ()
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+ + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

double grid
double inclination
int asteroids
List< Text > links
- Protected Attributes inherited from Orbital
Text name
OrbitalType type
int subtype
Text description
double mass
double radius
double rotation
double theta
double orbit
double phase
double period
double velocity
Point loc
bool retro
Graphic * rep
Bitmap map_icon
StarSystem * system
Orbital * primary
List< OrbitalRegion > regions
+ + +

+Friends

class StarSystem
+ + + +

+Additional Inherited Members

- Public Types inherited from Orbital
enum  OrbitalType {
+  NOTHING, +STAR, +PLANET, +MOON, +
+  REGION, +TERRAIN +
+ }
+

Detailed Description

+
+

Definition at line 299 of file StarSystem.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OrbitalRegion::OrbitalRegion (StarSystem * sys,
const char * n,
double m,
double r,
double o,
Orbital * prime = 0 
)
+
+ +

Definition at line 1963 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
OrbitalRegion::~OrbitalRegion ()
+ 		+virtual
+
+ +

Definition at line 1970 of file StarSystem.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
int OrbitalRegion::Asteroids () const
+ 		+inline
+
+ +

Definition at line 311 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double OrbitalRegion::GridSpace () const
+ 		+inline
+
+ +

Definition at line 309 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double OrbitalRegion::Inclination () const
+ 		+inline
+
+ +

Definition at line 310 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Text>& OrbitalRegion::Links ()
+ 		+inline
+
+ +

Definition at line 312 of file StarSystem.h.

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

Reimplemented from Orbital.

+ +

Definition at line 304 of file StarSystem.h.

+ +
+
+

Friends And Related Function Documentation

+ +
+
+ + + + + +
+ + + + +
friend class StarSystem
+ 		+friend
+
+ +

Reimplemented from Orbital.

+ +

Reimplemented in TerrainRegion.

+ +

Definition at line 301 of file StarSystem.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
int OrbitalRegion::asteroids
+ 		+protected
+
+ +

Definition at line 317 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double OrbitalRegion::grid
+ 		+protected
+
+ +

Definition at line 315 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double OrbitalRegion::inclination
+ 		+protected
+
+ +

Definition at line 316 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> OrbitalRegion::links
+ 		+protected
+
+ +

Definition at line 318 of file StarSystem.h.

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