StelObject Class Reference

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

#include <StelObject.hpp>

List of all members.

Public Types
enum	InfoStringGroupFlags {   Name = 0x00000001, CatalogNumber = 0x00000002, Magnitude = 0x00000004, RaDecJ2000 = 0x00000008,   RaDecOfDate = 0x00000010, AltAzi = 0x00000020, Distance = 0x00000040, Size = 0x00000080,   Extra1 = 0x00000100, Extra2 = 0x00000200, Extra3 = 0x00000400, PlainText = 0x00000800,   HourAngle = 0x00001000, AbsoluteMagnitude = 0x00002000 }
typedef QFlags < InfoStringGroupFlags >	InfoStringGroup
Public Member Functions
	Q_FLAGS (InfoStringGroup) static const InfoStringGroupFlags AllInfo
	A pre-defined set of specifiers for the getInfoString flags argument to getInfoString.
virtual SphericalRegionP	getRegion () const
	Default implementation of the getRegion method.
virtual QString	getInfoString (const StelCore *core, const InfoStringGroup &flags=StelObject::AllInfo) const =0
	Write I18n information about the object in QString.
virtual QString	getType () const =0
	Return object's type. It should be the name of the class.
virtual QString	getEnglishName () const =0
	Return object's name in english.
virtual QString	getNameI18n () const =0
	Return translated object's name.
virtual Vec3d	getJ2000EquatorialPos (const StelCore *core) const =0
	Get observer-centered equatorial coordinates at equinox J2000.
Vec3d	getEquinoxEquatorialPos (const StelCore *core) const
	Get observer-centered equatorial coordinate at the current equinox The frame has it's 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	getSideralPosGeometric (const StelCore *core) const
	Get observer-centered hour angle + declination (at current equinox) It is the geometric position, i.e.
Vec3d	getSideralPosApparent (const StelCore *core) const
	Get observer-centered hour angle + declination (at current equinox) It is the apparent position, i.e.
Vec3d	getAltAzPosGeometric (const StelCore *core) const
	Get observer-centered alt/az position It is the geometric position, i.e.
Vec3d	getAltAzPosApparent (const StelCore *core) const
	Get observer-centered alt/az position It is the apparent position, i.e.
Vec3d	getAltAzPosAuto (const StelCore *core) const
	Get observer-centered alt/az position It is the automatic position, i.e.
virtual float	getVMagnitude (const StelCore *core, bool withExtinction=false) const
	Return object's apparent V magnitude as seen from observer.
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.
virtual Vec3f	getInfoColor () const
	Get a color used to display info about the object.
virtual double	getCloseViewFov (const StelCore *) const
	Return the best FOV in degree to use for a close view of the object.
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).
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().
Static Public Attributes
static const InfoStringGroupFlags	ShortInfo = (InfoStringGroupFlags)(Name|CatalogNumber|Magnitude|RaDecJ2000)
	A pre-defined set of specifiers for the getInfoString flags argument to getInfoString.
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.
void	postProcessInfoString (QString &str, const InfoStringGroup &flags) const
	Apply post processing on the info string.

---

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

---

Member Enumeration Documentation

enum StelObject::InfoStringGroupFlags

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.
Extra1	Derived class-specific extra fields.
Extra2	Derived class-specific extra fields.
Extra3	Derived class-specific extra fields.
PlainText	Strip HTML tags from output.
HourAngle	The hour angle + DE (of date).
AbsoluteMagnitude	The absolute magnitude.

---

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 it's 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 it's 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 it's 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 Nebula, Planet, BigStarCatalogExtension::StarWrapper< Star >, BigStarCatalogExtension::StarWrapper< Star2 >, BigStarCatalogExtension::StarWrapper< Star3 >, and BigStarCatalogExtension::StarWrapper< Star1 >.

virtual double StelObject::getCloseViewFov

(

const StelCore *

)

const [inline, virtual]

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

Reimplemented in Nebula, and Planet.

virtual QString StelObject::getEnglishName

(

)

const [pure virtual]

Return object's name in english.

Implemented in Nebula, Planet, BigStarCatalogExtension::StarWrapperBase, BigStarCatalogExtension::StarWrapper< Star >, BigStarCatalogExtension::StarWrapper1, BigStarCatalogExtension::StarWrapper< Star2 >, BigStarCatalogExtension::StarWrapper< Star3 >, and BigStarCatalogExtension::StarWrapper< Star1 >.

Vec3d StelObject::getEquinoxEquatorialPos

(

const StelCore *

core

)

const

Get observer-centered equatorial coordinate at the current equinox The frame has it's 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.

virtual Vec3f StelObject::getInfoColor

(

void

)

const [inline, virtual]

Get a color used to display info about the object.

Reimplemented in Nebula, Planet, BigStarCatalogExtension::StarWrapper< Star >, BigStarCatalogExtension::StarWrapper< Star2 >, BigStarCatalogExtension::StarWrapper< Star3 >, and BigStarCatalogExtension::StarWrapper< Star1 >.

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 Comet, MinorPlanet, Nebula, Planet, BigStarCatalogExtension::StarWrapperBase, and BigStarCatalogExtension::StarWrapper1.

virtual Vec3d StelObject::getJ2000EquatorialPos

(

const StelCore *

core

)

const [pure virtual]

Get observer-centered equatorial coordinates at equinox J2000.

Implemented in Nebula, Planet, BigStarCatalogExtension::StarWrapper< Star >, BigStarCatalogExtension::StarWrapper< Star2 >, BigStarCatalogExtension::StarWrapper< Star3 >, and BigStarCatalogExtension::StarWrapper< Star1 >.

virtual QString StelObject::getNameI18n

(

)

const [pure virtual]

Return translated object's name.

Implemented in Nebula, Planet, BigStarCatalogExtension::StarWrapperBase, BigStarCatalogExtension::StarWrapper< Star >, BigStarCatalogExtension::StarWrapper< Star2 >, BigStarCatalogExtension::StarWrapper< Star3 >, and BigStarCatalogExtension::StarWrapper< Star1 >.

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 [inline, virtual]

Default implementation of the getRegion method.

Return the spatial region of the object.

Implements StelRegionObject.

Reimplemented in Nebula.

virtual double StelObject::getSatellitesFov

(

const StelCore *

)

const [inline, virtual]

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

Reimplemented in Planet.

virtual float StelObject::getSelectPriority

(

const StelCore *

)

const [inline, virtual]

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

Reimplemented in Nebula, Planet, BigStarCatalogExtension::StarWrapper< Star >, BigStarCatalogExtension::StarWrapper< Star2 >, BigStarCatalogExtension::StarWrapper< Star3 >, and BigStarCatalogExtension::StarWrapper< Star1 >.

Vec3d StelObject::getSideralPosApparent

(

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::getSideralPosGeometric

(

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

virtual QString StelObject::getType

(

)

const [pure virtual]

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

Implemented in Nebula, Planet, and BigStarCatalogExtension::StarWrapperBase.

virtual float StelObject::getVMagnitude	(	const StelCore *	core,
		bool	withExtinction = false
	)			const [virtual]

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

Reimplemented in Comet, MinorPlanet, Nebula, Planet, BigStarCatalogExtension::StarWrapper< Star >, BigStarCatalogExtension::StarWrapper< Star2 >, BigStarCatalogExtension::StarWrapper< Star3 >, and BigStarCatalogExtension::StarWrapper< Star1 >.

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

Apply post processing on the info string.

StelObject::Q_FLAGS

(

InfoStringGroup

)

const

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

---

Member Data Documentation

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

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