Stellarium  1.2
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends
Planet Class Reference

Data Structures

struct  PlanetOBJModel

Public Types

enum  PlanetType {
  isStar, isPlanet, isMoon, isObserver,
  isArtificial, isAsteroid, isPlutino, isComet,
  isDwarfPlanet, isCubewano, isSDO, isOCO,
  isSednoid, isInterstellar, isUNDEFINED
 numeric typecodes for the type descriptions in ssystem.ini
enum  PlanetOrbitColorStyle { ocsOneColor, ocsGroups, ocsMajorPlanets }
enum  ApparentMagnitudeAlgorithm {
  Mueller_1893, AstronomicalAlmanac_1984, ExplanatorySupplement_1992, ExplanatorySupplement_2013,
  MallamaHilton_2018, UndefinedAlgorithm, Generic
enum  PositionQuality { Position, OrbitPlotting }
 enums to indicate for which purpose we check positional quality. More...
- Public Types inherited from StelObject
enum  InfoStringGroupFlags {
  None = 0x00000000, Name = 0x00000001, CatalogNumber = 0x00000002, Magnitude = 0x00000004,
  RaDecJ2000 = 0x00000008, RaDecOfDate = 0x00000010, AltAzi = 0x00000020, Distance = 0x00000040,
  Elongation = 0x00000080, Size = 0x00000100, Velocity = 0x00000200, ProperMotion = 0x00000400,
  Extra = 0x00000800, HourAngle = 0x00001000, AbsoluteMagnitude = 0x00002000, GalacticCoord = 0x00004000,
  SupergalacticCoord = 0x00008000, OtherCoord = 0x00010000, ObjectType = 0x00020000, EclipticCoordJ2000 = 0x00040000,
  EclipticCoordOfDate = 0x00080000, IAUConstellation = 0x00100000, SiderealTime = 0x00200000, RTSTime = 0x00400000,
  SolarLunarPosition = 0x00800000, Script = 0x01000000, DebugAid = 0x02000000, NoFont = 0x04000000,
  PlainText = 0x08000000
 Used as named bitfield flags as specifiers to filter results of getInfoString. More...

Public Member Functions

 Planet (const QString &englishName, double equatorialRadius, double oblateness, Vec3f halocolor, float albedo, float roughness, const QString &texMapName, const QString &normalMapName, const QString &ahorizonMapName, const QString &objModelName, posFuncType _coordFunc, Orbit *anOrbitPtr, OsculatingFunctType *osculatingFunc, bool closeOrbit, bool hidden, bool hasAtmosphere, bool hasHalo, const QString &pTypeStr)
virtual QString getInfoString (const StelCore *core, const InfoStringGroup &flags) const Q_DECL_OVERRIDE
 Get a string with data about the Planet. More...
virtual QVariantMap getInfoMap (const StelCore *core) const Q_DECL_OVERRIDE
 In addition to the entries from StelObject::getInfoMap(), Planet objects provide. More...
virtual double getCloseViewFov (const StelCore *core) const Q_DECL_OVERRIDE
 Return the best FOV in degree to use for a close view of the object.
virtual double getSatellitesFov (const StelCore *core) const Q_DECL_OVERRIDE
 Return the best FOV in degree to use for a global view of the object satellite system (if there are satellites)
virtual double getParentSatellitesFov (const StelCore *core) const Q_DECL_OVERRIDE
virtual float getVMagnitude (const StelCore *core) const Q_DECL_OVERRIDE
 Return object's apparent V magnitude as seen from observer, without including extinction.
virtual float getSelectPriority (const StelCore *core) const Q_DECL_OVERRIDE
 Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority.
virtual Vec3f getInfoColor (void) const Q_DECL_OVERRIDE
 Get a color used to display info about the object.
virtual QString getType (void) const Q_DECL_OVERRIDE
 Return object's type. It should be the name of the class.
virtual QString getObjectType (void) const Q_DECL_OVERRIDE
 Return object's type. It should be English lowercase name of the type of the object.
virtual QString getObjectTypeI18n (void) const Q_DECL_OVERRIDE
 Return object's type. It should be translated lowercase name of the type of the object.
virtual QString getID (void) const Q_DECL_OVERRIDE
 Returns a unique identifier for this object. More...
virtual Vec3d getJ2000EquatorialPos (const StelCore *core) const Q_DECL_OVERRIDE
 A Planet's own eclipticPos is in VSOP87 ref. More...
virtual QString getEnglishName (void) const Q_DECL_OVERRIDE
 Return object's name in english.
virtual QString getNameI18n (void) const Q_DECL_OVERRIDE
 Return translated object's name.
QString getNativeName (void) const
QString getNativeNameI18n (void) const
QString getCommonEnglishName (void) const
QString getCommonNameI18n (void) const
virtual double getAngularRadius (const StelCore *core) const Q_DECL_OVERRIDE
 Get angular semidiameter, degrees. If planet display is artificially enlarged (e.g. Moon upscale), value will also be increased.
virtual bool hasAtmosphere (void)
virtual bool hasHalo (void)
bool hasValidPositionalData (const double JDE, const PositionQuality purpose) const
 Returns whether planet positions are valid and useful for the current simulation time. More...
Vec2d getValidPositionalDataRange (const PositionQuality purpose) const
 Returns JDE dates of presumably valid data for positional calculation or acceptable range for graphics. More...
float getAxisRotation (void)
virtual void translateName (const StelTranslator &trans)
 return axisRotation last computed in computeTransMatrix(). [degrees] More...
virtual void draw (StelCore *core, float maxMagLabels, const QFont &planetNameFont)
double getEquatorialRadius (void) const
 Get the equator radius of the planet in AU. More...
double getOneMinusOblateness (void) const
 Get the value (1-f) for oblateness f=polarRadius/equatorialRadius.
double getPolarRadius (void) const
 Get the polar radius of the planet in AU. More...
double getSiderealDay (void) const
 Get duration of sidereal day (earth days, may come from rot_periode or orbit_period (for moons) from ssystem_*.ini)
virtual double getSiderealPeriod (void) const
 Get duration of sidereal year [earth days].
void setSiderealPeriod (const double siderealPeriod)
 set duration of sidereal year. More...
double getMeanSolarDay (void) const
 Get duration of mean solar day, in earth days.
double getAlbedo (void) const
 Get albedo.
const QString & getTextMapName () const
const QString getPlanetTypeString () const
PlanetType getPlanetType () const
OrbitgetOrbit () const
void setNativeName (QString planet)
void setNativeNameMeaning (QString planet)
void setIAUMoonNumber (QString designation)
 set the IAU moon number (designation of the moon), if any.
float getAbsoluteMagnitude () const
 Return the absolute magnitude (read from file ssystem.ini)
float getMeanOppositionMagnitude () const
 Return the mean opposition magnitude, defined as V(1,0)+5log10(a(a-1)) A return value of 100 signals invalid result.
double getSiderealTime (double JD, double JDE) const
 Compute the axial z rotation (daily rotation around the polar axis) [degrees] to use from equatorial to hour angle based coordinates. More...
Mat4d getRotEquatorialToVsop87 (void) const
 return a rotation matrix from the planet's equatorial coordinate frame to the VSOP87 (ecliptical J2000) frame. More...
void setRotEquatorialToVsop87 (const Mat4d &m)
 set a rotation matrix from the planet's equatorial coordinate frame to the VSOP87 (ecliptical J2000) frame. More...
const RotationElementsgetRotationElements (void) const
void setRotationElements (const QString name, const double _period, const double _offset, const double _epoch, const double _obliquity, const double _ascendingNode, const double _ra0, const double _ra1, const double _de0, const double _de1, const double _w0, const double _w1)
 Set the rotational elements. More...
double getRotAscendingNode (void) const
 Note: The only place where this is used is to build up orbits for planet moons w.r.t. the parent planet orientation.
double getRotObliquity (double JDE) const
 return angle between axis and normal of ecliptic plane (or, for a moon, equatorial/reference plane defined by parent). More...
virtual void computePosition (const double dateJDE, const Vec3d &aberrationPush)
 Compute the position and orbital velocity in the parent Planet coordinate system You can add the aberrationPush value according to Edot*lightTime in Explanatory Supplement (2013) formula 7.55.
virtual void computePosition (const double dateJDE, Vec3d &eclPosition, Vec3d &eclVelocity) const
 Compute the position and orbital velocity in the parent Planet coordinate system, and return them in eclPosition and eclVelocity These may be preferred when we want to avoid setting the actual position (e.g., RTS computation)
void computeTransMatrix (double JD, double JDE)
 Compute the transformation matrix from the local Planet coordinate to the parent Planet coordinate. More...
Vec4d getRectangularCoordinates (const double longDeg, const double latDeg, const double altMetres=0.) const
 Retrieve planetocentric rectangular coordinates of a location on the ellipsoid surface, or with altitude altMetres above the ellipsoid surface. More...
Vec4d getHourlyProperMotion (const StelCore *core) const
 Retrieve the hourly proper motion of Solar system bodies. More...
double getPhaseAngle (const Vec3d &obsPos) const
 Get the phase angle (radians) for an observer at pos obsPos in heliocentric coordinates (in AU)
double getElongation (const Vec3d &obsPos) const
 Get the elongation angle (radians) for an observer at pos obsPos in heliocentric coordinates (in AU)
double getSpheroidAngularRadius (const StelCore *core) const
 Get the angular radius (degrees) of the planet spheroid (i.e. without the rings)
float getPhase (const Vec3d &obsPos) const
 Get the planet phase (illuminated fraction of the planet disk, [0=dark..1=full]) for an observer at pos obsPos in heliocentric coordinates (in AU)
QPair< Vec4d, Vec3dgetSubSolarObserverPoints (const StelCore *core, bool jupiterGraphical=false) const
 Get planetographic coordinates of subsolar and sub-observer points. More...
bool isRotatingRetrograde () const
 returns if planet has retrograde rotation
Vec3d getEclipticPos (double dateJDE) const
 Get the Planet position in the parent Planet ecliptic coordinate in AU.
Vec3d getEclipticPos () const
 Get the last computed Planet position in the parent Planet ecliptic coordinate in AU.
Vec3d getHeliocentricEclipticPos () const
 Return the heliocentric ecliptical position.
Vec3d getHeliocentricEclipticPos (double dateJDE) const
Vec3d getHeliocentricPos (Vec3d p) const
 Return the heliocentric transformation for local (parentocentric) coordinate. More...
void setHeliocentricEclipticPos (const Vec3d &pos)
 Propagate the heliocentric coordinates to parentocentric coordinates. More...
Vec3d getEclipticVelocity () const
 Get the planet velocity around the parent planet in ecliptical coordinates in AU/d.
Vec3d getHeliocentricEclipticVelocity () const
 Get the planet's heliocentric velocity in the solar system in ecliptical coordinates in AU/d. Required for aberration!
double computeDistance (const Vec3d &obsHelioPos)
 Compute and return the distance to the given position in heliocentric ecliptical (J2000) coordinates (in AU) Preserves result for later retrieval by getDistance() As side effect, improve fps by juggling update frequency (deltaJDE) for asteroids and other minor bodies. More...
double getDistance (void) const
 Return the last computed distance to the given position in heliocentric ecliptical (J2000) coordinates (in AU)
void setRings (Ring *r)
void setSphereScale (double s)
double getSphereScale () const
const QSharedPointer< PlanetgetParent (void) const
virtual void update (int deltaTime)
void setFlagHints (bool b)
bool getFlagHints (void) const
void setFlagLabels (bool b)
bool getFlagLabels (void) const
void setFlagNativeName (bool b)
bool getFlagNativeName (void) const
void setFlagOrbits (bool b)
bool getFlagOrbits (void) const
void drawOrbit (const StelCore *)
QVector< const Planet * > getCandidatesForShadow () const
 Return the list of planets which project some shadow on this planet.
Vec3d getAberrationPush () const
virtual Vec4d getRTSTime (const StelCore *core, const double altitude=0.) const Q_DECL_OVERRIDE
 Compute times of nearest rise, transit and set for a solar system object for current location. More...
void resetTextures ()
void replaceTexture (const QString &texName)
- Public Member Functions inherited from StelObject
virtual SphericalRegionP getRegion () const Q_DECL_OVERRIDE
 Default implementation of the getRegion method. More...
virtual Vec3d getPointInRegion () const Q_DECL_OVERRIDE
 Default implementation of the getPointInRegion method. More...
Vec3d getEquinoxEquatorialPos (const StelCore *core) const
 Get observer-centered equatorial coordinate at the current equinox The frame has its Z axis at the planet's current rotation axis At time 2000-01-01 this frame is almost the same as J2000, but ONLY if the observer is on earth.
Vec3d getEquinoxEquatorialPosApparent (const StelCore *core) const
 Like getEquinoxEquatorialPos(core), but always adds refraction correction to the position.
Vec3d getEquinoxEquatorialPosAuto (const StelCore *core) const
 Like getEquinoxEquatorialPos(core), but adds refraction correction to the position if atmosphere is active.
Vec3d getGalacticPos (const StelCore *core) const
 Get observer-centered galactic coordinates.
Vec3d getSupergalacticPos (const StelCore *core) const
 Get observer-centered supergalactic coordinates.
Vec3d getSiderealPosGeometric (const StelCore *core) const
 Get observer-centered hour angle + declination (at current equinox) It is the geometric position, i.e. More...
Vec3d getSiderealPosApparent (const StelCore *core) const
 Get observer-centered hour angle + declination (at current equinox) It is the apparent position, i.e. More...
Vec3d getAltAzPosGeometric (const StelCore *core) const
 Get observer-centered alt/az position It is the geometric position, i.e. More...
Vec3d getAltAzPosApparent (const StelCore *core) const
 Get observer-centered alt/az position It is the apparent position, i.e. More...
Vec3d getAltAzPosAuto (const StelCore *core) const
 Get observer-centered alt/az position It is the automatic position, i.e. More...
float getParallacticAngle (const StelCore *core) const
 Get parallactic angle, which is the deviation between zenith angle and north angle. [radians].
bool isAboveHorizon (const StelCore *core) const
 Checking position an object above mathematical horizon for current location. More...
bool isAboveRealHorizon (const StelCore *core) const
 Checking position an object above real horizon for current location. More...
float getVMagnitudeWithExtinction (const StelCore *core) const
 Return object's apparent V magnitude as seen from observer including extinction. More...
virtual float getAirmass (const StelCore *core) const
 Return airmass value for the object (for atmosphere-dependent calculations) More...

Static Public Member Functions

static void init ()
 Initializes static vars. Must be called before creating first planet.
static ApparentMagnitudeAlgorithm getApparentMagnitudeAlgorithm ()
static const QString getApparentMagnitudeAlgorithmString ()
static void setApparentMagnitudeAlgorithm (QString algorithm)
static void setApparentMagnitudeAlgorithm (ApparentMagnitudeAlgorithm algorithm)
static float getPAsun (const Vec3d &sunPos, const Vec3d &objPos)
 Get the position angle of the illuminated limb of a planet The result depends on the arguments' coordinate system which must be identical. More...
static void setLabelColor (const Vec3f &lc)
static const Vec3fgetLabelColor (void)
static void setOrbitColor (const Vec3f &oc)
static const Vec3fgetOrbitColor ()
static void setMajorPlanetOrbitColor (const Vec3f &oc)
static const Vec3fgetMajorPlanetOrbitColor ()
static void setMoonOrbitColor (const Vec3f &oc)
static const Vec3fgetMoonOrbitColor ()
static void setMinorPlanetOrbitColor (const Vec3f &oc)
static const Vec3fgetMinorPlanetOrbitColor ()
static void setDwarfPlanetOrbitColor (const Vec3f &oc)
static const Vec3fgetDwarfPlanetOrbitColor ()
static void setCubewanoOrbitColor (const Vec3f &oc)
static const Vec3fgetCubewanoOrbitColor ()
static void setPlutinoOrbitColor (const Vec3f &oc)
static const Vec3fgetPlutinoOrbitColor ()
static void setScatteredDiscObjectOrbitColor (const Vec3f &oc)
static const Vec3fgetScatteredDiscObjectOrbitColor ()
static void setOortCloudObjectOrbitColor (const Vec3f &oc)
static const Vec3fgetOortCloudObjectOrbitColor ()
static void setCometOrbitColor (const Vec3f &oc)
static const Vec3fgetCometOrbitColor ()
static void setSednoidOrbitColor (const Vec3f &oc)
static const Vec3fgetSednoidOrbitColor ()
static void setInterstellarOrbitColor (const Vec3f &oc)
static const Vec3fgetInterstellarOrbitColor ()
static void setMercuryOrbitColor (const Vec3f &oc)
static const Vec3fgetMercuryOrbitColor ()
static void setVenusOrbitColor (const Vec3f &oc)
static const Vec3fgetVenusOrbitColor ()
static void setEarthOrbitColor (const Vec3f &oc)
static const Vec3fgetEarthOrbitColor ()
static void setMarsOrbitColor (const Vec3f &oc)
static const Vec3fgetMarsOrbitColor ()
static void setJupiterOrbitColor (const Vec3f &oc)
static const Vec3fgetJupiterOrbitColor ()
static void setSaturnOrbitColor (const Vec3f &oc)
static const Vec3fgetSaturnOrbitColor ()
static void setUranusOrbitColor (const Vec3f &oc)
static const Vec3fgetUranusOrbitColor ()
static void setNeptuneOrbitColor (const Vec3f &oc)
static const Vec3fgetNeptuneOrbitColor ()

Data Fields

bool flagNativeName
LinearFader orbitFader
Vec3d orbit [ORBIT_SEGMENTS+1]
double deltaJDE
double deltaOrbitJDE
bool closeOrbit

Static Public Attributes

static const QString PLANET_TYPE
static Vec3f orbitColor
static Vec3f orbitMajorPlanetsColor
static Vec3f orbitMoonsColor
static Vec3f orbitMinorPlanetsColor
static Vec3f orbitDwarfPlanetsColor
static Vec3f orbitCubewanosColor
static Vec3f orbitPlutinosColor
static Vec3f orbitScatteredDiscObjectsColor
static Vec3f orbitOortCloudObjectsColor
static Vec3f orbitCometsColor
static Vec3f orbitSednoidsColor
static Vec3f orbitInterstellarColor
static Vec3f orbitMercuryColor
static Vec3f orbitVenusColor
static Vec3f orbitEarthColor
static Vec3f orbitMarsColor
static Vec3f orbitJupiterColor
static Vec3f orbitSaturnColor
static Vec3f orbitUranusColor
static Vec3f orbitNeptuneColor
static PlanetOrbitColorStyle orbitColorStyle
- Static Public Attributes inherited from StelObject
static constexpr InfoStringGroup AllInfo
 A pre-defined "all available" set of specifiers for the getInfoString flags argument to getInfoString. More...
static constexpr InfoStringGroup DefaultInfo
 A pre-defined "default" set of specifiers for the getInfoString flags argument to getInfoString It appears useful to propose this set as post-install settings and let users configure more on demand. More...
static constexpr InfoStringGroup ShortInfo = static_cast<InfoStringGroup>(Name|CatalogNumber|Magnitude|RaDecJ2000)
 A pre-defined "shortest useful" set of specifiers for the getInfoString flags argument to getInfoString.

Protected Member Functions

virtual QString getInfoStringName (const StelCore *core, const InfoStringGroup &flags) const
virtual QString getInfoStringAbsoluteMagnitude (const StelCore *core, const InfoStringGroup &flags) const
virtual QString getInfoStringExtraMag (const StelCore *core, const InfoStringGroup &flags) const
 Any flag=Extra information to be displayed after the magnitude strings.
virtual QString getInfoStringSize (const StelCore *core, const InfoStringGroup &flags) const
 Any flag=Size information to be displayed.
virtual QString getInfoStringEloPhase (const StelCore *core, const InfoStringGroup &flags, const bool withIllum) const
 Return elongation and phase angle when flags=Elongation.
virtual QString getInfoStringPeriods (const StelCore *core, const InfoStringGroup &flags) const
 Return sidereal and synodic periods when flags=Extra.
virtual QString getInfoStringExtra (const StelCore *core, const InfoStringGroup &flags) const
 Any flag=Extra information to be displayed at the end.
void computeModelMatrix (Mat4d &result, bool solarEclipseCase) const
 Used in drawSphere() to compute shadows, and inside a function to derive eclipse sizes. More...
void computeOrbit ()
 Update the orbit position values.
Vec3f getCurrentOrbitColor () const
QString getPlanetLabel () const
 Return the information string "ready to print".
void draw3dModel (StelCore *core, StelProjector::ModelViewTranformP transfo, float screenRd, bool drawOnlyRing=false)
 Draw the 3d model. More...
bool drawObjModel (StelPainter *painter, float screenRd)
 Draws the OBJ model, assuming it is available. More...
bool drawObjShadowMap (StelPainter *painter, QMatrix4x4 &shadowMatrix)
bool ensureObjLoaded ()
 Starts the OBJ loading process, if it has not been done yet. More...
void drawSphere (StelPainter *painter, float screenRd, bool drawOnlyRing=false)
 Draw the 3D sphere.
void drawSurvey (StelCore *core, StelPainter *painter)
 Draw the Hips survey.
void drawHints (const StelCore *core, const QFont &planetNameFont)
 Draw the circle and name of the Planet.
PlanetOBJModelloadObjModel () const
- Protected Member Functions inherited from StelObject
QString getCommonInfoString (const StelCore *core, const InfoStringGroup &flags) const
 Format the positional info string containing J2000/of date/altaz/hour angle positions and constellation, sidereal time, etc. More...
virtual QString getMagnitudeInfoString (const StelCore *core, const InfoStringGroup &flags, const int decimals=1) const
 Format the magnitude info string for the object. More...
QString getSolarLunarInfoString (const StelCore *core, const InfoStringGroup &flags) const
 Add a section to the InfoString with just horizontal data for the Sun and Moon, when observed from Earth. More...
void postProcessInfoString (QString &str, const InfoStringGroup &flags) const
 Apply post processing on the info string. More...

Protected Attributes

QString englishName
QString nameI18
QString nativeName
QString nativeNameMeaning
QString nativeNameMeaningI18n
QString texMapName
QString normalMapName
QString horizonMapName
RotationElements re
double siderealPeriod
double equatorialRadius
double oneMinusOblateness
Vec3d eclipticPos
Vec3d eclipticVelocity
Vec3d aberrationPush
Vec3d screenPos
Vec3f haloColor
float absoluteMagnitude
float albedo
float roughness
float outgas_intensity
float outgas_falloff
Mat4d rotLocalToParent
float axisRotation
StelTextureSP texMap
StelTextureSP normalMap
StelTextureSP horizonMap
QFuture< PlanetOBJModel * > * objModelLoader
QString objModelPath
HipsSurveyP survey
double distance
double sphereScale
double lastJDE
posFuncType coordFunc
OsculatingFunctType *const osculatingFunc
QSharedPointer< Planetparent
QList< QSharedPointer< Planet > > satellites
LinearFader hintFader
LinearFader labelsFader
bool flagLabels
bool hidden
bool atmosphere
bool halo
PlanetType pType
bool multisamplingEnabled_
QOpenGLFunctions * gl

Static Protected Attributes

static StelTextureSP texEarthShadow
static ApparentMagnitudeAlgorithm vMagAlgorithm
static Vec3f labelColor
static StelTextureSP hintCircleTex
static const QMap< PlanetType, QString > pTypeMap
static const QMap< ApparentMagnitudeAlgorithm, QString > vMagAlgorithmMap
static bool drawMoonHalo
static bool drawSunHalo
static bool permanentDrawingOrbits
 If true, planet orbits will be drawn even if planet is off screen.
static int orbitsThickness


class SolarSystem

Additional Inherited Members

- Public Slots inherited from StelObject
virtual void setExtraInfoString (const InfoStringGroup &flags, const QString &str)
 Allow additions to the Info String. More...
virtual void addToExtraInfoString (const StelObject::InfoStringGroup &flags, const QString &str)
 Add str to the extra string. More...
QStringList getExtraInfoStrings (const InfoStringGroup &flags) const
 Retrieve an (unsorted) QStringList of all extra info strings that match flags. More...
void removeExtraInfoStrings (const InfoStringGroup &flags)
 Remove the extraInfoStrings with the given flags. More...

Member Enumeration Documentation

◆ PositionQuality

Objects on KeplerOrbits may be too far from their epoch to provide useful data.

Member Function Documentation

◆ computeDistance()

double Planet::computeDistance ( const Vec3d obsHelioPos)

They must be fast if close to observer, but can be slow if further away.

◆ computeModelMatrix()

void Planet::computeModelMatrix ( Mat4d result,
bool  solarEclipseCase 
) const
solarEclipseCaseFor reasons currently unknown we must handle solar eclipses as special case.

◆ computeTransMatrix()

void Planet::computeTransMatrix ( double  JD,
double  JDE 

This requires both flavours of JD in cases involving Earth.

◆ draw3dModel()

void Planet::draw3dModel ( StelCore core,
StelProjector::ModelViewTranformP  transfo,
float  screenRd,
bool  drawOnlyRing = false 

Call the proper functions if there are rings etc..

screenRdradius in screen pixels

◆ drawObjModel()

bool Planet::drawObjModel ( StelPainter painter,
float  screenRd 
screenRdradius in screen pixels.
false if the model can currently not be drawn (not loaded)

◆ ensureObjLoaded()

bool Planet::ensureObjLoaded ( )

Returns true when the OBJ is ready to draw

◆ getEquatorialRadius()

double Planet::getEquatorialRadius ( void  ) const
the equator radius of the planet in astronomical units.

◆ getHeliocentricPos()

Vec3d Planet::getHeliocentricPos ( Vec3d  p) const
  • p planetocentric rectangular ecliptical coordinate (J2000)
    heliocentric rectangular ecliptical coordinates (J2000)

◆ getHourlyProperMotion()

Vec4d Planet::getHourlyProperMotion ( const StelCore core) const
[hourlyMotion, positionAngle, deltaAlpha, deltaDelta] where hourlyMotion = hourly proper motion [radians] positionAngle = position angle (the direction of proper motion) [radians] deltaAlpha = hourly motion in R.A. [radians] deltaDelta = hourly motion in Dec. [radians]

◆ getID()

virtual QString Planet::getID ( void  ) const

The ID should be unique for all objects of the same type, but may freely conflict with IDs of other types, so getType() must also be tested.

With this it should be possible to at least identify the same object in a different instance of Stellarium running the same version, but it would even be better if the ID provides some degree of forward-compatibility. For some object types (e.g. planets) this may simply return getEnglishName(), but better candidates may be official designations or at least (stable) internal IDs.

An object may have multiple IDs (different catalog numbers, etc). StelObjectMgr::searchByID() should search through all ID variants, but this method only returns one of them.

Implements StelObject.

◆ getInfoMap()

virtual QVariantMap Planet::getInfoMap ( const StelCore core) const
  • distance
  • phase (result of getPhase)
  • illumination (=100*phase)
  • phase-angle (radians)
  • phase-angle-dms (formatted string; DMS)
  • phase-angle-deg (formatted string; degrees)
  • elongation (radians)
  • elongation-dms (formatted string; DMS)
  • elongation-deg (formatted string; degrees)
  • ecl-elongation (elongation in ecliptic longitude or Δλ; on Earth only; radians)
  • ecl-elongation-dms (elongation in ecliptic longitude or Δλ; on Earth only; formatted string; DMS)
  • ecl-elongation-deg (elongation in ecliptic longitude or Δλ; on Earth only; formatted string; degrees)
  • type (object type description)
  • velocity (formatted string)
  • heliocentric-velocity (formatted string)
  • scale
  • eclipse-obscuration (for Sun only)
  • eclipse-magnitude (for Sun only)
  • central_l (on Earth only; degrees)
  • central_b (on Earth only; degrees)
  • pa_axis (on Earth only; degrees)
  • subsolar_l (on Earth only; degrees)
  • subsolar_b (on Earth only; degrees)
  • libration_l (on Earth for Moon only; degrees)
  • libration_b (on Earth for Moon only; degrees)
  • colongitude (on Earth for Moon only; degrees)
  • penumbral-eclipse-magnitude (on Earth for Moon only)
  • umbral-eclipse-magnitude (on Earth for Moon only)

Reimplemented from StelObject.

Reimplemented in Comet.

◆ getInfoString()

virtual QString Planet::getInfoString ( const StelCore core,
const InfoStringGroup &  flags 
) const

Planets support the following InfoStringGroup flags:

  • Name
  • Magnitude
  • RaDec
  • AltAzi
  • Distance
  • Size
  • PlainText
  • Extra: Heliocentric Ecliptical Coordinates & Observer-planetocentric Ecliptical Coordinates, Phase, illumination, phase angle & elongation from the Sun
    subclasses should prefer to override only the component infostrings getInfoString...(), not this method!
    corethe StelCore object
    flagsa set of InfoStringGroup items to include in the return value.
    a QString containing an HMTL encoded description of the Planet.

Implements StelObject.

◆ getJ2000EquatorialPos()

virtual Vec3d Planet::getJ2000EquatorialPos ( const StelCore core) const

frame (practically equal to ecliptic of J2000 for us) coordinates relative to the parent body (sun, planet). To get J2000 equatorial coordinates, we require heliocentric ecliptical positions (adding up parent positions) of observer and Planet. Then we use the matrix rotation multiplication with an existing matrix in StelCore to orient from eclipticalJ2000 to equatorialJ2000. The end result is a non-normalized 3D vector which allows retrieving distances etc. The positional computation is called by SolarSystem. If the core's aberration setting is active, the J2000 position will then include it.

Implements StelObject.

◆ getPAsun()

static float Planet::getPAsun ( const Vec3d sunPos,
const Vec3d objPos 

E.g. if both are equatorial for equinox of date or J2000, the angle is zero when the bright limb is towards the north of the disk. An angle of 90° indicates a bright limb on the eastern limb, like an old moon. Source: Meeus, Astr.Algorithms (2nd ed.), 48.5.

◆ getPolarRadius()

double Planet::getPolarRadius ( void  ) const
the polar radius of the planet in astronomical units.

◆ getRectangularCoordinates()

Vec4d Planet::getRectangularCoordinates ( const double  longDeg,
const double  latDeg,
const double  altMetres = 0. 
) const

Meeus, Astr. Alg. 2nd ed, Ch.11.

longDeglongitude of location, degrees. (currently unused. Set to 0.)
latDegplanetographic latitude, degrees.
altMetresaltitude above ellipsoid surface (metres)
[rhoCosPhiPrime*a, rhoSinPhiPrime*a, phiPrime, rho*a] where a=equatorial radius [AU] phiPrime=planetocentric latitude rho*a=planetocentric distance of point [AU]

◆ getRotEquatorialToVsop87()

Mat4d Planet::getRotEquatorialToVsop87 ( void  ) const

For planets/moons with WGCCRE rotation elements, this is just a single matrix. For objects with traditional elements, this builds up the matrix from the parents.

◆ getRotObliquity()

double Planet::getRotObliquity ( double  JDE) const

For Earth, this is the angle between axis and normal to current ecliptic of date, i.e. the ecliptic obliquity of date JDE. Note: The only place where this is not used for Earth is to build up orbits for planet moons w.r.t. the parent planet orientation.

◆ getRTSTime()

virtual Vec4d Planet::getRTSTime ( const StelCore core,
const double  altitude = 0. 
) const
corethe currently active StelCore object
altitude(optional; default=0) altitude of the object, degrees. Setting this to -6. for the Sun will find begin and end for civil twilight.
Vec4d - time of rise, transit and set closest to current time; JD.
The fourth element flags particular conditions:
  • +100. for circumpolar objects. Rise and set give lower culmination times.
  • -100. for objects never rising. Rise and set give transit times.
  • -1000. is used as "invalid" value. The result should then not be used.
This is based on Meeus, Astronomical Algorithms (2nd ed.), but deviates in details.
Limitation for efficiency: If this is a planet moon from another planet, we compute RTS for the parent planet instead!

Reimplemented from StelObject.

◆ getSiderealTime()

double Planet::getSiderealTime ( double  JD,
double  JDE 
) const

On Earth, sidereal time on the other hand is the angle along the planet equator from RA0 to the meridian, i.e. hour angle of the first point of Aries. For Earth (of course) it is sidereal time at Greenwich. V0.21+ update: For planets and Moons, in this context this is the rotation angle W of the Prime meridian from the ascending node of the planet equator on the ICRF equator. The usual WGCCRE model is W=W0+d*W1. Some planets/moons have more complicated rotations though, these are also handled in here. The planet objects with old-style data are computed like in earlier versions of Stellarium. Their computational model is however questionable. For general applicability we need both time flavours:

JDis JD(UT) for Earth
JDEis used for other locations

◆ getSubSolarObserverPoints()

QPair<Vec4d, Vec3d> Planet::getSubSolarObserverPoints ( const StelCore core,
bool  jupiterGraphical = false 
) const

These are defined so that over time the longitude of the central meridian increases. This means longitudes are counted positive towards the west for direct rotators and positive towards the East for negative rotators (e.g. Venus). Other cartographic conventions may have to be followed elsewhere in the program, though. (e.g. planetary feature nomenclature!) Only meaningful for earth-bound observers. Source: Explanatory Supplement 2013, 10.4.1

jupiterGraphicalJupiter requires special treatment because its LII coordinate system does not stay in sync with the texture. (GRS is moving). Set this to true to return the incorrect, graphics-only longitude. first[0] = 10.26 phi_e [rad] Planetocentric latitude of sub-earth point first[1] = 10.26 phi'_e [rad] Planetographic latitude of sub-earth point first[2] = 10.26 lambda'_e [rad] Planetographic longitude of sub-earth point (0..2pi) first[3] = 10.29 P_n [rad] Position angle of axis north pole in equatorial coordinates of date second[0] = 10.26 phi_s [rad] Planetocentric latitude of sub-solar point second[1] = 10.26 phi'_s [rad] Planetographic latitude of sub-solar point second[2] = 10.26 lambda'_s [rad] Planetographic longitude of sub-solar point (0..2pi)
: For the Moon, it is more common to give Libration angles, where L=-lambda'_e, B=phi'_e.
: For Jupiter, this returns central meridian in L_II.
: For Saturn, this returns central meridian in L_III (rotation of magnetic field).

◆ getValidPositionalDataRange()

Vec2d Planet::getValidPositionalDataRange ( const PositionQuality  purpose) const

For the major planets and moons, this is always (std::numeric_limits<double>::min(), std::numeric_limits<double>::max()) For planets with Keplerian orbits, this is [epoch-orbit_good, epoch+orbit_good] or, if purpose=Position, [epoch-min(orbit_good, 365), epoch+min(orbit_good, 365)]. This should help to detect and avoid using outdated orbital elements.

◆ hasValidPositionalData()

bool Planet::hasValidPositionalData ( const double  JDE,
const PositionQuality  purpose 
) const

E.g. outdated orbital elements for Kepler orbits (beyond their orbit_good .ini file entries) may lead to invalid positions which should better not be used.

purposesignal whether result should be good enough for observation of just for plotting orbit data. For observation, date should be within the orbit_good value, or within 1 year from epoch of the orbital elements.
for major planets and moons this method will always return true

◆ setHeliocentricEclipticPos()

void Planet::setHeliocentricEclipticPos ( const Vec3d pos)
  • pos heliocentric rectangular ecliptical coordinate (J2000)

◆ setRotationElements()

void Planet::setRotationElements ( const QString  name,
const double  _period,
const double  _offset,
const double  _epoch,
const double  _obliquity,
const double  _ascendingNode,
const double  _ra0,
const double  _ra1,
const double  _de0,
const double  _de1,
const double  _w0,
const double  _w1 

Given two data models, we must support both: the traditional elements relative to the parent object: name: English name of the object. A corrective function may be attached which depends on the name. _period: duration of sidereal rotation [Julian days] _offset: [angle at _epoch. ] _epoch: [JDE] _obliquity [rad] _ascendingNode of equator on ecliptic[rad] The more modern way to specify these elements are relative to the ICRF: ra_pole=_ra0 + T*_ra1. ra_pole and de_pole must be computed more than for initialisation for J2000 de_pole=_de0 + T*_de1. ra and de values to be stored in [rad] _w0, _w1 to be given in degrees! If _ra0 is not zero, we understand WGCCRE data ra0, ra1, de0, de1, w0, w1 are used.

◆ setRotEquatorialToVsop87()

void Planet::setRotEquatorialToVsop87 ( const Mat4d m)

For planets/moons with WGCCRE rotation elements, this just sets this matrix. For objects with traditional elements, this builds up the matrix from the parents.

◆ setSiderealPeriod()

void Planet::setSiderealPeriod ( const double  siderealPeriod)

Also sets deltaOrbitJDE and may set closeOrbit for Planet objects which have KeplerOrbits. siderealPeriod [earth days] orbital duration.

◆ translateName()

virtual void Planet::translateName ( const StelTranslator trans)

Translate planet name using the passed translator

Reimplemented in Comet, and MinorPlanet.