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

#include <SolarSystem.hpp>

Inheritance diagram for SolarSystem:

Collaboration diagram for SolarSystem:

Public Slots
void	setFlagPlanets (bool b)
	Set flag which determines if planets are drawn or hidden. More...

bool	getFlagPlanets () const
	Get the current value of the flag which determines if planet are drawn or hidden. More...

void	setFlagTrails (bool b)
	Set flag which determines if planet trails are drawn or hidden. More...

bool	getFlagTrails () const
	Get the current value of the flag which determines if planet trails are drawn or hidden. More...

void	setFlagHints (bool b)
	Set flag which determines if planet hints are drawn or hidden along labels. More...

bool	getFlagHints () const
	Get the current value of the flag which determines if planet hints are drawn or hidden along labels. More...

void	setFlagLabels (bool b)
	Set flag which determines if planet labels are drawn or hidden. More...

bool	getFlagLabels () const
	Get the current value of the flag which determines if planet labels are drawn or hidden. More...

void	setLabelsAmount (double a)
	Set the amount of planet labels. More...

double	getLabelsAmount (void) const
	Get the amount of planet labels. More...

void	setFlagOrbits (bool b)
	Set flag which determines if planet orbits are drawn or hidden. More...

bool	getFlagOrbits () const
	Get the current value of the flag which determines if planet orbits are drawn or hidden. More...

void	setFlagPointer (bool b)
	Set flag which determines if the planet pointer (red cross) is drawn or hidden on a selected planet. More...

bool	getFlagPointer () const
	Get the current value of the flag which determines if planet pointers are drawn or hidden. More...

void	setFlagLightTravelTime (bool b)
	Set flag which determines if the light travel time calculation is used or not. More...

bool	getFlagLightTravelTime (void) const
	Get the current value of the flag which determines if light travel time calculation is used or not. More...

void	setFlagUseObjModels (bool b)
	Set flag whether to use OBJ models for rendering, where available. More...

bool	getFlagUseObjModels (void) const
	Get the current value of the flag which determines wether to use OBJ models for rendering, where available. More...

void	setFlagShowObjSelfShadows (bool b)
	Set flag whether OBJ models should render self-shadowing (using a shadow map) More...

bool	getFlagShowObjSelfShadows (void) const
	Get the current value of the flag which determines whether OBJ models should render self-shadowing (using a shadow map) More...

void	setFontSize (float newFontSize)
	Set planet names font size. More...

void	setLabelsColor (const Vec3f &c)
	Set the color used to draw planet labels. More...

const Vec3f &	getLabelsColor (void) const
	Get the current color used to draw planet labels. More...

void	setOrbitsColor (const Vec3f &c)
	Set the color used to draw solar system object orbit lines. More...

Vec3f	getOrbitsColor (void) const
	Get the current color used to draw solar system object orbit lines. More...

void	setMajorPlanetsOrbitsColor (const Vec3f &c)
	Set the color used to draw orbits lines of the major planets. More...

Vec3f	getMajorPlanetsOrbitsColor (void) const
	Get the current color used to draw orbits lines of the major planets. More...

void	setMoonsOrbitsColor (const Vec3f &c)
	Set the color used to draw orbits lines of moons of planets. More...

Vec3f	getMoonsOrbitsColor (void) const
	Get the current color used to draw orbits lines of moons of planets. More...

void	setMinorPlanetsOrbitsColor (const Vec3f &c)
	Set the color used to draw orbits lines of the minor planets. More...

Vec3f	getMinorPlanetsOrbitsColor (void) const
	Get the current color used to draw orbits lines of the minor planets. More...

void	setDwarfPlanetsOrbitsColor (const Vec3f &c)
	Set the color used to draw orbits lines of the dwarf planets. More...

Vec3f	getDwarfPlanetsOrbitsColor (void) const
	Get the current color used to draw orbits lines of the dwarf planets. More...

void	setCubewanosOrbitsColor (const Vec3f &c)
	Set the color used to draw orbits lines of cubewanos. More...

Vec3f	getCubewanosOrbitsColor (void) const
	Get the current color used to draw orbits lines of cubewanos. More...

void	setPlutinosOrbitsColor (const Vec3f &c)
	Set the color used to draw orbits lines of plutinos. More...

Vec3f	getPlutinosOrbitsColor (void) const
	Get the current color used to draw orbits lines of plutinos. More...

void	setScatteredDiskObjectsOrbitsColor (const Vec3f &c)
	Set the color used to draw orbits lines of scattered disk objects. More...

Vec3f	getScatteredDiskObjectsOrbitsColor (void) const
	Get the current color used to draw orbits lines of scattered disk objects. More...

void	setOortCloudObjectsOrbitsColor (const Vec3f &c)
	Set the color used to draw orbits lines of Oort cloud objects. More...

Vec3f	getOortCloudObjectsOrbitsColor (void) const
	Get the current color used to draw orbits lines of Oort cloud objects. More...

void	setCometsOrbitsColor (const Vec3f &c)
	Set the color used to draw comet orbit lines. More...

Vec3f	getCometsOrbitsColor (void) const
	Get the current color used to draw comet orbit lines. More...

void	setSednoidsOrbitsColor (const Vec3f &c)
	Set the color used to draw sednoid orbit lines. More...

Vec3f	getSednoidsOrbitsColor (void) const
	Get the current color used to draw sednoid orbit lines. More...

void	setMercuryOrbitColor (const Vec3f &c)
	Set the color used to draw Mercury orbit line. More...

Vec3f	getMercuryOrbitColor (void) const
	Get the current color used to draw Mercury orbit line. More...

void	setVenusOrbitColor (const Vec3f &c)
	Set the color used to draw Venus orbit line. More...

Vec3f	getVenusOrbitColor (void) const
	Get the current color used to draw Venus orbit line. More...

void	setEarthOrbitColor (const Vec3f &c)
	Set the color used to draw Earth orbit line. More...

Vec3f	getEarthOrbitColor (void) const
	Get the current color used to draw Earth orbit line. More...

void	setMarsOrbitColor (const Vec3f &c)
	Set the color used to draw Mars orbit line. More...

Vec3f	getMarsOrbitColor (void) const
	Get the current color used to draw Mars orbit line. More...

void	setJupiterOrbitColor (const Vec3f &c)
	Set the color used to draw Jupiter orbit line. More...

Vec3f	getJupiterOrbitColor (void) const
	Get the current color used to draw Jupiter orbit line. More...

void	setSaturnOrbitColor (const Vec3f &c)
	Set the color used to draw Saturn orbit line. More...

Vec3f	getSaturnOrbitColor (void) const
	Get the current color used to draw Saturn orbit line. More...

void	setUranusOrbitColor (const Vec3f &c)
	Set the color used to draw Uranus orbit line. More...

Vec3f	getUranusOrbitColor (void) const
	Get the current color used to draw Uranus orbit line. More...

void	setNeptuneOrbitColor (const Vec3f &c)
	Set the color used to draw Neptune orbit line. More...

Vec3f	getNeptuneOrbitColor (void) const
	Get the current color used to draw Neptune orbit line. More...

void	setTrailsColor (const Vec3f &c)
	Set the color used to draw planet trails lines. More...

Vec3f	getTrailsColor () const
	Get the current color used to draw planet trails lines. More...

void	setPointerColor (const Vec3f &c)
	Set the color used to draw planet pointers. More...

Vec3f	getPointerColor () const
	Get the current color used to draw planet pointers. More...

void	setFlagMoonScale (bool b)
	Set flag which determines if Earth's moon is scaled or not. More...

bool	getFlagMoonScale (void) const
	Get the current value of the flag which determines if Earth's moon is scaled or not. More...

void	setMoonScale (double f)
	Set the display scaling factor for Earth's moon. More...

double	getMoonScale (void) const
	Get the display scaling factor for Earth's moon. More...

void	setFlagMinorBodyScale (bool b)
	Set flag which determines if minor bodies (everything except the 8 planets) are drawn scaled or not. More...

bool	getFlagMinorBodyScale (void) const
	Get the current value of the flag which determines if minor bodies (everything except the 8 planets) are drawn scaled or not. More...

void	setMinorBodyScale (double f)
	Set the display scaling factor for minor bodies. More...

double	getMinorBodyScale (void) const
	Get the display scaling factor for minor bodies. More...

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

float	getPlanetVMagnitude (QString planetName, bool withExtinction=false) const
	Get the V magnitude for Solar system bodies from scripts. More...

QString	getPlanetType (QString planetName) const
	Get type for Solar system bodies from scripts. More...

double	getDistanceToPlanet (QString planetName) const
	Get distance to Solar system bodies from scripts. More...

double	getElongationForPlanet (QString planetName) const
	Get elongation for Solar system bodies from scripts. More...

double	getPhaseAngleForPlanet (QString planetName) const
	Get phase angle for Solar system bodies from scripts. More...

float	getPhaseForPlanet (QString planetName) const
	Get phase for Solar system bodies from scripts. More...

void	setApparentMagnitudeAlgorithmOnEarth (QString algorithm)
	Set the algorithm for computation of apparent magnitudes for planets in case observer on the Earth. More...

QString	getApparentMagnitudeAlgorithmOnEarth () const
	Get the algorithm used for computation of apparent magnitudes for planets in case observer on the Earth. More...

void	setFlagNativePlanetNames (bool b)
	Set flag which enable use native names for planets or not. More...

bool	getFlagNativePlanetNames (void) const
	Get the current value of the flag which enables showing native names for planets or not. More...

void	setFlagTranslatedNames (bool b)
	Set flag which enable use translated names for planets or not. More...

bool	getFlagTranslatedNames (void) const
	Get the current value of the flag which enables showing translated names for planets or not. More...

void	setFlagIsolatedTrails (bool b)
	Set flag which enabled the showing of isolated trails for selected objects only or not. More...

bool	getFlagIsolatedTrails (void) const
	Get the current value of the flag which enables showing of isolated trails for selected objects only or not. More...

void	setFlagIsolatedOrbits (bool b)
	Set flag which enabled the showing of isolated orbits for selected objects only or not. More...

bool	getFlagIsolatedOrbits (void) const
	Get the current value of the flag which enables showing of isolated orbits for selected objects only or not. More...

void	setFlagCustomGrsSettings (bool b)
	Set flag which determines if custom settings is using for Great Red Spot on Jupiter. More...

bool	getFlagCustomGrsSettings ()
	Get the current value of the flag which determines if custom settings for Great Red Spot on Jupiter is used or not. More...

void	setCustomGrsLongitude (int longitude)
	Set longitude of Great Red Spot (System II is used) More...

int	getCustomGrsLongitude ()
	Get longitude of Great Red Spot (System II is used) More...

void	setCustomGrsDrift (double drift)
	Set speed of annual drift for Great Red Spot (System II is used) More...

double	getCustomGrsDrift ()
	Get speed of annual drift for Great Red Spot (System II is used) More...

void	setCustomGrsJD (double JD)
	Set initial JD for calculation of position of Great Red Spot. More...

double	getCustomGrsJD ()
	Get initial JD for calculation of position of Great Red Spot. More...

void	setOrbitColorStyle (QString style)
	Set style of colors of orbits for Solar system bodies. More...

QString	getOrbitColorStyle () const
	Get style of colors of orbits for Solar system bodies. More...

QStringList	getObjectsList (QString objType="all") const
	Get list of objects by type. More...

Signals
void	labelsDisplayedChanged (bool b)

void	flagOrbitsChanged (bool b)

void	flagHintsChanged (bool b)

void	trailsDisplayedChanged (bool b)

void	flagPointerChanged (bool b)

void	flagNativePlanetNamesChanged (bool b)

void	flagTranslatedNamesChanged (bool b)

void	flagPlanetsDisplayedChanged (bool b)

void	flagIsolatedOrbitsChanged (bool b)

void	flagIsolatedTrailsChanged (bool b)

void	flagLightTravelTimeChanged (bool b)

void	flagUseObjModelsChanged (bool b)

void	flagShowObjSelfShadowsChanged (bool b)

void	flagMoonScaleChanged (bool b)

void	moonScaleChanged (double f)

void	flagMinorBodyScaleChanged (bool b)

void	minorBodyScaleChanged (double f)

void	labelsAmountChanged (double f)

void	ephemerisMarkersChanged (bool b)

void	ephemerisHorizontalCoordinatesChanged (bool b)

void	ephemerisDatesChanged (bool b)

void	ephemerisMagnitudesChanged (bool b)

void	flagCustomGrsSettingsChanged (bool b)

void	customGrsLongitudeChanged (int l)

void	customGrsDriftChanged (double drift)

void	customGrsJDChanged (double JD)

void	orbitsColorChanged (const Vec3f &color) const

void	majorPlanetsOrbitsColorChanged (const Vec3f &color) const

void	minorPlanetsOrbitsColorChanged (const Vec3f &color) const

void	dwarfPlanetsOrbitsColorChanged (const Vec3f &color) const

void	moonsOrbitsColorChanged (const Vec3f &color) const

void	cubewanosOrbitsColorChanged (const Vec3f &color) const

void	plutinosOrbitsColorChanged (const Vec3f &color) const

void	scatteredDiskObjectsOrbitsColorChanged (const Vec3f &color) const

void	oortCloudObjectsOrbitsColorChanged (const Vec3f &color) const

void	cometsOrbitsColorChanged (const Vec3f &color) const

void	sednoidsOrbitsColorChanged (const Vec3f &color) const

void	mercuryOrbitColorChanged (const Vec3f &color) const

void	venusOrbitColorChanged (const Vec3f &color) const

void	earthOrbitColorChanged (const Vec3f &color) const

void	marsOrbitColorChanged (const Vec3f &color) const

void	jupiterOrbitColorChanged (const Vec3f &color) const

void	saturnOrbitColorChanged (const Vec3f &color) const

void	uranusOrbitColorChanged (const Vec3f &color) const

void	neptuneOrbitColorChanged (const Vec3f &color) const

void	orbitColorStyleChanged (QString style) const

void	solarSystemDataReloaded ()

Public Member Functions
virtual void	init ()
	Initialize the SolarSystem. More...

virtual void	deinit ()
	Called before the module will be delete, and before the openGL context is suppressed. More...

virtual void	draw (StelCore *core)
	Draw SolarSystem objects (planets). More...

virtual void	update (double deltaTime)
	Update time-varying components. More...

virtual double	getCallOrder (StelModuleActionName actionName) const
	Used to determine what order to draw the various StelModules. More...

virtual QList< StelObjectP >	searchAround (const Vec3d &v, double limitFov, const StelCore *core) const
	Search for SolarSystem objects in some area around a point. More...

virtual StelObjectP	searchByNameI18n (const QString &nameI18n) const
	Search for a SolarSystem object based on the localised name. More...

virtual StelObjectP	searchByName (const QString &name) const
	Search for a SolarSystem object based on the English name. More...

virtual StelObjectP	searchByID (const QString &id) const
	Return the StelObject with the given ID if exists or the empty StelObject if not found. More...

virtual QStringList	listAllObjects (bool inEnglish) const
	List all StelObjects. More...

virtual QStringList	listAllObjectsByType (const QString &objType, bool inEnglish) const
	List all StelObjects by type. More...

virtual QString	getName () const
	Gets a user-displayable name of the object category. More...

virtual QString	getStelObjectType () const
	Returns the name that will be returned by StelObject::getType() for the objects this module manages. More...

PlanetP	searchByEnglishName (QString planetEnglishName) const
	Get a pointer to a Planet object. More...

PlanetP	searchMinorPlanetByEnglishName (QString planetEnglishName) const

PlanetP	getSun () const
	Get the Planet object pointer for the Sun. More...

PlanetP	getEarth () const
	Get the Planet object pointer for the Earth. More...

PlanetP	getMoon () const
	Get the Planet object pointer for Earth's moon. More...

bool	nearLunarEclipse ()
	Determine if a lunar eclipse is close at hand? More...

QStringList	getAllPlanetEnglishNames () const
	Get the list of all the planet english names. More...

QStringList	getAllPlanetLocalizedNames () const
	Get the list of all the planet localized names. More...

QStringList	getAllMinorPlanetCommonEnglishNames () const
	Get the list of all the minor planet common english names. More...

void	reloadPlanets ()
	Reload the planets. More...

bool	removeMinorPlanet (QString name)
	New 0.16: delete a planet from the solar system. Writes a warning to log if this is not a minor object. More...

double	getEclipseFactor (const StelCore *core) const
	Determines relative amount of sun visible from the observer's position. More...

void	computePositions (double dateJDE, PlanetP observerPlanet)
	Compute the position and transform matrix for every element of the solar system. More...

const QList< PlanetP > &	getAllPlanets () const
	Get the list of all the bodies of the solar system. More...

const QList< PlanetP > &	getAllMinorBodies () const
	Get the list of all the bodies of the solar system. More...

const QStringList	getMinorBodiesList () const
	Get the list of all minor bodies names. More...

const Vec3d	getLightTimeSunPosition () const
	Get lighttime corrected solar position (essential to draw the sun during solar eclipse and compute things like eclipse factor etc, until we get aberration working.) More...

Public Member Functions inherited from StelObjectModule
virtual QStringList	listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const
	Find and return the list of at most maxNbItem objects auto-completing passed object name. More...

bool	matchObjectName (const QString &objName, const QString &objPrefix, bool useStartOfWords) const
	Auxiliary method of listMatchingObjects() More...

Public Member Functions inherited from StelModule
virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version. More...

virtual QString	getAuthorName () const
	Get the name of the module author. More...

virtual QString	getAuthorEmail () const
	Get the email adress of the module author. More...

virtual void	handleMouseClicks (class QMouseEvent *)
	Handle mouse clicks. More...

virtual void	handleMouseWheel (class QWheelEvent *)
	Handle mouse wheel. More...

virtual bool	handleMouseMoves (int x, int y, Qt::MouseButtons b)
	Handle mouse moves. More...

virtual void	handleKeys (class QKeyEvent *e)
	Handle key events. More...

virtual bool	handlePinch (qreal scale, bool started)
	Handle pinch gesture events. More...

virtual bool	configureGui (bool show=true)
	Detect or show the configuration GUI elements for the module. More...

Properties
bool	labelsDisplayed

bool	flagOrbits

bool	trailsDisplayed

bool	flagHints

bool	flagPointer

bool	flagNativePlanetNames

bool	flagTranslatedNames

bool	planetsDisplayed

bool	flagIsolatedOrbits

bool	flagIsolatedTrails

bool	flagLightTravelTime

bool	flagUseObjModels

bool	flagShowObjSelfShadows

bool	flagMoonScale

double	moonScale

bool	flagMinorBodyScale

double	minorBodyScale

double	labelsAmount
	The amount of planets labels (between 0 and 10). More...

bool	ephemerisMarkersDisplayed

bool	ephemerisHorizontalCoordinates

bool	ephemerisDatesDisplayed

bool	ephemerisMagnitudesDisplayed

bool	flagCustomGrsSettings

int	customGrsLongitude

double	customGrsDrift

double	customGrsJD

Vec3f	orbitsColor

Vec3f	majorPlanetsOrbitsColor

Vec3f	minorPlanetsOrbitsColor

Vec3f	dwarfPlanetsOrbitsColor

Vec3f	moonsOrbitsColor

Vec3f	cubewanosOrbitsColor

Vec3f	plutinosOrbitsColor

Vec3f	scatteredDiskObjectsOrbitsColor

Vec3f	oortCloudObjectsOrbitsColor

Vec3f	cometsOrbitsColor

Vec3f	sednoidsOrbitsColor

Vec3f	mercuryOrbitColor

Vec3f	venusOrbitColor

Vec3f	earthOrbitColor

Vec3f	marsOrbitColor

Vec3f	jupiterOrbitColor

Vec3f	saturnOrbitColor

Vec3f	uranusOrbitColor

Vec3f	neptuneOrbitColor

QString	orbitColorStyle

Additional Inherited Members
Public Types inherited from StelModule
enum	StelModuleSelectAction { AddToSelection, ReplaceSelection, RemoveFromSelection }
	Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...

enum	StelModuleActionName { ActionDraw, ActionUpdate, ActionHandleMouseClicks, ActionHandleMouseMoves, ActionHandleKeys }
	Define the possible action for which an order is defined. More...

Protected Member Functions inherited from StelModule
class StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, QObject target, const char slot, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to slot) to the StelActionMgr object. More...

class StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to own slot) to the StelActionMgr object. More...

Detailed Description

This StelObjectModule derivative is used to model SolarSystem bodies.

This includes the Major Planets, Minor Planets and Comets.

Definition at line 47 of file SolarSystem.hpp.

Member Function Documentation

void SolarSystem::computePositions	(	double	dateJDE,
		PlanetP	observerPlanet
	)

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

Parameters

dateJDE	the Julian Day in JDE (Ephemeris Time or equivalent)
observerPlanet	planet of the observer (Required for light travel time or aberration computation).

virtual void SolarSystem::deinit ( )

virtual

Called before the module will be delete, and before the openGL context is suppressed.

Deinitialize all openGL texture in this method.

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

const QList<PlanetP>& SolarSystem::getAllMinorBodies ( ) const

inline

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

Definition at line 873 of file SolarSystem.hpp.

QStringList SolarSystem::getAllMinorPlanetCommonEnglishNames ( ) const

Get the list of all the minor planet common english names.

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.

Definition at line 871 of file SolarSystem.hpp.

QString SolarSystem::getApparentMagnitudeAlgorithmOnEarth ( ) const

slot

Get the algorithm used for computation of apparent magnitudes for planets in case observer on the Earth.

See also: setApparentMagnitudeAlgorithmOnEarth()

virtual double SolarSystem::getCallOrder ( StelModuleActionName actionName ) const

virtual

Used to determine what order to draw the various StelModules.

Reimplemented from StelModule.

Vec3f SolarSystem::getCometsOrbitsColor ( void ) const

slot

Get the current color used to draw comet orbit lines.

Returns: current color

Vec3f SolarSystem::getCubewanosOrbitsColor ( void ) const

slot

Get the current color used to draw orbits lines of cubewanos.

Returns: current color

double SolarSystem::getCustomGrsDrift ( )

slot

Get speed of annual drift for Great Red Spot (System II is used)

double SolarSystem::getCustomGrsJD ( )

slot

Get initial JD for calculation of position of Great Red Spot.

int SolarSystem::getCustomGrsLongitude ( )

slot

Get longitude of Great Red Spot (System II is used)

Returns: a longitude (degrees)

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)

Vec3f SolarSystem::getDwarfPlanetsOrbitsColor ( void ) const

slot

Get the current color used to draw orbits lines of the dwarf planets.

Returns: current color

PlanetP SolarSystem::getEarth ( ) const

inline

Get the Planet object pointer for the Earth.

Definition at line 839 of file SolarSystem.hpp.

Vec3f SolarSystem::getEarthOrbitColor ( void ) const

slot

Get the current color used to draw Earth orbit line.

Returns: current color

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::getFlagCustomGrsSettings ( )

slot

Get the current value of the flag which determines if custom settings for Great Red Spot on Jupiter is used or not.

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::getFlagIsolatedOrbits ( void ) const

slot

Get the current value of the flag which enables showing of isolated orbits for selected objects only or not.

bool SolarSystem::getFlagIsolatedTrails ( void ) const

slot

Get the current value of the flag which enables showing of isolated trails for selected objects only or not.

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

inlineslot

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

Definition at line 385 of file SolarSystem.hpp.

bool SolarSystem::getFlagMinorBodyScale ( void ) const

inlineslot

Get the current value of the flag which determines if minor bodies (everything except the 8 planets) are drawn scaled or not.

Definition at line 656 of file SolarSystem.hpp.

bool SolarSystem::getFlagMoonScale ( void ) const

inlineslot

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

Definition at line 646 of file SolarSystem.hpp.

bool SolarSystem::getFlagNativePlanetNames ( void ) const

slot

Get the current value of the flag which enables showing native names for planets or not.

bool SolarSystem::getFlagOrbits ( void ) const

inlineslot

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

Definition at line 374 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::getFlagPointer ( ) const

inlineslot

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

Definition at line 379 of file SolarSystem.hpp.

bool SolarSystem::getFlagShowObjSelfShadows ( void ) const

inlineslot

Get the current value of the flag which determines whether OBJ models should render self-shadowing (using a shadow map)

Definition at line 395 of file SolarSystem.hpp.

bool SolarSystem::getFlagTrails ( ) const

slot

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

bool SolarSystem::getFlagTranslatedNames ( void ) const

slot

Get the current value of the flag which enables showing translated names for planets or not.

bool SolarSystem::getFlagUseObjModels ( void ) const

inlineslot

Get the current value of the flag which determines wether to use OBJ models for rendering, where available.

Definition at line 390 of file SolarSystem.hpp.

Vec3f SolarSystem::getJupiterOrbitColor ( void ) const

slot

Get the current color used to draw Jupiter orbit line.

Returns: current color

double SolarSystem::getLabelsAmount ( void ) const

inlineslot

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 369 of file SolarSystem.hpp.

const Vec3f& SolarSystem::getLabelsColor ( void ) const

slot

Get the current color used to draw planet labels.

Returns: current color

const Vec3d SolarSystem::getLightTimeSunPosition ( ) const

inline

Get lighttime corrected solar position (essential to draw the sun during solar eclipse and compute things like eclipse factor etc, until we get aberration working.)

Definition at line 878 of file SolarSystem.hpp.

Vec3f SolarSystem::getMajorPlanetsOrbitsColor ( void ) const

slot

Get the current color used to draw orbits lines of the major planets.

Returns: current color

Vec3f SolarSystem::getMarsOrbitColor ( void ) const

slot

Get the current color used to draw Mars orbit line.

Returns: current color

Vec3f SolarSystem::getMercuryOrbitColor ( void ) const

slot

Get the current color used to draw Mercury orbit line.

Returns: current color

const QStringList SolarSystem::getMinorBodiesList ( ) const

inline

Get the list of all minor bodies names.

Definition at line 875 of file SolarSystem.hpp.

double SolarSystem::getMinorBodyScale ( void ) const

inlineslot

Get the display scaling factor for minor bodies.

Definition at line 661 of file SolarSystem.hpp.

Vec3f SolarSystem::getMinorPlanetsOrbitsColor ( void ) const

slot

Get the current color used to draw orbits lines of the minor planets.

Returns: current color

PlanetP SolarSystem::getMoon ( ) const

inline

Get the Planet object pointer for Earth's moon.

Definition at line 842 of file SolarSystem.hpp.

double SolarSystem::getMoonScale ( void ) const

inlineslot

Get the display scaling factor for Earth's moon.

Definition at line 651 of file SolarSystem.hpp.

Vec3f SolarSystem::getMoonsOrbitsColor ( void ) const

slot

Get the current color used to draw orbits lines of moons of planets.

Returns: current color

virtual QString SolarSystem::getName ( ) const

inlinevirtual

Gets a user-displayable name of the object category.

Implements StelObjectModule.

Definition at line 336 of file SolarSystem.hpp.

Vec3f SolarSystem::getNeptuneOrbitColor ( void ) const

slot

Get the current color used to draw Neptune orbit line.

Returns: current color

QStringList SolarSystem::getObjectsList ( QString objType = "all" ) const

slot

Get list of objects by type.

Parameters

objType object type

Vec3f SolarSystem::getOortCloudObjectsOrbitsColor ( void ) const

slot

Get the current color used to draw orbits lines of Oort cloud objects.

Returns: current color

QString SolarSystem::getOrbitColorStyle ( ) const

slot

Get style of colors of orbits for Solar system bodies.

Vec3f SolarSystem::getOrbitsColor ( void ) const

slot

Get the current color used to draw solar system object orbit lines.

Returns: current color

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::getPlanetType ( QString planetName ) const

slot

Get type for Solar system bodies from scripts.

Parameters

planetName the case in-sensistive English planet name.

Returns: a type of planet (planet, moon, asteroid, comet, plutoid)

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

Vec3f SolarSystem::getPlutinosOrbitsColor ( void ) const

slot

Get the current color used to draw orbits lines of plutinos.

Returns: current color

Vec3f SolarSystem::getPointerColor ( ) const

inlineslot

Get the current color used to draw planet pointers.

Returns: current color

Definition at line 641 of file SolarSystem.hpp.

Vec3f SolarSystem::getSaturnOrbitColor ( void ) const

slot

Get the current color used to draw Saturn orbit line.

Returns: current color

Vec3f SolarSystem::getScatteredDiskObjectsOrbitsColor ( void ) const

slot

Get the current color used to draw orbits lines of scattered disk objects.

Returns: current color

Vec3f SolarSystem::getSednoidsOrbitsColor ( void ) const

slot

Get the current color used to draw sednoid orbit lines.

Returns: current color

virtual QString SolarSystem::getStelObjectType ( ) const

inlinevirtual

Returns the name that will be returned by StelObject::getType() for the objects this module manages.

Implements StelObjectModule.

Definition at line 337 of file SolarSystem.hpp.

PlanetP SolarSystem::getSun ( ) const

inline

Get the Planet object pointer for the Sun.

Definition at line 836 of file SolarSystem.hpp.

Vec3f SolarSystem::getTrailsColor ( ) const

inlineslot

Get the current color used to draw planet trails lines.

Returns: current color

Definition at line 630 of file SolarSystem.hpp.

Vec3f SolarSystem::getUranusOrbitColor ( void ) const

slot

Get the current color used to draw Uranus orbit line.

Returns: current color

Vec3f SolarSystem::getVenusOrbitColor ( void ) const

slot

Get the current color used to draw Venus orbit line.

Returns: current color

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::listAllObjects ( bool inEnglish ) const

virtual

List all StelObjects.

Parameters

inEnglish list names in English (true) or translated (false)

Returns: a list of matching object name by order of relevance, or an empty list if nothing matches

Implements StelObjectModule.

virtual QStringList SolarSystem::listAllObjectsByType	(	const QString &	objType,
		bool	inEnglish
	)		const

virtual

List all StelObjects by type.

Parameters

objType	object type
inEnglish	list translated names (false) or in English (true)

Returns: a list of matching object name by order of relevance, or an empty list if nothing matches

Reimplemented from StelObjectModule.

bool SolarSystem::nearLunarEclipse ( )

Determine if a lunar eclipse is close at hand?

void SolarSystem::reloadPlanets ( )

Reload the planets.

bool SolarSystem::removeMinorPlanet ( QString name )

New 0.16: delete a planet from the solar system. Writes a warning to log if this is not a minor object.

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

virtual StelObjectP SolarSystem::searchByID ( const QString & id ) const

inlinevirtual

Return the StelObject with the given ID if exists or the empty StelObject if not found.

Parameters

name	the english object name

Implements StelObjectModule.

Definition at line 329 of file SolarSystem.hpp.

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

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

Implements StelObjectModule.

void SolarSystem::setApparentMagnitudeAlgorithmOnEarth ( QString algorithm )

slot

Set the algorithm for computation of apparent magnitudes for planets in case observer on the Earth.

Possible values:

Mueller1893 Explanatory Supplement to the Astronomical Ephemeris, 1961
AstrAlm1984 [Astronomical Almanac 1984] and later. These give V (instrumental) magnitudes.
ExpSup1992 [Explanatory Supplement to the Astronomical Almanac, 1992] (algorithm contributed by Pere Planesas, Observatorio Astronomico Nacional)
ExpSup2013 [Explanatory Supplement to the Astronomical Almanac, 3rd edition, 2013]
Generic Visual magnitude based on phase angle and albedo. Details:
J. Meeus "Astronomical Algorithms" (2nd ed. 1998, with corrections as of August 10, 2009) p.283-286.
O. Montenbruck, T. Pfleger "Astronomy on the Personal Computer" (4th ed.) p.143-145.
Daniel L. Harris "Photometry and Colorimetry of Planets and Satellites" http://adsabs.harvard.edu/abs/1961plsa.book..272H
Sean E. Urban and P. Kenneth Seidelmann "Explanatory Supplement to the Astronomical Almanac" (3rd edition, 2013) Hint: Default option in config.ini: astro/apparent_magnitude_algorithm = ExpSup2013
Parameters

algorithm the case in-sensitive algorithm name

Note
: The structure of algorithms is almost identical, just the numbers are different! You should activate Mueller's algorithm to simulate the eye's impression. (Esp. Venus!)

void SolarSystem::setCometsOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw comet orbit lines.

Parameters

c	The color of the comet orbit lines (R,G,B) // example of usage in scripts SolarSystem.setCometsOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setCubewanosOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw orbits lines of cubewanos.

Parameters

c	The color of orbits lines of cubewanos (R,G,B) // example of usage in scripts SolarSystem.setCubewanosOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setCustomGrsDrift ( double drift )

slot

Set speed of annual drift for Great Red Spot (System II is used)

Parameters

annual drift (degrees)

void SolarSystem::setCustomGrsJD ( double JD )

slot

Set initial JD for calculation of position of Great Red Spot.

Parameters

JD

void SolarSystem::setCustomGrsLongitude ( int longitude )

slot

Set longitude of Great Red Spot (System II is used)

Parameters

longitude (degrees)

void SolarSystem::setDwarfPlanetsOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw orbits lines of the dwarf planets.

Parameters

c	The color of orbits lines of the dwarf planets (R,G,B) // example of usage in scripts SolarSystem.setDwarfPlanetsOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setEarthOrbitColor ( const Vec3f & c )

slot

Set the color used to draw Earth orbit line.

Parameters

c	The color of Earth orbit line (R,G,B) // example of usage in scripts SolarSystem.setEarthOrbitColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setFlagCustomGrsSettings ( bool b )

slot

Set flag which determines if custom settings is using for Great Red Spot on Jupiter.

void SolarSystem::setFlagHints ( bool b )

slot

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

void SolarSystem::setFlagIsolatedOrbits ( bool b )

slot

Set flag which enabled the showing of isolated orbits for selected objects only or not.

void SolarSystem::setFlagIsolatedTrails ( bool b )

slot

Set flag which enabled the showing of isolated trails for selected objects only or not.

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::setFlagMinorBodyScale ( bool b )

slot

Set flag which determines if minor bodies (everything except the 8 planets) are drawn scaled or not.

void SolarSystem::setFlagMoonScale ( bool b )

slot

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

void SolarSystem::setFlagNativePlanetNames ( bool b )

slot

Set flag which enable use native names for planets 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::setFlagPointer ( bool b )

inlineslot

Set flag which determines if the planet pointer (red cross) is drawn or hidden on a selected planet.

Definition at line 377 of file SolarSystem.hpp.

void SolarSystem::setFlagShowObjSelfShadows ( bool b )

slot

Set flag whether OBJ models should render self-shadowing (using a shadow map)

void SolarSystem::setFlagTrails ( bool b )

slot

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

void SolarSystem::setFlagTranslatedNames ( bool b )

slot

Set flag which enable use translated names for planets or not.

void SolarSystem::setFlagUseObjModels ( bool b )

inlineslot

Set flag whether to use OBJ models for rendering, where available.

Definition at line 388 of file SolarSystem.hpp.

void SolarSystem::setFontSize ( float newFontSize )

slot

Set planet names font size.

Returns: font size

void SolarSystem::setJupiterOrbitColor ( const Vec3f & c )

slot

Set the color used to draw Jupiter orbit line.

Parameters

c	The color of Jupiter orbit line (R,G,B) // example of usage in scripts SolarSystem.setJupiterOrbitColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setLabelsAmount ( double a )

inlineslot

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 366 of file SolarSystem.hpp.

void SolarSystem::setLabelsColor ( const Vec3f & c )

slot

Set the color used to draw planet labels.

Parameters

c	The color of the planet labels (R,G,B) // example of usage in scripts SolarSystem.setLabelsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setMajorPlanetsOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw orbits lines of the major planets.

Parameters

c	The color of orbits lines of the major planets (R,G,B) // example of usage in scripts SolarSystem.setMajorPlanetsOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setMarsOrbitColor ( const Vec3f & c )

slot

Set the color used to draw Mars orbit line.

Parameters

c	The color of Mars orbit line (R,G,B) // example of usage in scripts SolarSystem.setMarsOrbitColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setMercuryOrbitColor ( const Vec3f & c )

slot

Set the color used to draw Mercury orbit line.

Parameters

c	The color of Mercury orbit line (R,G,B) // example of usage in scripts SolarSystem.setMercuryOrbitColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setMinorBodyScale ( double f )

slot

Set the display scaling factor for minor bodies.

void SolarSystem::setMinorPlanetsOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw orbits lines of the minor planets.

Parameters

c	The color of orbits lines of the minor planets (R,G,B) // example of usage in scripts SolarSystem.setMinorPlanetsOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setMoonScale ( double f )

slot

Set the display scaling factor for Earth's moon.

void SolarSystem::setMoonsOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw orbits lines of moons of planets.

Parameters

c	The color of orbits lines of moons of planets lines (R,G,B) // example of usage in scripts SolarSystem.setMoonsOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setNeptuneOrbitColor ( const Vec3f & c )

slot

Set the color used to draw Neptune orbit line.

Parameters

c	The color of Neptune orbit line (R,G,B) // example of usage in scripts SolarSystem.setNeptuneOrbitColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setOortCloudObjectsOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw orbits lines of Oort cloud objects.

Parameters

c	The color of orbits lines of Oort cloud objects (R,G,B) // example of usage in scripts SolarSystem.setOortCloudObjectsOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setOrbitColorStyle ( QString style )

slot

Set style of colors of orbits for Solar system bodies.

void SolarSystem::setOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw solar system object orbit lines.

Parameters

c	The color of the solar system object orbit lines (R,G,B) // example of usage in scripts SolarSystem.setOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setPlutinosOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw orbits lines of plutinos.

Parameters

c	The color of orbits lines of plutinos (R,G,B) // example of usage in scripts SolarSystem.setPlutinosOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setPointerColor ( const Vec3f & c )

inlineslot

Set the color used to draw planet pointers.

Parameters

c	The color of the planet pointers // example of usage in scripts SolarSystem.setPointerColor(Vec3f(1.0,0.0,0.0));

Definition at line 638 of file SolarSystem.hpp.

void SolarSystem::setSaturnOrbitColor ( const Vec3f & c )

slot

Set the color used to draw Saturn orbit line.

Parameters

c	The color of Saturn orbit line (R,G,B) // example of usage in scripts SolarSystem.setSaturnOrbitColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setScatteredDiskObjectsOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw orbits lines of scattered disk objects.

Parameters

c	The color of orbits lines of scattered disk objects (R,G,B) // example of usage in scripts SolarSystem.setScatteredDiskObjectsOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setSednoidsOrbitsColor ( const Vec3f & c )

slot

Set the color used to draw sednoid orbit lines.

Parameters

c	The color of the sednoid orbit lines (R,G,B) // example of usage in scripts SolarSystem.setSednoidsOrbitsColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setTrailsColor ( const Vec3f & c )

inlineslot

Set the color used to draw planet trails lines.

Parameters

c	The color of the planet trails lines (R,G,B) // example of usage in scripts SolarSystem.setTrailsColor(Vec3f(1.0,0.0,0.0));

Definition at line 627 of file SolarSystem.hpp.

void SolarSystem::setUranusOrbitColor ( const Vec3f & c )

slot

Set the color used to draw Uranus orbit line.

Parameters

c	The color of Uranus orbit line (R,G,B) // example of usage in scripts SolarSystem.setUranusOrbitColor(Vec3f(1.0,0.0,0.0));

void SolarSystem::setVenusOrbitColor ( const Vec3f & c )

slot

Set the color used to draw Venus orbit line.

Parameters

c	The color of Venus orbit line (R,G,B) // example of usage in scripts SolarSystem.setVenusOrbitColor(Vec3f(1.0,0.0,0.0));

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

Property Documentation

double SolarSystem::labelsAmount

readwrite

The amount of planets labels (between 0 and 10).

Definition at line 132 of file SolarSystem.hpp.

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

/home/aw/devel/stellarium/0.16/src/core/modules/SolarSystem.hpp

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation