Stellarium 0.11.1
Home · All Namespaces · All Classes · Functions · Coding Style · Scripting · Plugins · File Structure
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions
StelObject Class Reference

#include <StelObject.hpp>

List of all members.

Public Types

enum  InfoStringGroup {
  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
}

Public Member Functions

virtual SphericalRegionP getRegion () const
virtual QString getInfoString (const StelCore *core, const InfoStringGroup &flags=StelObject::AllInfo) const =0
virtual QString getType () const =0
virtual QString getEnglishName () const =0
virtual QString getNameI18n () const =0
virtual Vec3d getJ2000EquatorialPos (const StelCore *core) const =0
Vec3d getEquinoxEquatorialPos (const StelCore *core) const
Vec3d getSideralPosGeometric (const StelCore *core) const
Vec3d getSideralPosApparent (const StelCore *core) const
Vec3d getAltAzPosGeometric (const StelCore *core) const
Vec3d getAltAzPosApparent (const StelCore *core) const
Vec3d getAltAzPosAuto (const StelCore *core) const
virtual float getVMagnitude (const StelCore *) const
virtual float getSelectPriority (const StelCore *) const
virtual Vec3f getInfoColor () const
virtual double getCloseViewFov (const StelCore *) const
virtual double getSatellitesFov (const StelCore *) const
virtual double getParentSatellitesFov (const StelCore *) const
virtual double getAngularSize (const StelCore *core) const =0

Static Public Attributes

static const InfoStringGroup AllInfo = (InfoStringGroup)(Name|CatalogNumber|Magnitude|RaDecJ2000|RaDecOfDate|AltAzi|Distance|Size|Extra1|Extra2|Extra3|HourAngle|AbsoluteMagnitude)
static const InfoStringGroup ShortInfo = (InfoStringGroup)(Name|CatalogNumber|Magnitude|RaDecJ2000)

Protected Member Functions

QString getPositionInfoString (const StelCore *core, const InfoStringGroup &flags) const
void postProcessInfoString (QString &str, const InfoStringGroup &flags) const

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

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.

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

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

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

virtual QString StelObject::getInfoString ( const StelCore core,
const InfoStringGroup flags = StelObject::AllInfo 
) const [pure virtual]

Write I18n information about the object in QString.

Parameters:
corethe StelCore object to use
flagsa 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 BigStarCatalogExtension::StarWrapper1, Planet, MinorPlanet, BigStarCatalogExtension::StarWrapperBase, Comet, and Nebula.

virtual SphericalRegionP StelObject::getRegion ( ) const [inline, virtual]

Default implementation of the getRegion method.

Calling this method on some object will cause an error if they need a valid StelNavigator instance to compute their position. Return the spatial region of the object.

Implements StelRegionObject.

Reimplemented in Nebula.

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

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