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

#include <StarSystem.h>

+
+Inheritance diagram for OrbitalBody:
+
+
+ + +Orbital + +
+ +

List of all members.

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

+Public Member Functions

 OrbitalBody (StarSystem *sys, const char *n, OrbitalType t, double m, double r, double o, Orbital *prime=0)
virtual ~OrbitalBody ()
virtual void Update ()
ListIter< OrbitalBody > Satellites ()
double Tilt () const
double RingMin () const
double RingMax () const
double LightIntensity () const
Color LightColor () const
bool Luminous () const
- 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
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

Text map_name
Text tex_name
Text tex_high_res
Text tex_ring
Text tex_glow
Text tex_glow_high_res
Text tex_gloss
double tscale
double light
double ring_min
double ring_max
double tilt
Light * light_rep
Light * back_light
Color color
Color back
Color atmosphere
bool luminous
List< OrbitalBody > satellites
- 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 249 of file StarSystem.h.

+

Constructor & Destructor Documentation

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

Definition at line 1916 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
OrbitalBody::~OrbitalBody ()
+ 		+virtual
+
+ +

Definition at line 1925 of file StarSystem.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
Color OrbitalBody::LightColor () const
+ 		+inline
+
+ +

Definition at line 270 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double OrbitalBody::LightIntensity () const
+ 		+inline
+
+ +

Definition at line 269 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool OrbitalBody::Luminous () const
+ 		+inline
+
+ +

Definition at line 271 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double OrbitalBody::RingMax () const
+ 		+inline
+
+ +

Definition at line 267 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double OrbitalBody::RingMin () const
+ 		+inline
+
+ +

Definition at line 266 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
ListIter<OrbitalBody> OrbitalBody::Satellites ()
+ 		+inline
+
+ +

Definition at line 263 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double OrbitalBody::Tilt () const
+ 		+inline
+
+ +

Definition at line 265 of file StarSystem.h.

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

Reimplemented from Orbital.

+ +

Definition at line 254 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void OrbitalBody::Update ()
+ 		+virtual
+
+ +

Reimplemented from Orbital.

+ +

Definition at line 1933 of file StarSystem.cpp.

+ +
+
+

Friends And Related Function Documentation

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

Reimplemented from Orbital.

+ +

Definition at line 251 of file StarSystem.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Color OrbitalBody::atmosphere
+ 		+protected
+
+ +

Definition at line 291 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color OrbitalBody::back
+ 		+protected
+
+ +

Definition at line 290 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Light* OrbitalBody::back_light
+ 		+protected
+
+ +

Definition at line 288 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color OrbitalBody::color
+ 		+protected
+
+ +

Definition at line 289 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double OrbitalBody::light
+ 		+protected
+
+ +

Definition at line 283 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Light* OrbitalBody::light_rep
+ 		+protected
+
+ +

Definition at line 287 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool OrbitalBody::luminous
+ 		+protected
+
+ +

Definition at line 292 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text OrbitalBody::map_name
+ 		+protected
+
+ +

Definition at line 274 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double OrbitalBody::ring_max
+ 		+protected
+
+ +

Definition at line 285 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double OrbitalBody::ring_min
+ 		+protected
+
+ +

Definition at line 284 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<OrbitalBody> OrbitalBody::satellites
+ 		+protected
+
+ +

Definition at line 294 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text OrbitalBody::tex_gloss
+ 		+protected
+
+ +

Definition at line 280 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text OrbitalBody::tex_glow
+ 		+protected
+
+ +

Definition at line 278 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text OrbitalBody::tex_glow_high_res
+ 		+protected
+
+ +

Definition at line 279 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text OrbitalBody::tex_high_res
+ 		+protected
+
+ +

Definition at line 276 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text OrbitalBody::tex_name
+ 		+protected
+
+ +

Definition at line 275 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text OrbitalBody::tex_ring
+ 		+protected
+
+ +

Definition at line 277 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double OrbitalBody::tilt
+ 		+protected
+
+ +

Definition at line 286 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double OrbitalBody::tscale
+ 		+protected
+
+ +

Definition at line 282 of file StarSystem.h.

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