Stellarium  0.20.4
Public Types | Public Member Functions | Static Public Attributes | Static Protected Member Functions | Friends
NomenclatureItem Class Reference

Public Types

enum  NomenclatureItemType {
  niUNDEFINED = 0, niAlbedoFeature = 1, niArcus = 2, niAstrum = 3,
  niCatena = 4, niCavus = 5, niChaos = 6, niChasma = 7,
  niCollis = 8, niCorona = 9, niCrater = 10, niDorsum = 11,
  niEruptiveCenter = 12, niFacula = 13, niFarrum = 14, niFlexus = 15,
  niFluctus = 16, niFlumen = 17, niFretum = 18, niFossa = 19,
  niInsula = 20, niLabes = 21, niLabyrinthus = 22, niLacuna = 23,
  niLacus = 24, niLargeRingedFeature = 25, niLinea = 26, niLingula = 27,
  niMacula = 28, niMare = 29, niMensa = 30, niMons = 31,
  niOceanus = 32, niPalus = 33, niPatera = 34, niPlanitia = 35,
  niPlanum = 36, niPlume = 37, niPromontorium = 38, niRegio = 39,
  niRima = 40, niRupes = 41, niScopulus = 42, niSerpens = 43,
  niSulcus = 44, niSinus = 45, niTerra = 46, niTholus = 47,
  niUnda = 48, niVallis = 49, niVastitas = 50, niVirga = 51,
  niLandingSite = 52, niLenticula = 53, niReticulum = 54, niSatelliteFeature = 55,
  niTessera = 56, niSaxum = 57
- 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,
  Script = 0x00800000, DebugAid = 0x01000000, NoFont = 0x02000000, PlainText = 0x04000000
 Used as named bitfield flags as specifiers to filter results of getInfoString. More...

Public Member Functions

 NomenclatureItem (PlanetP nPlanet, int nId, const QString &nName, const QString &nContext, NomenclatureItemType nItemType, float nLatitude, float nLongitude, float nSize)
virtual QString getType (void) const
 Get the type of object.
virtual QString getID (void) const
 Returns a unique identifier for this object. More...
virtual float getSelectPriority (const StelCore *core) const
 Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority.
virtual QString getInfoString (const StelCore *core, const InfoStringGroup &flags) const
 Get an HTML string to describe the object. More...
virtual Vec3f getInfoColor (void) const
 Get a color used to display info about the object.
virtual Vec3d getJ2000EquatorialPos (const StelCore *) const
 Get observer-centered equatorial coordinates at equinox J2000.
virtual float getVMagnitude (const StelCore *core) const
 Get the visual magnitude of a nomenclature item. Dummy method, returns 99.
virtual double getAngularSize (const StelCore *core) const
 Get the angular size of nomenclature item.
virtual QString getNameI18n (void) const
 Get the localized name of nomenclature item.
virtual QString getEnglishName (void) const
 Get the english name of nomenclature item.
virtual void translateName (const StelTranslator &trans)
 Translate planet name using the passed translator.
void draw (StelCore *core, StelPainter *painter)
NomenclatureItemType getNomenclatureType () const
void update (double deltaTime)
void setFlagLabels (bool b)
bool getFlagLabels (void) const
void setFlagHideLocalNomenclature (bool b)
bool getFlagHideLocalNomenclature () const
PlanetP getPlanet (void) const
float getLatitude (void) const
float getLongitude (void) const
- Public Member Functions inherited from StelObject
virtual SphericalRegionP getRegion () const
 Default implementation of the getRegion method. More...
virtual Vec3d getPointInRegion () const
 Default implementation of the getPointInRegion method. 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...
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...
Vec3f getRTSTime (StelCore *core) const
 Get today's time of rise, transit and set for celestial object for current location. More...
float getVMagnitudeWithExtinction (const StelCore *core) const
 Return object's apparent V magnitude as seen from observer including extinction. More...
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

Static Public Attributes

static const QString NOMENCLATURE_TYPE
- Static Public Attributes inherited from StelObject
static const InfoStringGroupFlags AllInfo
 A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More...
static const InfoStringGroupFlags ShortInfo = static_cast<InfoStringGroupFlags>(Name|CatalogNumber|Magnitude|RaDecJ2000)
 A pre-defined set of specifiers for the getInfoString flags argument to getInfoString.

Static Protected Member Functions

static NomenclatureItemType getNomenclatureItemType (const QString abbrev)
 returns a type enum for a given 2-letter code
static void createNameLists ()
 Should be triggered once at start and then whenever program language setting changes.


class NomenclatureMgr

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...
- 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 double alt_app, const int decimals=1) const
 Format the magnitude info string for the object. More...
void postProcessInfoString (QString &str, const InfoStringGroup &flags) const
 Apply post processing on the info string. More...

Member Function Documentation

◆ getID()

virtual QString NomenclatureItem::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.

◆ getInfoString()

virtual QString NomenclatureItem::getInfoString ( const StelCore core,
const InfoStringGroup &  flags 
) const
coreA pointer to the core a set of flags with information types to include.

Implements StelObject.