Home · All Namespaces · All Classes · Functions · Coding Style · Scripting · Plugins · File Structure

SolarSystem Class Reference

This StelObjectModule derivative is used to model SolarSystem boies. More...

#include <SolarSystem.hpp>

Inherits StelObjectModule.

List of all members.

Public Slots

void setFlagPlanets (bool b)
bool getFlagPlanets () const
void setFlagTrails (bool b)
bool getFlagTrails () const
void setFlagHints (bool b)
bool getFlagHints () const
void setFlagLabels (bool b)
bool getFlagLabels () const
void setLabelsAmount (float a)
float getLabelsAmount (void) const
void setFlagOrbits (bool b)
bool getFlagOrbits () const
void setFlagLightTravelTime (bool b)
bool getFlagLightTravelTime (void) const
void setFontSize (float newFontSize)
void setLabelsColor (const Vec3f &c)
const Vec3fgetLabelsColor (void) const
void setOrbitsColor (const Vec3f &c)
Vec3f getOrbitsColor (void) const
void setTrailsColor (const Vec3f &c)
Vec3f getTrailsColor () const
void setFlagMoonScale (bool b)
bool getFlagMoonScale (void) const
void setMoonScale (float f)
float getMoonScale (void) const

Public Member Functions

virtual void init ()
virtual void draw (StelCore *core)
virtual void update (double deltaTime)
virtual void updateI18n ()
virtual void selectedObjectChangeCallBack (StelModuleSelectAction action=StelModule::ReplaceSelection)
virtual void setStelStyle (const StelStyle &style)
virtual double getCallOrder (StelModuleActionName actionName) const
virtual QList< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const
virtual StelObjectP searchByName (const QString &name) const
virtual QStringList listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5) const
PlanetP searchByEnglishName (QString planetEnglishName) const
PlanetP getSun () const
PlanetP getEarth () const
PlanetP getMoon () const
bool nearLunarEclipse ()
QStringList getAllPlanetEnglishNames () const
QString getPlanetHashString ()
void computePositions (double date, const Vec3d &observerPos=Vec3d(0.))
const QList< PlanetP > & getAllPlanets () const


Detailed Description

This StelObjectModule derivative is used to model SolarSystem boies.

This includes the Major Planets, Minor Planets and Comets.


Member Function Documentation

virtual void SolarSystem::init (  )  [virtual]

Initialize the SolarSystem.

Includes:

  • loading planetary body orbital and model data from data/ssystem.ini
  • perform initial planet position calculation
  • set display options from application settings

Implements StelModule.

virtual void SolarSystem::draw ( StelCore core  )  [virtual]

Draw SolarSystem objects (planets).

Parameters:
core The StelCore object.
Returns:
The maximum squared distance in pixels that any SolarSystem object has travelled since the last update.

Reimplemented from StelModule.

virtual void SolarSystem::update ( double  deltaTime  )  [virtual]

Update time-varying components.

This includes planet motion trails.

Implements StelModule.

virtual void SolarSystem::updateI18n (  )  [virtual]

Translate names.

Reimplemented from StelModule.

virtual void SolarSystem::selectedObjectChangeCallBack ( StelModuleSelectAction  action = StelModule::ReplaceSelection  )  [virtual]

Called when a new object is selected.

Reimplemented from StelModule.

virtual void SolarSystem::setStelStyle ( const StelStyle style  )  [virtual]

Load a color scheme.

Reimplemented from StelModule.

virtual double SolarSystem::getCallOrder ( StelModuleActionName  actionName  )  const [virtual]

Used to determine what order to draw the various StelModules.

Reimplemented from StelModule.

virtual QList<StelObjectP> SolarSystem::searchAround ( const Vec3d v,
double  limitFov,
const StelCore core 
) const [virtual]

Search for SolarSystem objects in some area around a point.

Parameters:
v A vector representing a point in the sky.
limitFov The radius of the circle around the point v which defines the size of the area to search.
core the core object
Returns:
A STL vector of SpelObjectP (pointers) containing all SolarSystem objects found in the specified area. This vector is not sorted by distance from v.

Implements StelObjectModule.

virtual StelObjectP SolarSystem::searchByNameI18n ( const QString &  nameI18n  )  const [virtual]

Search for a SolarSystem object based on the localised name.

Parameters:
nameI18n the case in-sensistive translated planet name.
Returns:
a StelObjectP for the object if found, else NULL.

Implements StelObjectModule.

virtual StelObjectP SolarSystem::searchByName ( const QString &  name  )  const [virtual]

Search for a SolarSystem object based on the English name.

Parameters:
name the case in-sensistive English planet name.
Returns:
a StelObjectP for the object if found, else NULL.

Implements StelObjectModule.

virtual QStringList SolarSystem::listMatchingObjectsI18n ( const QString &  objPrefix,
int  maxNbItem = 5 
) const [virtual]

Find objects by translated name prefix.

Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name.

Parameters:
objPrefix the case insensitive first letters of the searched object.
maxNbItem the maximum number of returned object names.
Returns:
a list of matching object name by order of relevance, or an empty list if nothing matches.

Implements StelObjectModule.

void SolarSystem::setFlagPlanets ( bool  b  )  [slot]

Set flag which determines if planets are drawn or hidden.

bool SolarSystem::getFlagPlanets (  )  const [slot]

Get the current value of the flag which determines if planet are drawn or hidden.

void SolarSystem::setFlagTrails ( bool  b  )  [slot]

Set flag which determines if planet trails are drawn or hidden.

bool SolarSystem::getFlagTrails (  )  const [slot]

Get the current value of the flag which determines if planet trails are drawn or hidden.

void SolarSystem::setFlagHints ( bool  b  )  [slot]

Set flag which determines if planet hints are drawn or hidden along labels.

bool SolarSystem::getFlagHints (  )  const [slot]

Get the current value of the flag which determines if planet hints are drawn or hidden along labels.

void SolarSystem::setFlagLabels ( bool  b  )  [slot]

Set flag which determines if planet labels are drawn or hidden.

bool SolarSystem::getFlagLabels (  )  const [slot]

Get the current value of the flag which determines if planet labels are drawn or hidden.

void SolarSystem::setLabelsAmount ( float  a  )  [inline, slot]

Set the amount of planet labels.

The real amount is also proportional with FOV. The limit is set in function of the planets magnitude

Parameters:
a the amount between 0 and 10. 0 is no labels, 10 is maximum of labels

float SolarSystem::getLabelsAmount ( void   )  const [inline, slot]

Get the amount of planet labels.

The real amount is also proportional with FOV.

Returns:
the amount between 0 and 10. 0 is no labels, 10 is maximum of labels

void SolarSystem::setFlagOrbits ( bool  b  )  [slot]

Set flag which determines if planet orbits are drawn or hidden.

bool SolarSystem::getFlagOrbits ( void   )  const [inline, slot]

Get the current value of the flag which determines if planet orbits are drawn or hidden.

void SolarSystem::setFlagLightTravelTime ( bool  b  )  [slot]

Set flag which determines if the light travel time calculation is used or not.

bool SolarSystem::getFlagLightTravelTime ( void   )  const [inline, slot]

Get the current value of the flag which determines if light travel time calculation is used or not.

void SolarSystem::setFontSize ( float  newFontSize  )  [slot]

Set planet names font size.

void SolarSystem::setLabelsColor ( const Vec3f c  )  [slot]

Set the color used to draw planet labels.

const Vec3f& SolarSystem::getLabelsColor ( void   )  const [slot]

Get the current color used to draw planet labels.

void SolarSystem::setOrbitsColor ( const Vec3f c  )  [slot]

Set the color used to draw planet orbit lines.

Vec3f SolarSystem::getOrbitsColor ( void   )  const [slot]

Get the current color used to draw planet orbit lines.

void SolarSystem::setTrailsColor ( const Vec3f c  )  [inline, slot]

Set the color used to draw planet trails lines.

Vec3f SolarSystem::getTrailsColor (  )  const [inline, slot]

Get the current color used to draw planet trails lines.

void SolarSystem::setFlagMoonScale ( bool  b  )  [slot]

Set flag which determines if Earth's moon is scaled or not.

bool SolarSystem::getFlagMoonScale ( void   )  const [inline, slot]

Get the current value of the flag which determines if Earth's moon is scaled or not.

void SolarSystem::setMoonScale ( float  f  )  [slot]

Set the display scaling factor for Earth's moon.

float SolarSystem::getMoonScale ( void   )  const [inline, slot]

Get the display scaling factor for Earth's oon.

PlanetP SolarSystem::searchByEnglishName ( QString  planetEnglishName  )  const

Get a pointer to a Planet object.

Parameters:
planetEnglishName the English name of the desired planet.
Returns:
The matching planet pointer if exists or NULL.

PlanetP SolarSystem::getSun (  )  const [inline]

Get the Planet object pointer for the Sun.

PlanetP SolarSystem::getEarth (  )  const [inline]

Get the Planet object pointer for the Earth.

PlanetP SolarSystem::getMoon (  )  const [inline]

Get the Planet object pointer for Earth's moon.

bool SolarSystem::nearLunarEclipse (  ) 

Determine if a lunar eclipse is close at hand?

QStringList SolarSystem::getAllPlanetEnglishNames (  )  const

Get the list of all the planet english names.

QString SolarSystem::getPlanetHashString (  ) 

Get a hash of locale and ssystem.ini names for use with the TUI.

Returns:
A newline delimited hash of localized:standard planet names. Planet translated name is PARENT : NAME

void SolarSystem::computePositions ( double  date,
const Vec3d observerPos = Vec3d(0.) 
)

Compute the position and transform matrix for every element of the solar system.

Parameters:
observerPos Position of the observer in heliocentric ecliptic frame (Required for light travel time computation).
date the date in JDay

const QList<PlanetP>& SolarSystem::getAllPlanets (  )  const [inline]

Get the list of all the bodies of the solar system.


Generated on Mon Mar 22 09:55:38 2010 for Stellarium by  doxygen 1.5.5