SolarSystem Class Reference

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

#include <SolarSystem.hpp>

List of all members.

Public Slots
void	setFlagPlanets (bool b)
	Set flag which determines if planets are drawn or hidden.
bool	getFlagPlanets () const
	Get the current value of the flag which determines if planet are drawn or hidden.
void	setFlagTrails (bool b)
	Set flag which determines if planet trails are drawn or hidden.
bool	getFlagTrails () const
	Get the current value of the flag which determines if planet trails are drawn or hidden.
void	setFlagHints (bool b)
	Set flag which determines if planet hints are drawn or hidden along labels.
bool	getFlagHints () const
	Get the current value of the flag which determines if planet hints are drawn or hidden along labels.
void	setFlagLabels (bool b)
	Set flag which determines if planet labels are drawn or hidden.
bool	getFlagLabels () const
	Get the current value of the flag which determines if planet labels are drawn or hidden.
void	setLabelsAmount (float a)
	Set the amount of planet labels.
float	getLabelsAmount (void) const
	Get the amount of planet labels.
void	setFlagOrbits (bool b)
	Set flag which determines if planet orbits are drawn or hidden.
bool	getFlagOrbits () const
	Get the current value of the flag which determines if planet orbits are drawn or hidden.
void	setFlagLightTravelTime (bool b)
	Set flag which determines if the light travel time calculation is used or not.
bool	getFlagLightTravelTime (void) const
	Get the current value of the flag which determines if light travel time calculation is used or not.
void	setFontSize (float newFontSize)
	Set planet names font size.
void	setLabelsColor (const Vec3f &c)
	Set the color used to draw planet labels.
const Vec3f &	getLabelsColor (void) const
	Get the current color used to draw planet labels.
void	setOrbitsColor (const Vec3f &c)
	Set the color used to draw planet orbit lines.
Vec3f	getOrbitsColor (void) const
	Get the current color used to draw planet orbit lines.
void	setTrailsColor (const Vec3f &c)
	Set the color used to draw planet trails lines.
Vec3f	getTrailsColor () const
	Get the current color used to draw planet trails lines.
void	setFlagMoonScale (bool b)
	Set flag which determines if Earth's moon is scaled or not.
bool	getFlagMoonScale (void) const
	Get the current value of the flag which determines if Earth's moon is scaled or not.
void	setMoonScale (float f)
	Set the display scaling factor for Earth's moon.
float	getMoonScale (void) const
	Get the display scaling factor for Earth's oon.
void	updateI18n ()
	Translate names. (public so that SolarSystemEditor can call it).
float	getPlanetVMagnitude (QString planetName, bool withExtinction=false) const
	Get the V magnitude for Solar system bodies from scripts.
double	getDistanceToPlanet (QString planetName) const
	Get distance to Solar system bodies from scripts.
double	getElongationForPlanet (QString planetName) const
	Get elongation for Solar system bodies from scripts.
double	getPhaseAngleForPlanet (QString planetName) const
	Get phase angle for Solar system bodies from scripts.
float	getPhaseForPlanet (QString planetName) const
	Get phase for Solar system bodies from scripts.
Public Member Functions
virtual void	init ()
	Initialize the SolarSystem.
virtual void	draw (StelCore *core, class StelRenderer *renderer)
	Draw SolarSystem objects (planets).
virtual void	update (double deltaTime)
	Update time-varying components.
virtual double	getCallOrder (StelModuleActionName actionName) const
	Used to determine what order to draw the various StelModules.
virtual QList< StelObjectP >	searchAround (const Vec3d &v, double limitFov, const StelCore *core) const
	Search for SolarSystem objects in some area around a point.
virtual StelObjectP	searchByNameI18n (const QString &nameI18n) const
	Search for a SolarSystem object based on the localised name.
virtual StelObjectP	searchByName (const QString &name) const
	Search for a SolarSystem object based on the English name.
virtual QStringList	listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5) const
	Find objects by translated name prefix.
virtual QStringList	listAllObjects (bool inEnglish) const
virtual QString	getName () const
PlanetP	searchByEnglishName (QString planetEnglishName) const
	Get a pointer to a Planet object.
PlanetP	getSun () const
	Get the Planet object pointer for the Sun.
PlanetP	getEarth () const
	Get the Planet object pointer for the Earth.
PlanetP	getMoon () const
	Get the Planet object pointer for Earth's moon.
bool	nearLunarEclipse ()
	Determine if a lunar eclipse is close at hand?
QStringList	getAllPlanetEnglishNames () const
	Get the list of all the planet english names.
QStringList	getAllPlanetLocalizedNames () const
	Get the list of all the planet localized names.
void	reloadPlanets ()
	Reload the planets.
double	getEclipseFactor (const StelCore *core) const
	Determines relative amount of sun visible from the observer's position.
QString	getPlanetHashString ()
	Get a hash of locale and ssystem.ini names for use with the TUI.
void	computePositions (double date, const Vec3d &observerPos=Vec3d(0.))
	Compute the position and transform matrix for every element of the solar system.
const QList< PlanetP > &	getAllPlanets () const
	Get the list of all the bodies of the solar system.

---

Detailed Description

This StelObjectModule derivative is used to model SolarSystem bodies.

This includes the Major Planets, Minor Planets and Comets.

Definition at line 44 of file SolarSystem.hpp.

---

Member Function Documentation

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

Deprecated:

??? In the "deprecated" section, but used in SolarSystem::init()

virtual void SolarSystem::draw	(	StelCore *	core,
		class StelRenderer *	renderer
	)			[virtual]

Draw SolarSystem objects (planets).

Parameters:

	core	The StelCore object.
	renderer	Renderer to use for drawing.

Returns:

The maximum squared distance in pixels that any SolarSystem object has travelled since the last update.

Reimplemented from StelModule.

QStringList SolarSystem::getAllPlanetEnglishNames

(

)

const

Get the list of all the planet english names.

QStringList SolarSystem::getAllPlanetLocalizedNames

(

)

const

Get the list of all the planet localized names.

const QList<PlanetP>& SolarSystem::getAllPlanets

(

)

const [inline]

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

Deprecated:

Used in LandscapeMgr::update(), but commented out.

Definition at line 256 of file SolarSystem.hpp.

virtual double SolarSystem::getCallOrder

(

StelModuleActionName

actionName

)

const [virtual]

Used to determine what order to draw the various StelModules.

Reimplemented from StelModule.

double SolarSystem::getDistanceToPlanet

(

QString

planetName

)

const [slot]

Get distance to Solar system bodies from scripts.

Parameters:

planetName

the case in-sensistive English planet name.

Returns:

a distance (in AU)

PlanetP SolarSystem::getEarth

(

)

const [inline]

Get the Planet object pointer for the Earth.

Definition at line 219 of file SolarSystem.hpp.

double SolarSystem::getEclipseFactor

(

const StelCore *

core

)

const

Determines relative amount of sun visible from the observer's position.

double SolarSystem::getElongationForPlanet

(

QString

planetName

)

const [slot]

Get elongation for Solar system bodies from scripts.

Parameters:

planetName

the case in-sensistive English planet name.

Returns:

a elongation (in radians)

bool SolarSystem::getFlagHints

(

)

const [slot]

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

bool SolarSystem::getFlagLabels

(

)

const [slot]

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

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.

Definition at line 148 of file SolarSystem.hpp.

bool SolarSystem::getFlagMoonScale

(

void

)

const [inline, slot]

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

Definition at line 171 of file SolarSystem.hpp.

bool SolarSystem::getFlagOrbits

(

void

)

const [inline, slot]

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

Definition at line 142 of file SolarSystem.hpp.

bool SolarSystem::getFlagPlanets

(

)

const [slot]

Get the current value of the flag which determines if planet 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.

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

Definition at line 137 of file SolarSystem.hpp.

const Vec3f& SolarSystem::getLabelsColor

(

void

)

const [slot]

Get the current color used to draw planet labels.

PlanetP SolarSystem::getMoon

(

)

const [inline]

Get the Planet object pointer for Earth's moon.

Definition at line 222 of file SolarSystem.hpp.

float SolarSystem::getMoonScale

(

void

)

const [inline, slot]

Get the display scaling factor for Earth's oon.

Definition at line 176 of file SolarSystem.hpp.

Vec3f SolarSystem::getOrbitsColor

(

void

)

const [slot]

Get the current color used to draw planet orbit lines.

double SolarSystem::getPhaseAngleForPlanet

(

QString

planetName

)

const [slot]

Get phase angle for Solar system bodies from scripts.

Parameters:

planetName

the case in-sensistive English planet name.

Returns:

a phase angle (in radians)

float SolarSystem::getPhaseForPlanet

(

QString

planetName

)

const [slot]

Get phase for Solar system bodies from scripts.

Parameters:

planetName

the case in-sensistive English planet name.

Returns:

a phase

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

Deprecated:

???

float SolarSystem::getPlanetVMagnitude	(	QString	planetName,
		bool	withExtinction = false
	)			const [slot]

Get the V magnitude for Solar system bodies from scripts.

Parameters:

	planetName	the case in-sensistive English planet name.
	withExtinction	the flag for use extinction effect for magnitudes (default not use)

Returns:

a magnitude

PlanetP SolarSystem::getSun

(

)

const [inline]

Get the Planet object pointer for the Sun.

Definition at line 216 of file SolarSystem.hpp.

Vec3f SolarSystem::getTrailsColor

(

)

const [inline, slot]

Get the current color used to draw planet trails lines.

Definition at line 166 of file SolarSystem.hpp.

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 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.

bool SolarSystem::nearLunarEclipse

(

)

Determine if a lunar eclipse is close at hand?

void SolarSystem::reloadPlanets

(

)

Reload the planets.

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 StelObjectP (pointers) containing all SolarSystem objects found in the specified area. This vector is not sorted by distance from v.

Implements StelObjectModule.

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.

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 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.

void SolarSystem::setFlagHints

(

bool

b

)

[slot]

Set 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.

void SolarSystem::setFlagLightTravelTime

(

bool

b

)

[slot]

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

void SolarSystem::setFlagMoonScale

(

bool

b

)

[slot]

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

void SolarSystem::setFlagOrbits

(

bool

b

)

[slot]

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

void SolarSystem::setFlagPlanets

(

bool

b

)

[slot]

Set flag which determines if planets are drawn or hidden.

void SolarSystem::setFlagTrails

(

bool

b

)

[slot]

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

void SolarSystem::setFontSize

(

float

newFontSize

)

[slot]

Set planet names font size.

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

Definition at line 134 of file SolarSystem.hpp.

void SolarSystem::setLabelsColor

(

const Vec3f &

c

)

[slot]

Set the color used to draw planet labels.

void SolarSystem::setMoonScale

(

float

f

)

[slot]

Set the display scaling factor for Earth's moon.

void SolarSystem::setOrbitsColor

(

const Vec3f &

c

)

[slot]

Set the color used to draw planet orbit lines.

void SolarSystem::setTrailsColor

(

const Vec3f &

c

)

[inline, slot]

Set the color used to draw planet trails lines.

Definition at line 164 of file SolarSystem.hpp.

virtual void SolarSystem::update

(

double

deltaTime

)

[virtual]

Update time-varying components.

This includes planet motion trails.

Implements StelModule.

void SolarSystem::updateI18n

(

)

[slot]

Translate names. (public so that SolarSystemEditor can call it).

---

The documentation for this class was generated from the following file:

• core/modules/SolarSystem.hpp