#include <ksplanetbase.h>

Inheritance diagram for KSPlanetBase:

Public Types
enum	Planets { MERCURY =0, VENUS =1, MARS =2, JUPITER =3, SATURN =4, URANUS =5, NEPTUNE =6, PLUTO =7, SUN =8, MOON =9, UNKNOWN_PLANET }

Public Types inherited from SkyObject
enum	TYPE { STAR =0, CATALOG_STAR =1, PLANET =2, OPEN_CLUSTER =3, GLOBULAR_CLUSTER =4, GASEOUS_NEBULA =5, PLANETARY_NEBULA =6, SUPERNOVA_REMNANT =7, GALAXY =8, COMET =9, ASTEROID =10, CONSTELLATION =11, MOON =12, ASTERISM =13, GALAXY_CLUSTER =14, DARK_NEBULA =15, QUASAR =16, MULT_STAR =17, RADIO_SOURCE =18, SATELLITE =19, SUPERNOVA =20, TYPE_UNKNOWN }

typedef qint64	UID

Public Member Functions
	KSPlanetBase (const QString &s=i18n("unnamed"), const QString &image_file=QString(), const QColor &c=Qt::white, double pSize=0)

virtual	~KSPlanetBase ()

double	angSize () const

QColor &	color ()

const dms &	ecLat () const

void	EclipticToEquatorial (const dms *Obliquity)

const dms &	ecLong () const

void	EquatorialToEcliptic (const dms *Obliquity)

void	findPosition (const KSNumbers num, const dms lat=0, const dms LST=0, const KSPlanetBase Earth=0)

const dms &	helEcLat () const

const dms &	helEcLong () const

const QImage &	image ()

void	init (const QString &s, const QString &image_file, const QColor &c, double pSize)

bool	isMajorPlanet () const

virtual double	labelOffset () const

virtual bool	loadData ()=0

virtual double	pa () const

dms	phase ()

double	physicalSize () const

double	rearth () const

double	rsun () const

void	setAngularSize (double size)

void	setColor (const QColor &c)

void	setEcLat (dms elat)

void	setEcLong (dms elong)

void	setPA (double p)

void	setPhysicalSize (double size)

void	setRearth (double r)

void	setRearth (const KSPlanetBase *Earth)

void	setRsun (double r)

virtual void	updateCoords (KSNumbers num, bool includePlanets=true, const dms lat=0, const dms *LST=0, bool forceRecompute=false)

Public Member Functions inherited from TrailObject
	TrailObject (int t=TYPE_UNKNOWN, dms r=dms(0.0), dms d=dms(0.0), float m=0.0, const QString &n=QString())

	TrailObject (int t, double r, double d, float m=0.0, const QString &n=QString())

virtual	~TrailObject ()

void	addToTrail ()

void	clearTrail ()

void	clipTrail ()

virtual TrailObject *	clone () const

void	drawTrail (SkyPainter *skyp) const

bool	hasTrail () const

const QList< SkyPoint > &	trail () const

void	updateTrail (dms LST, const dms lat)

Public Member Functions inherited from SkyObject
	SkyObject (int t=TYPE_UNKNOWN, dms r=dms(0.0), dms d=dms(0.0), float m=0.0, const QString &n=QString(), const QString &n2=QString(), const QString &lname=QString())

	SkyObject (int t, double r, double d, float m=0.0, const QString &n=QString(), const QString &n2=QString(), const QString &lname=QString())

virtual	~SkyObject ()

virtual UID	getUID () const

bool	hasAuxInfo ()

bool	hasLongName () const

bool	hasName () const

bool	hasName2 () const

QStringList &	ImageList ()

QStringList &	ImageTitle ()

QStringList &	InfoList ()

QStringList &	InfoTitle ()

bool	isSolarSystem () const

virtual QString	labelString () const

virtual QString	longname (void) const

float	mag (void) const

float	mag (const QString &band) const

QString	messageFromTitle (const QString &imageTitle)

virtual QString	name (void) const

QString	name2 (void) const

QString &	notes ()

SkyPoint	recomputeCoords (const KStarsDateTime &dt, const GeoLocation *geo=0)

QTime	riseSetTime (const KStarsDateTime &dt, const GeoLocation *geo, bool rst, bool exact=true)

dms	riseSetTimeAz (const KStarsDateTime &dt, const GeoLocation *geo, bool rst)

QTime	riseSetTimeUT (const KStarsDateTime &dt, const GeoLocation *geo, bool rst, bool exact=true)

void	saveUserLog (const QString &newLog)

void	setLongName (const QString &longname=QString())

void	setNotes (QString _notes)

void	setType (int t)

void	showPopupMenu (KSPopupMenu *pmenu, const QPoint &pos)

dms	transitAltitude (const KStarsDateTime &dt, const GeoLocation *geo)

QTime	transitTime (const KStarsDateTime &dt, const GeoLocation *geo)

QTime	transitTimeUT (const KStarsDateTime &dt, const GeoLocation *geo)

QString	translatedLongName () const

QString	translatedName () const

QString	translatedName2 () const

int	type (void) const

QString	typeName () const

QString &	userLog ()

Public Member Functions inherited from SkyPoint
	SkyPoint (const dms &r, const dms &d)

	SkyPoint (double r, double d)

	SkyPoint ()

virtual	~SkyPoint ()

void	aberrate (const KSNumbers *num)

void	addEterms (void)

const dms &	alt () const

dms	altRefracted () const

dms	angularDistanceTo (const SkyPoint sp, double const positionAngle=0) const

void	apparentCoord (long double jd0, long double jdf)

const dms &	az () const

void	B1950ToJ2000 (void)

bool	bendlight ()

bool	checkBendLight ()

bool	checkCircumpolar (const dms *gLat)

const dms &	dec () const

const dms &	dec0 () const

SkyPoint	deprecess (const KSNumbers *num, long double epoch=J2000)

void	Equatorial1950ToGalactic (dms &galLong, dms &galLat)

void	EquatorialToHorizontal (const dms LST, const dms lat)

SkyPoint	Eterms (void)

void	findEcliptic (const dms *Obliquity, dms &EcLong, dms &EcLat)

void	GalacticToEquatorial1950 (const dms galLong, const dms galLat)

void	HorizontalToEquatorial (const dms LST, const dms lat)

void	J2000ToB1950 (void)

SkyPoint	moveAway (const SkyPoint &from, double dist)

void	nutate (const KSNumbers *num)

bool	operator== (SkyPoint &p)

void	precessFromAnyEpoch (long double jd0, long double jdf)

const dms &	ra () const

const dms &	ra0 () const

void	set (const dms &r, const dms &d)

void	setAlt (dms alt)

void	setAlt (double alt)

void	setAz (dms az)

void	setAz (double az)

void	setDec (dms d)

void	setDec (double d)

void	setDec0 (dms d)

void	setDec0 (double d)

void	setFromEcliptic (const dms *Obliquity, const dms &EcLong, const dms &EcLat)

void	setRA (dms r)

void	setRA (double r)

void	setRA0 (dms r)

void	setRA0 (double r)

void	subtractEterms (void)

double	vGeocentric (double vhelio, long double jd)

double	vGeoToVHelio (double vgeo, long double jd)

double	vHeliocentric (double vlsr, long double jd)

double	vHelioToVlsr (double vhelio, long double jd)

double	vREarth (long double jd0)

double	vRSite (double vsite[3])

double	vRSun (long double jd)

double	vTopocentric (double vgeo, double vsite[3])

double	vTopoToVGeo (double vtopo, double vsite[3])

Static Public Member Functions
static KSPlanetBase *	createPlanet (int n)

Static Public Member Functions inherited from TrailObject
static void	clearTrailsExcept (SkyObject *o)

Static Public Member Functions inherited from SkyObject
static QString	typeName (const int t)

Static Public Member Functions inherited from SkyPoint
static double	refract (const double alt)

static dms	refract (const dms alt)

static double	refractionCorr (double alt)

static double	unrefract (const double alt)

static dms	unrefract (const dms alt)

Static Public Attributes
static QVector< QColor >	planetColor

Static Public Attributes inherited from TrailObject
static const int	MaxTrail = 400

Static Public Attributes inherited from SkyObject
static const UID	invalidUID = ~0

static const UID	UID_DEEPSKY = 2

static const UID	UID_GALAXY = 1

static const UID	UID_SOLARSYS = 3

static const UID	UID_STAR = 0

Static Public Attributes inherited from SkyPoint
static const double	altCrit = -1.0

Protected Member Functions
virtual bool	findGeocentricPosition (const KSNumbers num, const KSPlanetBase Earth=NULL)=0

virtual void	findMagnitude (const KSNumbers *num)=0

void	findPA (const KSNumbers *num)

virtual void	findPhase ()

UID	solarsysUID (UID type) const

Protected Member Functions inherited from SkyObject
void	setMag (float m)

void	setMag (const QString &band, const double mag)

void	setName (const QString &name)

void	setName2 (const QString &name2=QString())

Protected Member Functions inherited from SkyPoint
void	precess (const KSNumbers *num)

Protected Attributes
EclipticPosition	ep

EclipticPosition	helEcPos

QImage	m_image

double	Phase

double	Rearth

Protected Attributes inherited from TrailObject
QList< SkyPoint >	Trail

Protected Attributes inherited from SkyObject
QSharedDataPointer< AuxInfo >	info

QString	LongName

QString	Name

QString	Name2

Protected Attributes inherited from SkyPoint
long double	lastPrecessJD

Static Protected Attributes
static const UID	UID_SOL_ASTEROID = 1

static const UID	UID_SOL_BIGOBJ = 0

static const UID	UID_SOL_COMET = 2

Static Protected Attributes inherited from TrailObject
static QSet< TrailObject * >	trailObjects

Static Protected Attributes inherited from SkyObject
static QString	emptyString

static QString	starString = QString("star")

static QString	unnamedObjectString = QString(I18N_NOOP("unnamed object"))

static QString	unnamedString = QString(I18N_NOOP("unnamed"))

Detailed Description

A subclass of TrailObject that provides additional information needed for most solar system objects.

This is a base class for KSSun, KSMoon, KSPlanet, KSAsteroid, and KSComet. Those classes cover all solar system objects except planetary moons, which are derived directly from TrailObject Provides necessary information about objects in the solar system.

Author: Mark Hollomon

Version: 1.0

Definition at line 63 of file ksplanetbase.h.

Member Enumeration Documentation

enum KSPlanetBase::Planets

Enumerator
MERCURY
VENUS
MARS
JUPITER
SATURN
URANUS
NEPTUNE
PLUTO
SUN
MOON
UNKNOWN_PLANET

Definition at line 82 of file ksplanetbase.h.

Constructor & Destructor Documentation

KSPlanetBase::KSPlanetBase	(	const QString &	s = `i18n("unnamed")`,
		const QString &	image_file = `QString()`,
		const QColor &	c = `Qt::white`,
		double	pSize = `0`
	)

explicit

Constructor.

Calls SkyObject constructor with type=2 (planet), coordinates=0.0, mag=0.0, primary name s, and all other QStrings empty.

Parameters

s	Name of planet
image_file	filename of the planet's image
c	color of the symbol to use for this planet
pSize	the planet's physical size, in km

Definition at line 57 of file ksplanetbase.cpp.

virtual KSPlanetBase::~KSPlanetBase ( )

inlinevirtual

Destructor (empty)

Definition at line 78 of file ksplanetbase.h.

Member Function Documentation

double KSPlanetBase::angSize ( ) const

inline

Returns: the Planet's angular size, in arcminutes

Definition at line 171 of file ksplanetbase.h.

QColor& KSPlanetBase::color ( )

inline

Returns: the color for the planet symbol

Definition at line 190 of file ksplanetbase.h.

KSPlanetBase * KSPlanetBase::createPlanet ( int n )

static

Definition at line 73 of file ksplanetbase.cpp.

const dms& KSPlanetBase::ecLat ( ) const

inline

Returns: pointer to Ecliptic Latitude coordinate

Definition at line 94 of file ksplanetbase.h.

void KSPlanetBase::EclipticToEquatorial ( const dms * Obliquity )

Convert Ecliptic logitude/latitude to Right Ascension/Declination.

Parameters

Obliquity current Obliquity of the Ecliptic (angle from Equator)

Definition at line 101 of file ksplanetbase.cpp.

const dms& KSPlanetBase::ecLong ( ) const

inline

Returns: pointer to Ecliptic Longitude coordinate

Definition at line 91 of file ksplanetbase.h.

void KSPlanetBase::EquatorialToEcliptic ( const dms * Obliquity )

Convert Right Ascension/Declination to Ecliptic logitude/latitude.

Parameters

Obliquity current Obliquity of the Ecliptic (angle from Equator)

Definition at line 97 of file ksplanetbase.cpp.

virtual bool KSPlanetBase::findGeocentricPosition	(	const KSNumbers *	num,
		const KSPlanetBase *	Earth = `NULL`
	)

protectedpure virtual

find the object's current geocentric equatorial coordinates (RA and Dec) This function is pure virtual; it must be overloaded by subclasses.

This function is private; it is called by the public function findPosition() which also includes the figure-of-the-earth correction, localizeCoords().

Parameters

num	pointer to current KSNumbers object
Earth	pointer to planet Earth (needed to calculate geocentric coords)

Returns: true if position was successfully calculated.

Implemented in KSComet, KSAsteroid, KSPlanet, KSMoon, KSPluto, and KSSun.

virtual void KSPlanetBase::findMagnitude ( const KSNumbers * num )

protectedpure virtual

Computes the visual magnitude for the major planets.

Parameters

num	pointer to a ksnumbers object. Needed for the saturn rings contribution to saturn's magnitude.

void KSPlanetBase::findPA ( const KSNumbers * num )

protected

Determine the position angle of the planet for a given date (used internally by findPosition() )

Definition at line 240 of file ksplanetbase.cpp.

void KSPlanetBase::findPhase ( )

protectedvirtual

Determine the phase of the planet.

Definition at line 277 of file ksplanetbase.cpp.

void KSPlanetBase::findPosition	(	const KSNumbers *	num,
		const dms *	lat = `0`,
		const dms *	LST = `0`,
		const KSPlanetBase *	Earth = `0`
	)

Find position, including correction for Figure-of-the-Earth.

Parameters

num	KSNumbers pointer for the target date/time
lat	pointer to the geographic latitude; if NULL, we skip localizeCoords()
LST	pointer to the local sidereal time; if NULL, we skip localizeCoords()
Earth	pointer to the Earth (not used for the Moon)

Definition at line 122 of file ksplanetbase.cpp.

const dms& KSPlanetBase::helEcLat ( ) const

inline

Returns: pointer to Ecliptic Heliocentric Latitude coordinate

Definition at line 110 of file ksplanetbase.h.

const dms& KSPlanetBase::helEcLong ( ) const

inline

Returns: pointer to Ecliptic Heliocentric Longitude coordinate

Definition at line 107 of file ksplanetbase.h.

const QImage& KSPlanetBase::image ( )

inline

Returns: pointer to this planet's texture

Definition at line 123 of file ksplanetbase.h.

void KSPlanetBase::init	(	const QString &	s,
		const QString &	image_file,
		const QColor &	c,
		double	pSize
	)

Definition at line 64 of file ksplanetbase.cpp.

bool KSPlanetBase::isMajorPlanet ( ) const

Returns: true if the KSPlanet is one of the eight major planets

Definition at line 151 of file ksplanetbase.cpp.

double KSPlanetBase::labelOffset ( ) const

virtual

Returns: the pixel distance for offseting the object's name label

Reimplemented from SkyObject.

Definition at line 258 of file ksplanetbase.cpp.

virtual bool KSPlanetBase::loadData ( )

pure virtual

Implemented in KSComet, KSAsteroid, KSPlanet, KSMoon, and KSSun.

virtual double KSPlanetBase::pa ( ) const

inlinevirtual

Returns: the Planet's position angle.

Reimplemented from SkyObject.

Definition at line 163 of file ksplanetbase.h.

dms KSPlanetBase::phase ( )

inline

Returns: the phase angle of this planet

Definition at line 187 of file ksplanetbase.h.

double KSPlanetBase::physicalSize ( ) const

inline

Returns: the Planet's physical size, in km

Definition at line 179 of file ksplanetbase.h.

double KSPlanetBase::rearth ( ) const

inline

Returns: distance from Earth, in Astronomical Units (1 AU is Earth-Sun distance)

Definition at line 134 of file ksplanetbase.h.

double KSPlanetBase::rsun ( ) const

inline

Returns: distance from Sun, in Astronomical Units (1 AU is Earth-Sun distance)

Definition at line 126 of file ksplanetbase.h.

void KSPlanetBase::setAngularSize ( double size )

inline

set the planet's angular size, in km.

Parameters

size	the planet's size, in km

Definition at line 176 of file ksplanetbase.h.

void KSPlanetBase::setColor ( const QColor & c )

inline

Set the color for the planet symbol.

Definition at line 193 of file ksplanetbase.h.

void KSPlanetBase::setEcLat ( dms elat )

inline

Set Ecliptic Geocentric Latitude according to argument.

Parameters

elat	Ecliptic Latitude

Definition at line 104 of file ksplanetbase.h.

void KSPlanetBase::setEcLong ( dms elong )

inline

Set Ecliptic Geocentric Longitude according to argument.

Parameters

elong Ecliptic Longitude

Definition at line 99 of file ksplanetbase.h.

void KSPlanetBase::setPA ( double p )

inline

Set the Planet's position angle.

Parameters

p	the new position angle

Definition at line 168 of file ksplanetbase.h.

void KSPlanetBase::setPhysicalSize ( double size )

inline

set the planet's physical size, in km.

Parameters

size	the planet's size, in km

Definition at line 184 of file ksplanetbase.h.

void KSPlanetBase::setRearth ( double r )

inline

Set the distance from Earth, in AU.

Parameters

r	the new earth-distance in AU

Definition at line 139 of file ksplanetbase.h.

void KSPlanetBase::setRearth ( const KSPlanetBase * Earth )

compute and set the distance from Earth, in AU.

Parameters

Earth pointer to the Earth from which to calculate the distance.

Definition at line 201 of file ksplanetbase.cpp.

void KSPlanetBase::setRsun ( double r )

inline

Set the solar distance in AU.

Parameters

r	the new solar distance in AU

Definition at line 131 of file ksplanetbase.h.

UID KSPlanetBase::solarsysUID ( UID type ) const

inlineprotected

Compute high 32-bits of UID.

Definition at line 210 of file ksplanetbase.h.

void KSPlanetBase::updateCoords	(	KSNumbers *	num,
		bool	includePlanets = `true`,
		const dms *	lat = `0`,
		const dms *	LST = `0`,
		bool	forceRecompute = `false`
	)

virtual

Update position of the planet (reimplemented from SkyPoint)

Parameters

num	current KSNumbers object
includePlanets	this function does nothing if includePlanets=false
lat	pointer to the geographic latitude; if NULL, we skip localizeCoords()
LST	pointer to the local sidereal time; if NULL, we skip localizeCoords()

Reimplemented from SkyPoint.

Definition at line 105 of file ksplanetbase.cpp.

Member Data Documentation

EclipticPosition KSPlanetBase::ep

protected

Definition at line 238 of file ksplanetbase.h.

EclipticPosition KSPlanetBase::helEcPos

protected

Definition at line 242 of file ksplanetbase.h.

QImage KSPlanetBase::m_image

protected

Definition at line 245 of file ksplanetbase.h.

double KSPlanetBase::Phase

protected

Definition at line 244 of file ksplanetbase.h.

QVector< QColor > KSPlanetBase::planetColor

static

Initial value:

= QVector<QColor>() <<
  QColor("slateblue") << 
  QColor("lightgreen") << 
  QColor("red") << 
  QColor("goldenrod") << 
  QColor("khaki") << 
  QColor("lightseagreen") << 
  QColor("skyblue") << 
  QColor("grey") << 
  QColor("yellow") << 
  QColor("white")

Definition at line 86 of file ksplanetbase.h.

double KSPlanetBase::Rearth

protected

Definition at line 243 of file ksplanetbase.h.

const SkyObject::UID KSPlanetBase::UID_SOL_ASTEROID = 1

staticprotected

Asteroids.

Definition at line 205 of file ksplanetbase.h.

const SkyObject::UID KSPlanetBase::UID_SOL_BIGOBJ = 0

staticprotected

Big object.

Planet, Moon, Sun.

Definition at line 203 of file ksplanetbase.h.

const SkyObject::UID KSPlanetBase::UID_SOL_COMET = 2

staticprotected

Comets.

Definition at line 207 of file ksplanetbase.h.

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

kstars

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

kstars

kdeedu API Reference

Search