Stellarium  0.16.1
List of all members | Protected Member Functions
StarWrapperBase Class Referenceabstract

A Star (Star1,Star2,Star3,...) cannot be a StelObject. More...

#include <StarWrapper.hpp>

+ Inheritance diagram for StarWrapperBase:
+ Collaboration diagram for StarWrapperBase:

Protected Member Functions

QString getType (void) const
 Return object's type. It should be the name of the class. More...
 
QString getID (void) const
 Returns a unique identifier for this object. More...
 
QString getEnglishName (void) const
 Return object's name in english. More...
 
QString getNameI18n (void) const =0
 Return translated object's name. More...
 
QString getInfoString (const StelCore *core, const InfoStringGroup &flags) const
 StarWrapperBase supports the following InfoStringGroup flags. More...
 
virtual float getBV (void) const =0
 
- Protected Member Functions inherited from StelObject
QString getCommonInfoString (const StelCore *core, const InfoStringGroup &flags) const
 Format the positional info string contain J2000/of date/altaz/hour angle positions and constellation, sidereal time, etc. for the object. More...
 
void postProcessInfoString (QString &str, const InfoStringGroup &flags) const
 Apply post processing on the info string. More...
 

Additional Inherited Members

- Public Types inherited from StelObject
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 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...
 
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...
 
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 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 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 = (InfoStringGroupFlags)(Name|CatalogNumber|Magnitude|RaDecJ2000)
 A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More...
 

Detailed Description

A Star (Star1,Star2,Star3,...) cannot be a StelObject.

The additional overhead of having a dynamic type would simply be too much. Therefore the StarWrapper is needed when returning Stars as StelObjects, e.g. for searching, and for constellations. The StarWrapper is destroyed when it is not needed anymore, by utilizing reference counting. So there is no chance that more than a few hundreds of StarWrappers are alive simultanousely. Another reason for having the StarWrapper is to encapsulate the differences between the different kinds of Stars (Star1,Star2,Star3).

Definition at line 43 of file StarWrapper.hpp.

Member Function Documentation

QString StarWrapperBase::getEnglishName ( void  ) const
inlineprotectedvirtual

Return object's name in english.

Implements StelObject.

Reimplemented in StarWrapper1, StarWrapper< Star >, StarWrapper< Star2 >, StarWrapper< Star3 >, and StarWrapper< Star1 >.

Definition at line 51 of file StarWrapper.hpp.

QString StarWrapperBase::getID ( void  ) const
inlineprotectedvirtual

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.

Definition at line 49 of file StarWrapper.hpp.

QString StarWrapperBase::getInfoString ( const StelCore core,
const InfoStringGroup &  flags 
) const
protectedvirtual

StarWrapperBase supports the following InfoStringGroup flags.

  • Name
  • Magnitude
  • RaDecJ2000
  • RaDec
  • AltAzi
  • PlainText
Parameters
corethe StelCore object
flagsa set of InfoStringGroup items to include in the return value.
Returns
a QString containing an HTML encoded description of the StarWrapperBase.

Implements StelObject.

Reimplemented in StarWrapper1.

QString StarWrapperBase::getNameI18n ( void  ) const
protectedpure virtual

Return translated object's name.

Implements StelObject.

Implemented in StarWrapper< Star >, StarWrapper< Star2 >, StarWrapper< Star3 >, and StarWrapper< Star1 >.

QString StarWrapperBase::getType ( void  ) const
inlineprotectedvirtual

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

Implements StelObject.

Definition at line 48 of file StarWrapper.hpp.


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