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

#include <TerrainRegion.h>

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

List of all members.

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

+Public Member Functions

 TerrainRegion (StarSystem *sys, const char *n, double r, Orbital *prime=0)
virtual ~TerrainRegion ()
virtual void Update ()
const Text & PatchName () const
const Text & PatchTexture () const
const Text & ApronName () const
const Text & ApronTexture () const
const Text & WaterTexture () const
const Text & DetailTexture0 () const
const Text & DetailTexture1 () const
const Text & HazeName () const
const Text & CloudsHigh () const
const Text & ShadesHigh () const
const Text & CloudsLow () const
const Text & ShadesLow () const
const Text & EnvironmentTexture (int n) const
Color SunColor () const
Color SkyColor () const
Color FogColor () const
Color Ambient () const
Color Overcast () const
Color CloudColor () const
Color ShadeColor () const
double LateralScale () const
double MountainScale () const
double FogDensity () const
double FogScale () const
double DayPhase () const
double HazeFade () const
double CloudAltHigh () const
double CloudAltLow () const
Weather & GetWeather ()
List< TerrainLayer > & GetLayers ()
bool IsEclipsed () const
void SetEclipsed (bool e)
void LoadSkyColors (const char *bmp_name)
void AddLayer (double h, const char *tile, const char *detail=0)
- Public Member Functions inherited from OrbitalRegion
 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
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 ()
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

Text patch_name
Text patch_texture
Text apron_name
Text apron_texture
Text water_texture
Text env_texture_positive_x
Text env_texture_negative_x
Text env_texture_positive_y
Text env_texture_negative_y
Text env_texture_positive_z
Text env_texture_negative_z
Text noise_tex0
Text noise_tex1
Text haze_name
Text clouds_high
Text clouds_low
Text shades_high
Text shades_low
Color sun_color [25]
Color sky_color [25]
Color fog_color [25]
Color ambient [25]
Color overcast [25]
Color cloud_color [25]
Color shade_color [25]
double scale
double mtnscale
double fog_density
double fog_scale
double day_phase
double haze_fade
double clouds_alt_high
double clouds_alt_low
Weather weather
bool eclipsed
List< TerrainLayer > layers
- Protected Attributes inherited from OrbitalRegion
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

- Static Public Member Functions inherited from OrbitalRegion
static const char * TYPENAME ()
+

Detailed Description

+
+

Definition at line 30 of file TerrainRegion.h.

+

Constructor & Destructor Documentation

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

Definition at line 37 of file TerrainRegion.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
TerrainRegion::~TerrainRegion ()
+ 		+virtual
+
+ +

Definition at line 61 of file TerrainRegion.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void TerrainRegion::AddLayer (double h,
const char * tile,
const char * detail = 0 
)
+
+ +

Definition at line 224 of file TerrainRegion.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Color TerrainRegion::Ambient () const
+ 		+inline
+
+ +

Definition at line 59 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::ApronName () const
+ 		+inline
+
+ +

Definition at line 44 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::ApronTexture () const
+ 		+inline
+
+ +

Definition at line 45 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double TerrainRegion::CloudAltHigh () const
+ 		+inline
+
+ +

Definition at line 70 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double TerrainRegion::CloudAltLow () const
+ 		+inline
+
+ +

Definition at line 71 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Color TerrainRegion::CloudColor () const
+ 		+inline
+
+ +

Definition at line 61 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::CloudsHigh () const
+ 		+inline
+
+ +

Definition at line 50 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::CloudsLow () const
+ 		+inline
+
+ +

Definition at line 52 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double TerrainRegion::DayPhase () const
+ 		+inline
+
+ +

Definition at line 68 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::DetailTexture0 () const
+ 		+inline
+
+ +

Definition at line 47 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::DetailTexture1 () const
+ 		+inline
+
+ +

Definition at line 48 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + + + + +
const Text & TerrainRegion::EnvironmentTexture (int n) const
+
+ +

Definition at line 238 of file TerrainRegion.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Color TerrainRegion::FogColor () const
+ 		+inline
+
+ +

Definition at line 58 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double TerrainRegion::FogDensity () const
+ 		+inline
+
+ +

Definition at line 66 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double TerrainRegion::FogScale () const
+ 		+inline
+
+ +

Definition at line 67 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<TerrainLayer>& TerrainRegion::GetLayers ()
+ 		+inline
+
+ +

Definition at line 73 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Weather& TerrainRegion::GetWeather ()
+ 		+inline
+
+ +

Definition at line 72 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double TerrainRegion::HazeFade () const
+ 		+inline
+
+ +

Definition at line 69 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::HazeName () const
+ 		+inline
+
+ +

Definition at line 49 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool TerrainRegion::IsEclipsed () const
+ 		+inline
+
+ +

Definition at line 75 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double TerrainRegion::LateralScale () const
+ 		+inline
+
+ +

Definition at line 64 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + + + + +
void TerrainRegion::LoadSkyColors (const char * bmp_name)
+
+ +

Definition at line 172 of file TerrainRegion.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double TerrainRegion::MountainScale () const
+ 		+inline
+
+ +

Definition at line 65 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Color TerrainRegion::Overcast () const
+ 		+inline
+
+ +

Definition at line 60 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::PatchName () const
+ 		+inline
+
+ +

Definition at line 42 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::PatchTexture () const
+ 		+inline
+
+ +

Definition at line 43 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void TerrainRegion::SetEclipsed (bool e)
+ 		+inline
+
+ +

Definition at line 76 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Color TerrainRegion::ShadeColor () const
+ 		+inline
+
+ +

Definition at line 62 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::ShadesHigh () const
+ 		+inline
+
+ +

Definition at line 51 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::ShadesLow () const
+ 		+inline
+
+ +

Definition at line 53 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Color TerrainRegion::SkyColor () const
+ 		+inline
+
+ +

Definition at line 57 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Color TerrainRegion::SunColor () const
+ 		+inline
+
+ +

Definition at line 56 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void TerrainRegion::Update ()
+ 		+virtual
+
+ +

Reimplemented from Orbital.

+ +

Definition at line 69 of file TerrainRegion.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& TerrainRegion::WaterTexture () const
+ 		+inline
+
+ +

Definition at line 46 of file TerrainRegion.h.

+ +
+
+

Friends And Related Function Documentation

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

Reimplemented from OrbitalRegion.

+ +

Definition at line 32 of file TerrainRegion.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Color TerrainRegion::ambient[25]
+ 		+protected
+
+ +

Definition at line 104 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::apron_name
+ 		+protected
+
+ +

Definition at line 84 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::apron_texture
+ 		+protected
+
+ +

Definition at line 85 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color TerrainRegion::cloud_color[25]
+ 		+protected
+
+ +

Definition at line 106 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double TerrainRegion::clouds_alt_high
+ 		+protected
+
+ +

Definition at line 116 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double TerrainRegion::clouds_alt_low
+ 		+protected
+
+ +

Definition at line 117 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::clouds_high
+ 		+protected
+
+ +

Definition at line 96 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::clouds_low
+ 		+protected
+
+ +

Definition at line 97 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double TerrainRegion::day_phase
+ 		+protected
+
+ +

Definition at line 114 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool TerrainRegion::eclipsed
+ 		+protected
+
+ +

Definition at line 120 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::env_texture_negative_x
+ 		+protected
+
+ +

Definition at line 88 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::env_texture_negative_y
+ 		+protected
+
+ +

Definition at line 90 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::env_texture_negative_z
+ 		+protected
+
+ +

Definition at line 92 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::env_texture_positive_x
+ 		+protected
+
+ +

Definition at line 87 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::env_texture_positive_y
+ 		+protected
+
+ +

Definition at line 89 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::env_texture_positive_z
+ 		+protected
+
+ +

Definition at line 91 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color TerrainRegion::fog_color[25]
+ 		+protected
+
+ +

Definition at line 103 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double TerrainRegion::fog_density
+ 		+protected
+
+ +

Definition at line 112 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double TerrainRegion::fog_scale
+ 		+protected
+
+ +

Definition at line 113 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double TerrainRegion::haze_fade
+ 		+protected
+
+ +

Definition at line 115 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::haze_name
+ 		+protected
+
+ +

Definition at line 95 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<TerrainLayer> TerrainRegion::layers
+ 		+protected
+
+ +

Definition at line 122 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double TerrainRegion::mtnscale
+ 		+protected
+
+ +

Definition at line 110 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::noise_tex0
+ 		+protected
+
+ +

Definition at line 93 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::noise_tex1
+ 		+protected
+
+ +

Definition at line 94 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color TerrainRegion::overcast[25]
+ 		+protected
+
+ +

Definition at line 105 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::patch_name
+ 		+protected
+
+ +

Definition at line 82 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::patch_texture
+ 		+protected
+
+ +

Definition at line 83 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double TerrainRegion::scale
+ 		+protected
+
+ +

Definition at line 109 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color TerrainRegion::shade_color[25]
+ 		+protected
+
+ +

Definition at line 107 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::shades_high
+ 		+protected
+
+ +

Definition at line 98 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::shades_low
+ 		+protected
+
+ +

Definition at line 99 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color TerrainRegion::sky_color[25]
+ 		+protected
+
+ +

Definition at line 102 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color TerrainRegion::sun_color[25]
+ 		+protected
+
+ +

Definition at line 101 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text TerrainRegion::water_texture
+ 		+protected
+
+ +

Definition at line 86 of file TerrainRegion.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Weather TerrainRegion::weather
+ 		+protected
+
+ +

Definition at line 119 of file TerrainRegion.h.

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