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

#include <StarSystem.h>

+ +

List of all members.

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

+Public Member Functions

 StarSystem (const char *name, Point loc, int iff=0, int s=4)
virtual ~StarSystem ()
int operator== (const StarSystem &s) const
virtual void Load ()
virtual void Create ()
virtual void Destroy ()
virtual void Activate (Scene &scene)
virtual void Deactivate ()
virtual void ExecFrame ()
const char * Name () const
const char * Govt () const
const char * Description () const
int Affiliation () const
int Sequence () const
Point Location () const
int NumStars () const
int NumDust () const
Color Ambient () const
List< OrbitalBody > & Bodies ()
List< OrbitalRegion > & Regions ()
List< OrbitalRegion > & AllRegions ()
OrbitalRegion * ActiveRegion ()
Orbital * FindOrbital (const char *name)
OrbitalRegion * FindRegion (const char *name)
void SetActiveRegion (OrbitalRegion *rgn)
double Radius () const
void SetSunlight (Color color, double brightness=1)
void SetBacklight (Color color, double brightness=1)
void RestoreTrueSunColor ()
bool HasLinkTo (StarSystem *s) const
const Text & GetDataPath () const
+ + + + + + +

+Static Public Member Functions

static const char * TYPENAME ()
static void SetBaseTime (double t, bool absolute=false)
static double GetBaseTime ()
static double Stardate ()
static void CalcStardate ()
+ + + + + + + + + +

+Protected Member Functions

void ParseStar (TermStruct *val)
void ParsePlanet (TermStruct *val)
void ParseMoon (TermStruct *val)
void ParseRegion (TermStruct *val)
void ParseTerrain (TermStruct *val)
void ParseLayer (TerrainRegion *rgn, TermStruct *val)
void CreateBody (OrbitalBody &body)
Point TerrainTransform (const Point &loc)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

char filename [64]
Text name
Text govt
Text description
Text datapath
int affiliation
int seq
Point loc
double radius
bool instantiated
int sky_stars
int sky_dust
Text sky_poly_stars
Text sky_nebula
Text sky_haze
double sky_uscale
double sky_vscale
Color ambient
Color sun_color
double sun_brightness
double sun_scale
List< Light > sun_lights
List< Light > back_lights
Graphic * point_stars
Solid * poly_stars
Solid * nebula
Solid * haze
List< OrbitalBody > bodies
List< OrbitalRegion > regions
List< OrbitalRegion > all_regions
Orbital * center
OrbitalRegion * active_region
Point tvpn
Point tvup
Point tvrt
+ + +

+Static Protected Attributes

static double stardate = 0
+

Detailed Description

+
+

Definition at line 40 of file StarSystem.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StarSystem::StarSystem (const char * name,
Point loc,
int iff = 0,
int s = 4 
)
+
+ +

Definition at line 105 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
StarSystem::~StarSystem ()
+ 		+virtual
+
+ +

Definition at line 117 of file StarSystem.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
void StarSystem::Activate (Scene & scene)
+ 		+virtual
+
+ +

Definition at line 1197 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
OrbitalRegion* StarSystem::ActiveRegion ()
+ 		+inline
+
+ +

Definition at line 74 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int StarSystem::Affiliation () const
+ 		+inline
+
+ +

Definition at line 64 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<OrbitalRegion>& StarSystem::AllRegions ()
+ 		+inline
+
+ +

Definition at line 73 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + + + +
Color StarSystem::Ambient () const
+
+ +

Definition at line 1712 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<OrbitalBody>& StarSystem::Bodies ()
+ 		+inline
+
+ +

Definition at line 71 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarSystem::CalcStardate ()
+ 		+static
+
+ +

Definition at line 78 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarSystem::Create ()
+ 		+virtual
+
+ +

Definition at line 980 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void StarSystem::CreateBody (OrbitalBody & body)
+ 		+protected
+
+ +

Definition at line 1058 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarSystem::Deactivate ()
+ 		+virtual
+
+ +

Definition at line 1267 of file StarSystem.cpp.

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

Definition at line 63 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarSystem::Destroy ()
+ 		+virtual
+
+ +

Definition at line 1159 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarSystem::ExecFrame ()
+ 		+virtual
+
+ +

Definition at line 1407 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + + + + +
Orbital * StarSystem::FindOrbital (const char * name)
+
+ +

Definition at line 1607 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + + + + +
OrbitalRegion * StarSystem::FindRegion (const char * name)
+
+ +

Definition at line 1660 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double StarSystem::GetBaseTime ()
+ 		+static
+
+ +

Definition at line 73 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& StarSystem::GetDataPath () const
+ 		+inline
+
+ +

Definition at line 91 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* StarSystem::Govt () const
+ 		+inline
+
+ +

Definition at line 62 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + + + + +
bool StarSystem::HasLinkTo (StarSystem * s) const
+
+ +

Definition at line 1677 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void StarSystem::Load ()
+ 		+virtual
+
+ +

Definition at line 140 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Point StarSystem::Location () const
+ 		+inline
+
+ +

Definition at line 66 of file StarSystem.h.

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

Definition at line 61 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int StarSystem::NumDust () const
+ 		+inline
+
+ +

Definition at line 68 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int StarSystem::NumStars () const
+ 		+inline
+
+ +

Definition at line 67 of file StarSystem.h.

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

Definition at line 48 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void StarSystem::ParseLayer (TerrainRegion * rgn,
TermStruct * val 
)
+ 		+protected
+
+ +

Definition at line 951 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void StarSystem::ParseMoon (TermStruct * val)
+ 		+protected
+
+ +

Definition at line 547 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void StarSystem::ParsePlanet (TermStruct * val)
+ 		+protected
+
+ +

Definition at line 402 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void StarSystem::ParseRegion (TermStruct * val)
+ 		+protected
+
+ +

Definition at line 659 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void StarSystem::ParseStar (TermStruct * val)
+ 		+protected
+
+ +

Definition at line 312 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void StarSystem::ParseTerrain (TermStruct * val)
+ 		+protected
+
+ +

Definition at line 728 of file StarSystem.cpp.

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

Definition at line 85 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<OrbitalRegion>& StarSystem::Regions ()
+ 		+inline
+
+ +

Definition at line 72 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + + + +
void StarSystem::RestoreTrueSunColor ()
+
+ +

Definition at line 1760 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int StarSystem::Sequence () const
+ 		+inline
+
+ +

Definition at line 65 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + + + + +
void StarSystem::SetActiveRegion (OrbitalRegion * rgn)
+
+ +

Definition at line 1316 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void StarSystem::SetBacklight (Color color,
double brightness = 1 
)
+
+ +

Definition at line 1749 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void StarSystem::SetBaseTime (double t,
bool absolute = false 
)
+ 		+static
+
+ +

Definition at line 57 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void StarSystem::SetSunlight (Color color,
double brightness = 1 
)
+
+ +

Definition at line 1729 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static double StarSystem::Stardate ()
+ 		+inlinestatic
+
+ +

Definition at line 83 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Point StarSystem::TerrainTransform (const Point & loc)
+ 		+protected
+
+ +

Definition at line 1698 of file StarSystem.cpp.

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

Definition at line 43 of file StarSystem.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
OrbitalRegion* StarSystem::active_region
+ 		+protected
+
+ +

Definition at line 140 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int StarSystem::affiliation
+ 		+protected
+
+ +

Definition at line 109 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<OrbitalRegion> StarSystem::all_regions
+ 		+protected
+
+ +

Definition at line 137 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color StarSystem::ambient
+ 		+protected
+
+ +

Definition at line 123 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Light> StarSystem::back_lights
+ 		+protected
+
+ +

Definition at line 128 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<OrbitalBody> StarSystem::bodies
+ 		+protected
+
+ +

Definition at line 135 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Orbital* StarSystem::center
+ 		+protected
+
+ +

Definition at line 139 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text StarSystem::datapath
+ 		+protected
+
+ +

Definition at line 108 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text StarSystem::description
+ 		+protected
+
+ +

Definition at line 107 of file StarSystem.h.

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

Definition at line 104 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text StarSystem::govt
+ 		+protected
+
+ +

Definition at line 106 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Solid* StarSystem::haze
+ 		+protected
+
+ +

Definition at line 133 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool StarSystem::instantiated
+ 		+protected
+
+ +

Definition at line 114 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point StarSystem::loc
+ 		+protected
+
+ +

Definition at line 111 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text StarSystem::name
+ 		+protected
+
+ +

Definition at line 105 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Solid* StarSystem::nebula
+ 		+protected
+
+ +

Definition at line 132 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Graphic* StarSystem::point_stars
+ 		+protected
+
+ +

Definition at line 130 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Solid* StarSystem::poly_stars
+ 		+protected
+
+ +

Definition at line 131 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double StarSystem::radius
+ 		+protected
+
+ +

Definition at line 113 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<OrbitalRegion> StarSystem::regions
+ 		+protected
+
+ +

Definition at line 136 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int StarSystem::seq
+ 		+protected
+
+ +

Definition at line 110 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int StarSystem::sky_dust
+ 		+protected
+
+ +

Definition at line 117 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text StarSystem::sky_haze
+ 		+protected
+
+ +

Definition at line 120 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text StarSystem::sky_nebula
+ 		+protected
+
+ +

Definition at line 119 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text StarSystem::sky_poly_stars
+ 		+protected
+
+ +

Definition at line 118 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int StarSystem::sky_stars
+ 		+protected
+
+ +

Definition at line 116 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double StarSystem::sky_uscale
+ 		+protected
+
+ +

Definition at line 121 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double StarSystem::sky_vscale
+ 		+protected
+
+ +

Definition at line 122 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double StarSystem::stardate = 0
+ 		+staticprotected
+
+ +

Definition at line 112 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double StarSystem::sun_brightness
+ 		+protected
+
+ +

Definition at line 125 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color StarSystem::sun_color
+ 		+protected
+
+ +

Definition at line 124 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Light> StarSystem::sun_lights
+ 		+protected
+
+ +

Definition at line 127 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double StarSystem::sun_scale
+ 		+protected
+
+ +

Definition at line 126 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point StarSystem::tvpn
+ 		+protected
+
+ +

Definition at line 142 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point StarSystem::tvrt
+ 		+protected
+
+ +

Definition at line 142 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point StarSystem::tvup
+ 		+protected
+
+ +

Definition at line 142 of file StarSystem.h.

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