The base abstract class for sky objects used in Stellarium like Stars, Planets, Constellations etc... More...

#include <StelObject.hpp>

Inheritance diagram for StelObject:

Collaboration diagram for StelObject:

Public Types
enum	InfoStringGroupFlags { Name = 0x00000001, CatalogNumber = 0x00000002, Magnitude = 0x00000004, RaDecJ2000 = 0x00000008, RaDecOfDate = 0x00000010, AltAzi = 0x00000020, Distance = 0x00000040, Size = 0x00000080, Extra = 0x00000100, HourAngle = 0x00000200, AbsoluteMagnitude = 0x00000400, GalacticCoord = 0x00000800, SupergalacticCoord = 0x00001000, ObjectType = 0x00002000, EclipticCoordJ2000 = 0x00004000, EclipticCoordOfDate = 0x00008000, IAUConstellation = 0x00010000, SiderealTime = 0x00020000, NoFont = 0x00040000, PlainText = 0x00080000 }
	Used as named bitfield flags as specifiers to filter results of getInfoString. More...

Public Member Functions
virtual SphericalRegionP	getRegion () const
	Default implementation of the getRegion method. More...

virtual Vec3d	getPointInRegion () const
	Default implementation of the getPointInRegion method. More...

virtual QString	getInfoString (const StelCore *core, const InfoStringGroup &flags=StelObject::AllInfo) const =0
	Write I18n information about the object in QString. More...

virtual QVariantMap	getInfoMap (const StelCore *core) const
	Return a key/value map with data about an object's position, magnitude and so on. More...

virtual QString	getType () const =0
	Return object's type. It should be the name of the class. More...

virtual QString	getEnglishName () const =0
	Return object's name in english. More...

virtual QString	getNameI18n () const =0
	Return translated object's name. More...

virtual Vec3d	getJ2000EquatorialPos (const StelCore *core) const =0
	Get observer-centered equatorial coordinates at equinox J2000. 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. More...

Vec3d	getEquinoxEquatorialPosApparent (const StelCore *core) const
	Like getEquinoxEquatorialPos(core), but always adds refraction correction to the position. More...

Vec3d	getEquinoxEquatorialPosAuto (const StelCore *core) const
	Like getEquinoxEquatorialPos(core), but adds refraction correction to the position if atmosphere is active. More...

Vec3d	getGalacticPos (const StelCore *core) const
	Get observer-centered galactic coordinates. More...

Vec3d	getSupergalacticPos (const StelCore *core) const
	Get observer-centered supergalactic coordinates. More...

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

virtual float	getVMagnitude (const StelCore *core) const
	Return object's apparent V magnitude as seen from observer, without including extinction. More...

float	getVMagnitudeWithExtinction (const StelCore *core) const
	Return object's apparent V magnitude as seen from observer including extinction. More...

virtual float	getSelectPriority (const StelCore *) const
	Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority. More...

virtual Vec3f	getInfoColor () const
	Get a color used to display info about the object. More...

virtual double	getCloseViewFov (const StelCore *) const
	Return the best FOV in degree to use for a close view of the object. More...

virtual double	getSatellitesFov (const StelCore *) const
	Return the best FOV in degree to use for a global view of the object satellite system (if there are satellites) More...

virtual double	getParentSatellitesFov (const StelCore *) const

virtual double	getAngularSize (const StelCore *core) const =0
	Return the angular radius of a circle containing the object as seen from the observer with the circle center assumed to be at getJ2000EquatorialPos(). More...

Static Public Attributes
static const InfoStringGroupFlags	AllInfo
	A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More...

static const InfoStringGroupFlags	ShortInfo = (InfoStringGroupFlags)(Name\|CatalogNumber\|Magnitude\|RaDecJ2000)
	A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More...

Protected Member Functions
QString	getPositionInfoString (const StelCore *core, const InfoStringGroup &flags) const
	Format the positional info string contain J2000/of date/altaz/hour angle positions for the object. More...

void	postProcessInfoString (QString &str, const InfoStringGroup &flags) const
	Apply post processing on the info string. More...

Detailed Description

The base abstract class for sky objects used in Stellarium like Stars, Planets, Constellations etc...

Normally you should use StelObjectP instead of StelObject* which have by default the same behaviour, but which can be added reference counting if needed.

See also: StelObjectP

Definition at line 36 of file StelObject.hpp.

Member Enumeration Documentation

enum StelObject::InfoStringGroupFlags

Used as named bitfield flags as specifiers to filter results of getInfoString.

The precise definition of these should be documented in the getInfoString documentation for the derived classes for all specifiers which are defined in that derivative. Use InfoStringGroup instead.

Enumerator
Name	An object's name.
CatalogNumber	Catalog numbers.
Magnitude	Magnitude related data.
RaDecJ2000	The equatorial position (J2000 ref)
RaDecOfDate	The equatorial position (of date)
AltAzi	The position (Altitude/Azimuth)
Distance	Info about an object's distance.
Size	Info about an object's size.
Extra	Derived class-specific extra fields.
HourAngle	The hour angle + DE (of date)
AbsoluteMagnitude	The absolute magnitude.
GalacticCoord	The galactic position.
SupergalacticCoord	The supergalactic position.
ObjectType	The type of the object (star, planet, etc.)
EclipticCoordJ2000	The ecliptic position (J2000.0 ref) [+ XYZ of VSOP87A (used mainly for debugging, not public)].
EclipticCoordOfDate	The ecliptic position (of date)
IAUConstellation	Three-letter constellation code (And, Boo, Cas, ...)
SiderealTime	Mean and Apparent Sidereal Time.
PlainText	Strip HTML tags from output.

Definition at line 47 of file StelObject.hpp.

Member Function Documentation

Vec3d StelObject::getAltAzPosApparent ( const StelCore * core ) const

Get observer-centered alt/az position It is the apparent position, i.e.

taking the refraction effect into account. The frame has its Z axis at the zenith

Vec3d StelObject::getAltAzPosAuto ( const StelCore * core ) const

Get observer-centered alt/az position It is the automatic position, i.e.

taking the refraction effect into account if atmosphere is on. The frame has its Z axis at the zenith

Vec3d StelObject::getAltAzPosGeometric ( const StelCore * core ) const

Get observer-centered alt/az position It is the geometric position, i.e.

without taking refraction effect into account. The frame has its Z axis at the zenith

virtual double StelObject::getAngularSize ( const StelCore * core ) const

pure virtual

Return the angular radius of a circle containing the object as seen from the observer with the circle center assumed to be at getJ2000EquatorialPos().

Returns: radius in degree. This value is the apparent angular size of the object, and is independent of the current FOV.

Implemented in Planet, Satellite, Nebula, MeteorShower, Exoplanet, StarWrapper< Star >, StarWrapper< Star2 >, StarWrapper< Star3 >, StarWrapper< Star1 >, Pulsar, Quasar, Supernova, Nova, TelescopeClient, and CustomObject.

virtual double StelObject::getCloseViewFov ( const StelCore * ) const

inlinevirtual

Return the best FOV in degree to use for a close view of the object.

Reimplemented in Planet, and Nebula.

Definition at line 199 of file StelObject.hpp.

virtual QString StelObject::getEnglishName ( ) const

pure virtual

Return object's name in english.

Implemented in Planet, Satellite, Nebula, StarWrapper1, MeteorShower, Exoplanet, Pulsar, StarWrapper< Star >, StarWrapper< Star2 >, StarWrapper< Star3 >, StarWrapper< Star1 >, Comet, Quasar, Supernova, Nova, MinorPlanet, CustomObject, TelescopeClient, and StarWrapperBase.

Vec3d StelObject::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 StelObject::getEquinoxEquatorialPosApparent ( const StelCore * core ) const

Like getEquinoxEquatorialPos(core), but always adds refraction correction to the position.

Vec3d StelObject::getEquinoxEquatorialPosAuto ( const StelCore * core ) const

Like getEquinoxEquatorialPos(core), but adds refraction correction to the position if atmosphere is active.

Vec3d StelObject::getGalacticPos ( const StelCore * core ) const

Get observer-centered galactic coordinates.

virtual Vec3f StelObject::getInfoColor ( void ) const

inlinevirtual

Get a color used to display info about the object.

Reimplemented in Planet, Satellite, Nebula, MeteorShower, Exoplanet, Pulsar, StarWrapper< Star >, StarWrapper< Star2 >, StarWrapper< Star3 >, StarWrapper< Star1 >, Quasar, Supernova, Nova, TelescopeClient, and CustomObject.

Definition at line 196 of file StelObject.hpp.

virtual QVariantMap StelObject::getInfoMap ( const StelCore * core ) const

virtual

Return a key/value map with data about an object's position, magnitude and so on.

Useful in a context like scripting. Derived objects can add their own special information tags.

Parameters

core	the current StelCore

Returns

a map of object data. Keys:

altitude : apparent altitude angle in decimal degrees
azimuth : apparent azimuth angle in decimal degrees
altitude-geometric : geometric altitude angle in decimal degrees
azimuth-geometric : geometric azimuth angle in decimal degrees
ra : right ascension angle (current date frame) in decimal degrees
dec : declination angle (current date frame) in decimal degrees
raJ2000 : right ascension angle (J2000 frame) in decimal degrees
decJ2000 : declination angle (J2000 frame) in decimal degrees
glong : galactic longitude in decimal degrees
glat : galactic latitude in decimal degrees
sglong : supergalactic longitude in decimal degrees
sglat : supergalactic latitude in decimal degrees
elong : ecliptic longitude in decimal degrees (on Earth only!)
elat : ecliptic latitude in decimal degrees (on Earth only!)
elongJ2000 : ecliptic longitude (Earth's J2000 frame) in decimal degrees
elatJ2000 : ecliptic latitude (Earth's J2000 frame) in decimal degrees
vmag : visual magnitude
vmage : visual magnitude (after atmospheric extinction)
size: angular size in radians
size-dd : angular size in decimal degrees
size-deg : angular size in decimal degrees (formatted string)
size-dms : angular size in DMS format
name : english name of the object
localized-name : localized name

Reimplemented in Planet, Satellite, Nebula, StarWrapper1, MeteorShower, Exoplanet, Pulsar, Comet, Quasar, Supernova, and Nova.

virtual QString StelObject::getInfoString	(	const StelCore *	core,
		const InfoStringGroup &	flags = `StelObject::AllInfo`
	)		const

pure virtual

Write I18n information about the object in QString.

Parameters

core	the StelCore object to use
flags	a set of InfoStringGroup flags which are used to filter the return value - including specified types of information and altering the output format.

Returns: an HTML string containing information about the StelObject.

Implemented in Planet, Nebula, Satellite, StarWrapper1, MeteorShower, Exoplanet, Pulsar, Comet, TelescopeClient, MinorPlanet, Quasar, Supernova, StarWrapperBase, Nova, and CustomObject.

virtual Vec3d StelObject::getJ2000EquatorialPos ( const StelCore * core ) const

pure virtual

Get observer-centered equatorial coordinates at equinox J2000.

Implemented in Planet, Satellite, Nebula, TelescopeClientDummy, MeteorShower, Exoplanet, Pulsar, Quasar, Supernova, StarWrapper< Star >, StarWrapper< Star2 >, StarWrapper< Star3 >, StarWrapper< Star1 >, Nova, and CustomObject.

virtual QString StelObject::getNameI18n ( ) const

pure virtual

Return translated object's name.

Implemented in Planet, Satellite, Nebula, MeteorShower, Exoplanet, Pulsar, StarWrapper< Star >, StarWrapper< Star2 >, StarWrapper< Star3 >, StarWrapper< Star1 >, Comet, Quasar, Supernova, MinorPlanet, Nova, CustomObject, TelescopeClient, and StarWrapperBase.

virtual Vec3d StelObject::getPointInRegion ( ) const

inlinevirtual

Default implementation of the getPointInRegion method.

Return the J2000 Equatorial Position of the object.

Implements StelRegionObject.

Definition at line 92 of file StelObject.hpp.

QString StelObject::getPositionInfoString	(	const StelCore *	core,
		const InfoStringGroup &	flags
	)		const

protected

Format the positional info string contain J2000/of date/altaz/hour angle positions for the object.

virtual SphericalRegionP StelObject::getRegion ( ) const

inlinevirtual

Default implementation of the getRegion method.

Return the spatial region of the object.

Implements StelRegionObject.

Reimplemented in Nebula.

Definition at line 88 of file StelObject.hpp.

virtual double StelObject::getSatellitesFov ( const StelCore * ) const

inlinevirtual

Return the best FOV in degree to use for a global view of the object satellite system (if there are satellites)

Reimplemented in Planet.

Definition at line 202 of file StelObject.hpp.

virtual float StelObject::getSelectPriority ( const StelCore * ) const

virtual

Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority.

Reimplemented in Planet, Nebula, Satellite, MeteorShower, Exoplanet, Pulsar, Quasar, and CustomObject.

Vec3d StelObject::getSiderealPosApparent ( const StelCore * core ) const

Get observer-centered hour angle + declination (at current equinox) It is the apparent position, i.e.

taking the refraction effect into account. The frame has its Z axis at the planet's current rotation axis

Vec3d StelObject::getSiderealPosGeometric ( const StelCore * core ) const

Get observer-centered hour angle + declination (at current equinox) It is the geometric position, i.e.

without taking refraction effect into account. The frame has its Z axis at the planet's current rotation axis

Vec3d StelObject::getSupergalacticPos ( const StelCore * core ) const

Get observer-centered supergalactic coordinates.

virtual QString StelObject::getType ( ) const

pure virtual

Return object's type. It should be the name of the class.

Implemented in Planet, Nebula, Satellite, MeteorShower, TelescopeClient, Exoplanet, Pulsar, Supernova, Quasar, Nova, StarWrapperBase, and CustomObject.

virtual float StelObject::getVMagnitude ( const StelCore * core ) const

virtual

Return object's apparent V magnitude as seen from observer, without including extinction.

Reimplemented in Planet, Satellite, Nebula, Exoplanet, Pulsar, StarWrapper< Star >, StarWrapper< Star2 >, StarWrapper< Star3 >, StarWrapper< Star1 >, Comet, Quasar, Supernova, Nova, MinorPlanet, and CustomObject.

float StelObject::getVMagnitudeWithExtinction ( const StelCore * core ) const

Return object's apparent V magnitude as seen from observer including extinction.

Extinction obviously only if atmosphere=on.

void StelObject::postProcessInfoString	(	QString &	str,
		const InfoStringGroup &	flags
	)		const

protected

Apply post processing on the info string.

Member Data Documentation

const InfoStringGroupFlags StelObject::AllInfo

static

Initial value:

= (InfoStringGroupFlags)(Name|CatalogNumber|Magnitude|RaDecJ2000|RaDecOfDate|AltAzi|Distance|Size|Extra|HourAngle|
                                       AbsoluteMagnitude|GalacticCoord|SupergalacticCoord|ObjectType|EclipticCoordJ2000|
                                       EclipticCoordOfDate|IAUConstellation|SiderealTime)

A pre-defined set of specifiers for the getInfoString flags argument to getInfoString.

Definition at line 78 of file StelObject.hpp.

const InfoStringGroupFlags StelObject::ShortInfo = (InfoStringGroupFlags)(Name|CatalogNumber|Magnitude|RaDecJ2000)

static

A pre-defined set of specifiers for the getInfoString flags argument to getInfoString.

Definition at line 82 of file StelObject.hpp.

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

/home/aw/devel/stellarium/0.15/src/core/StelObject.hpp

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation