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

#include <Galaxy.h>

+ +

List of all members.

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

+Public Member Functions

 Galaxy (const char *name)
virtual ~Galaxy ()
int operator== (const Galaxy &s) const
virtual void Load ()
virtual void Load (const char *filename)
virtual void ExecFrame ()
const char * Name () const
const char * Description () const
List< StarSystem > & GetSystemList ()
List< Star > & Stars ()
double Radius () const
StarSystem * GetSystem (const char *name)
StarSystem * FindSystemByRegion (const char *rgn_name)
+ + + + +

+Static Public Member Functions

static void Initialize ()
static void Close ()
static Galaxy * GetInstance ()
+ + + + + + + +

+Protected Attributes

char filename [64]
Text name
Text description
double radius
List< StarSystem > systems
List< Star > stars
+

Detailed Description

+
+

Definition at line 36 of file Galaxy.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
Galaxy::Galaxy (const char * name)
+
+ +

Definition at line 32 of file Galaxy.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Galaxy::~Galaxy ()
+ 		+virtual
+
+ +

Definition at line 38 of file Galaxy.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
void Galaxy::Close ()
+ 		+static
+
+ +

Definition at line 56 of file Galaxy.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* Galaxy::Description () const
+ 		+inline
+
+ +

Definition at line 51 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Galaxy::ExecFrame ()
+ 		+virtual
+
+ +

Definition at line 248 of file Galaxy.cpp.

+ +
+
+ +
+
+ + + + + + + + +
StarSystem * Galaxy::FindSystemByRegion (const char * rgn_name)
+
+ +

Definition at line 273 of file Galaxy.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Galaxy * Galaxy::GetInstance ()
+ 		+static
+
+ +

Definition at line 63 of file Galaxy.cpp.

+ +
+
+ +
+
+ + + + + + + + +
StarSystem * Galaxy::GetSystem (const char * name)
+
+ +

Definition at line 259 of file Galaxy.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<StarSystem>& Galaxy::GetSystemList ()
+ 		+inline
+
+ +

Definition at line 52 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Galaxy::Initialize ()
+ 		+static
+
+ +

Definition at line 48 of file Galaxy.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Galaxy::Load ()
+ 		+virtual
+
+ +

Definition at line 71 of file Galaxy.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Galaxy::Load (const char * filename)
+ 		+virtual
+
+ +

Definition at line 95 of file Galaxy.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* Galaxy::Name () const
+ 		+inline
+
+ +

Definition at line 50 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int Galaxy::operator== (const Galaxy & s) const
+ 		+inline
+
+ +

Definition at line 42 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double Galaxy::Radius () const
+ 		+inline
+
+ +

Definition at line 54 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Star>& Galaxy::Stars ()
+ 		+inline
+
+ +

Definition at line 53 of file Galaxy.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Text Galaxy::description
+ 		+protected
+
+ +

Definition at line 66 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
char Galaxy::filename[64]
+ 		+protected
+
+ +

Definition at line 64 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text Galaxy::name
+ 		+protected
+
+ +

Definition at line 65 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Galaxy::radius
+ 		+protected
+
+ +

Definition at line 67 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Star> Galaxy::stars
+ 		+protected
+
+ +

Definition at line 70 of file Galaxy.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<StarSystem> Galaxy::systems
+ 		+protected
+
+ +

Definition at line 69 of file Galaxy.h.

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