 |
Stellarium
HEAD
|
|
Stellarium
HEAD
|
TODO GZ says PLEASE Document this thoroughly! If possible recombine CustomObject and StelMarker & derivatives, or remove one of the two. More...
#include <CustomObject.hpp>
Public Member Functions | |
| CustomObject (const QString &codesignation, const Vec3d &coordJ2000, const bool isaMarker) | |
| QString | getType (void) const override |
| Get the type of object. | |
| QString | getObjectType (void) const override |
| Get the type of object. | |
| QString | getObjectTypeI18n (void) const override |
| Return object's type. It should be translated lowercase name of the type of the object. | |
| QString | getID (void) const override |
| Returns a unique identifier for this object. More... | |
| float | getSelectPriority (const StelCore *core) const override |
| Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority. | |
| QString | getInfoString (const StelCore *core, const InfoStringGroup &flags) const override |
| Get an HTML string to describe the object. More... | |
| Vec3f | getInfoColor (void) const override |
| Get a color used to display info about the object. | |
| Vec3d | getJ2000EquatorialPos (const StelCore *core) const override |
| Get observer-centered equatorial coordinates at equinox J2000, including aberration. | |
| float | getVMagnitude (const StelCore *core) const override |
| Get the visual magnitude of custom object. | |
| QString | getNameI18n (void) const override |
| Get the localized name of custom object. | |
| QString | getEnglishName (void) const override |
| Get the english name of custom object. | |
| void | update (double deltaTime) |
 Public Member Functions inherited from StelObject | |
| SphericalRegionP | getRegion () const override |
| Default implementation of the getRegion method. More... | |
| Vec3d | getPointInRegion () const override |
| 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... | |
| virtual Vec4d | getRTSTime (const StelCore *core, const double altitude=0.) const |
| Compute time of rise, transit and set for celestial object for current location. More... | |
| float | getVMagnitudeWithExtinction (const StelCore *core, const float knownVMag=-1000.f) 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 |
| virtual double | getAngularRadius (const StelCore *core) const |
| 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... | |
| virtual float | getAirmass (const StelCore *core) const |
| Return airmass value for the object (for atmosphere-dependent calculations) More... | |
Static Public Attributes | |
| static const QString | CUSTOMOBJECT_TYPE |
| Static Public Attributes inherited from StelObject | |
| static constexpr InfoStringGroup | AllInfo |
| A pre-defined "all available" set of specifiers for the getInfoString flags argument to getInfoString. More... | |
| static constexpr InfoStringGroup | DefaultInfo |
| A pre-defined "default" set of specifiers for the getInfoString flags argument to getInfoString It appears useful to propose this set as post-install settings and let users configure more on demand. More... | |
| static constexpr InfoStringGroup | ShortInfo = static_cast<InfoStringGroup>(Name|CatalogNumber|Magnitude|RaDecJ2000) |
| A pre-defined "shortest useful" set of specifiers for the getInfoString flags argument to getInfoString. | |
Friends | |
| class | CustomObjectMgr |
Additional Inherited Members | |
| 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 , SolarLunarPosition = 0x00800000 , Script = 0x01000000 , DebugAid = 0x02000000 , NoFont = 0x04000000 , PlainText = 0x08000000 } |
| Used as named bitfield flags as specifiers to filter results of getInfoString. More... | |
| 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 int decimals=1) const |
| Format the magnitude info string for the object. More... | |
| QString | getSolarLunarInfoString (const StelCore *core, const InfoStringGroup &flags) const |
| Add a section to the InfoString with just horizontal data for the Sun and Moon, when observed from Earth. More... | |
| void | postProcessInfoString (QString &str, const InfoStringGroup &flags) const |
| Apply post processing on the info string. More... | |
TODO GZ says PLEASE Document this thoroughly! If possible recombine CustomObject and StelMarker & derivatives, or remove one of the two.
Or describe why we need both.
The CustomObject is currently used for custom Markers which can be set and removed interactively. It is drawn exactly at the coordinates given and is not subject to aberration. As discovered in #2769 it is also used to plot Simbad results, which need to be plotted with aberration.
|
inlineoverridevirtual |
Returns a unique identifier for this object.
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.
|
overridevirtual |
Get an HTML string to describe the object.
| core | A pointer to the core @flags a set of flags with information types to include. |
Implements StelObject.
1.9.1