Stellarium  0.18.3
Public Slots | Signals | Public Member Functions | Properties
ArchaeoLines Class Reference

Main class of the ArchaeoLines plug-in. More...

#include <ArchaeoLines.hpp>

Public Slots

void enableArchaeoLines (bool b)
 
bool isEnabled () const
 
bool isEquinoxDisplayed () const
 
bool isSolsticesDisplayed () const
 
bool isCrossquartersDisplayed () const
 
bool isMajorStandstillsDisplayed () const
 
bool isMinorStandstillsDisplayed () const
 
bool isZenithPassageDisplayed () const
 
bool isNadirPassageDisplayed () const
 
bool isSelectedObjectDisplayed () const
 
bool isSelectedObjectAzimuthDisplayed () const
 
bool isSelectedObjectHourAngleDisplayed () const
 
bool isCurrentSunDisplayed () const
 
bool isCurrentMoonDisplayed () const
 
ArchaeoLine::Line whichCurrentPlanetDisplayed () const
 
bool isGeographicLocation1Displayed () const
 
bool isGeographicLocation2Displayed () const
 
bool isCustomAzimuth1Displayed () const
 
bool isCustomAzimuth2Displayed () const
 
bool isCustomDeclination1Displayed () const
 
bool isCustomDeclination2Displayed () const
 
void showEquinox (bool b)
 
void showSolstices (bool b)
 
void showCrossquarters (bool b)
 
void showMajorStandstills (bool b)
 
void showMinorStandstills (bool b)
 
void showZenithPassage (bool b)
 
void showNadirPassage (bool b)
 
void showSelectedObject (bool b)
 
void showSelectedObjectAzimuth (bool b)
 
void showSelectedObjectHourAngle (bool b)
 
void showCurrentSun (bool b)
 
void showCurrentMoon (bool b)
 
void showCurrentPlanet (ArchaeoLine::Line l)
 
void showCurrentPlanetNamed (QString planet)
 
void showGeographicLocation1 (bool b)
 
void showGeographicLocation2 (bool b)
 
void setGeographicLocation1Longitude (double lng)
 
void setGeographicLocation1Latitude (double lat)
 
void setGeographicLocation2Longitude (double lng)
 
void setGeographicLocation2Latitude (double lat)
 
void setGeographicLocation1Label (QString label)
 
void setGeographicLocation2Label (QString label)
 
QString getGeographicLocation1Label () const
 
QString getGeographicLocation2Label () const
 
double getGeographicLocation1Longitude () const
 
double getGeographicLocation1Latitude () const
 
double getGeographicLocation2Longitude () const
 
double getGeographicLocation2Latitude () const
 
void showCustomAzimuth1 (bool b)
 
void showCustomAzimuth2 (bool b)
 
void setCustomAzimuth1 (double az)
 
double getCustomAzimuth1 () const
 
void setCustomAzimuth2 (double az)
 
double getCustomAzimuth2 () const
 
void setCustomAzimuth1Label (QString label)
 
void setCustomAzimuth2Label (QString label)
 
QString getCustomAzimuth1Label () const
 
QString getCustomAzimuth2Label () const
 
void showCustomDeclination1 (bool b)
 
void showCustomDeclination2 (bool b)
 
void setCustomDeclination1 (double dec)
 
double getCustomDeclination1 () const
 
void setCustomDeclination2 (double dec)
 
double getCustomDeclination2 () const
 
void setCustomDeclination1Label (QString label)
 
void setCustomDeclination2Label (QString label)
 
QString getCustomDeclination1Label () const
 
QString getCustomDeclination2Label () const
 
double getLineAngle (ArchaeoLine::Line whichLine) const
 query a line for its current defining angle. Returns declination or azimuth, respectively.
 
QString getLineLabel (ArchaeoLine::Line whichLine) const
 
Vec3f getEquinoxColor () const
 
Vec3f getSolsticesColor () const
 
Vec3f getCrossquartersColor () const
 
Vec3f getMajorStandstillColor () const
 
Vec3f getMinorStandstillColor () const
 
Vec3f getZenithPassageColor () const
 
Vec3f getNadirPassageColor () const
 
Vec3f getSelectedObjectColor () const
 
Vec3f getSelectedObjectAzimuthColor () const
 
Vec3f getSelectedObjectHourAngleColor () const
 
Vec3f getCurrentSunColor () const
 
Vec3f getCurrentMoonColor () const
 
Vec3f getCurrentPlanetColor () const
 
Vec3f getGeographicLocation1Color () const
 
Vec3f getGeographicLocation2Color () const
 
Vec3f getCustomAzimuth1Color () const
 
Vec3f getCustomAzimuth2Color () const
 
Vec3f getCustomDeclination1Color () const
 
Vec3f getCustomDeclination2Color () const
 
void setEquinoxColor (Vec3f color)
 
void setSolsticesColor (Vec3f color)
 
void setCrossquartersColor (Vec3f color)
 
void setMajorStandstillColor (Vec3f color)
 
void setMinorStandstillColor (Vec3f color)
 
void setZenithPassageColor (Vec3f color)
 
void setNadirPassageColor (Vec3f color)
 
void setSelectedObjectColor (Vec3f color)
 
void setSelectedObjectAzimuthColor (Vec3f color)
 
void setSelectedObjectHourAngleColor (Vec3f color)
 
void setCurrentSunColor (Vec3f color)
 
void setCurrentMoonColor (Vec3f color)
 
void setCurrentPlanetColor (Vec3f color)
 
void setGeographicLocation1Color (Vec3f color)
 
void setGeographicLocation2Color (Vec3f color)
 
void setCustomAzimuth1Color (Vec3f color)
 
void setCustomAzimuth2Color (Vec3f color)
 
void setCustomDeclination1Color (Vec3f color)
 
void setCustomDeclination2Color (Vec3f color)
 

Signals

void archaeoLinesEnabledChanged (bool on)
 
void showEquinoxChanged (bool on)
 
void showSolsticesChanged (bool on)
 
void showCrossquartersChanged (bool on)
 
void showMajorStandstillsChanged (bool on)
 
void showMinorStandstillsChanged (bool on)
 
void showZenithPassageChanged (bool on)
 
void showNadirPassageChanged (bool on)
 
void showSelectedObjectChanged (bool on)
 
void showSelectedObjectAzimuthChanged (bool on)
 
void showSelectedObjectHourAngleChanged (bool on)
 
void showCurrentSunChanged (bool on)
 
void showCurrentMoonChanged (bool on)
 
void showGeographicLocation1Changed (bool on)
 
void showGeographicLocation2Changed (bool on)
 
void geographicLocation1Changed ()
 
void geographicLocation2Changed ()
 
void showCustomAzimuth1Changed (bool on)
 
void showCustomAzimuth2Changed (bool on)
 
void customAzimuth1Changed (double az)
 
void customAzimuth2Changed (double az)
 
void showCustomDeclination1Changed (bool on)
 
void showCustomDeclination2Changed (bool on)
 
void customDeclination1Changed (double dec)
 
void customDeclination2Changed (double dec)
 
void currentPlanetChanged (ArchaeoLine::Line l)
 
void geographicLocation1LabelChanged (QString label)
 
void geographicLocation2LabelChanged (QString label)
 
void customAzimuth1LabelChanged (QString label)
 
void customAzimuth2LabelChanged (QString label)
 
void customDeclination1LabelChanged (QString label)
 
void customDeclination2LabelChanged (QString label)
 
void equinoxColorChanged (Vec3f color)
 
void solsticesColorChanged (Vec3f color)
 
void crossquartersColorChanged (Vec3f color)
 
void majorStandstillColorChanged (Vec3f color)
 
void minorStandstillColorChanged (Vec3f color)
 
void zenithPassageColorChanged (Vec3f color)
 
void nadirPassageColorChanged (Vec3f color)
 
void selectedObjectColorChanged (Vec3f color)
 
void selectedObjectAzimuthColorChanged (Vec3f color)
 
void selectedObjectHourAngleColorChanged (Vec3f color)
 
void currentSunColorChanged (Vec3f color)
 
void currentMoonColorChanged (Vec3f color)
 
void currentPlanetColorChanged (Vec3f color)
 
void geographicLocation1ColorChanged (Vec3f color)
 
void geographicLocation2ColorChanged (Vec3f color)
 
void customAzimuth1ColorChanged (Vec3f color)
 
void customAzimuth2ColorChanged (Vec3f color)
 
void customDeclination1ColorChanged (Vec3f color)
 
void customDeclination2ColorChanged (Vec3f color)
 

Public Member Functions

virtual void init ()
 Initialize itself. More...
 
virtual void update (double deltaTime)
 Update the module with respect to the time. More...
 
virtual void draw (StelCore *core)
 Execute all the drawing functions for this module. More...
 
virtual double getCallOrder (StelModuleActionName actionName) const
 Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations. More...
 
virtual void handleKeys (class QKeyEvent *event)
 Handle key events. More...
 
virtual bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 
void restoreDefaultSettings ()
 Restore the plug-in's settings to the default state. More...
 
void loadSettings ()
 Load the plug-in's settings from the configuration file. More...
 
- Public Member Functions inherited from StelModule
virtual void deinit ()
 Called before the module will be delete, and before the openGL context is suppressed. More...
 
virtual QString getModuleVersion () const
 Get the version of the module, default is stellarium main version.
 
virtual QString getAuthorName () const
 Get the name of the module author.
 
virtual QString getAuthorEmail () const
 Get the email adress of the module author.
 
virtual void handleMouseClicks (class QMouseEvent *)
 Handle mouse clicks. More...
 
virtual void handleMouseWheel (class QWheelEvent *)
 Handle mouse wheel. More...
 
virtual bool handleMouseMoves (int x, int y, Qt::MouseButtons b)
 Handle mouse moves. More...
 
virtual bool handlePinch (qreal scale, bool started)
 Handle pinch gesture events. More...
 

Properties

bool enabled
 
bool flagShowEquinox
 
bool flagShowSolstices
 
bool flagShowCrossquarters
 
bool flagShowMajorStandstills
 
bool flagShowMinorStandstills
 
bool flagShowZenithPassage
 
bool flagShowNadirPassage
 
bool flagShowSelectedObject
 
bool flagShowSelectedObjectAzimuth
 
bool flagShowSelectedObjectHourAngle
 
bool flagShowCurrentSun
 
bool flagShowCurrentMoon
 
ArchaeoLine::Line enumShowCurrentPlanet
 
bool flagShowGeographicLocation1
 
bool flagShowGeographicLocation2
 
double geographicLocation1Longitude
 
double geographicLocation1Latitude
 
double geographicLocation2Longitude
 
double geographicLocation2Latitude
 
bool flagShowCustomAzimuth1
 
bool flagShowCustomAzimuth2
 
double customAzimuth1
 
double customAzimuth2
 
bool flagShowCustomDeclination1
 
bool flagShowCustomDeclination2
 
double customDeclination1
 
double customDeclination2
 
QString geographicLocation1Label
 
QString geographicLocation2Label
 
QString customAzimuth1Label
 
QString customAzimuth2Label
 
QString customDeclination1Label
 
QString customDeclination2Label
 
Vec3f equinoxColor
 
Vec3f solsticesColor
 
Vec3f crossquartersColor
 
Vec3f majorStandstillColor
 
Vec3f minorStandstillColor
 
Vec3f zenithPassageColor
 
Vec3f nadirPassageColor
 
Vec3f selectedObjectColor
 
Vec3f selectedObjectAzimuthColor
 
Vec3f selectedObjectHourAngleColor
 
Vec3f currentSunColor
 
Vec3f currentMoonColor
 
Vec3f currentPlanetColor
 
Vec3f geographicLocation1Color
 
Vec3f geographicLocation2Color
 
Vec3f customAzimuth1Color
 
Vec3f customAzimuth2Color
 
Vec3f customDeclination1Color
 
Vec3f customDeclination2Color
 

Additional Inherited Members

- Public Types inherited from StelModule
enum  StelModuleSelectAction { AddToSelection, ReplaceSelection, RemoveFromSelection }
 Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...
 
enum  StelModuleActionName {
  ActionDraw, ActionUpdate, ActionHandleMouseClicks, ActionHandleMouseMoves,
  ActionHandleKeys
}
 Define the possible action for which an order is defined. More...
 
- Protected Member Functions inherited from StelModule
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, QObject *target, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to slot) to the StelActionMgr object. More...
 
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to own slot) to the StelActionMgr object. More...
 

Detailed Description

Provides an on-screen visualisation of several small circles relevant mainly to archaeoastronomy. In addition, a few azimuth lines can be shown. GZ 2014-12, updated 2016-06, 2018-10.

Member Function Documentation

◆ configureGui()

virtual bool ArchaeoLines::configureGui ( bool  show = true)
virtual

This is to be used with plugins to display a configuration dialog from the plugin list window.

Parameters
showif true, make the configuration GUI visible. If false, hide the config GUI if there is one.
Returns
true if the module has a configuration GUI, else false.

Reimplemented from StelModule.

◆ draw()

virtual void ArchaeoLines::draw ( StelCore core)
virtual
Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

◆ getCallOrder()

virtual double ArchaeoLines::getCallOrder ( StelModuleActionName  actionName) const
virtual
Parameters
actionNamethe name of the action for which we want the call order
Returns
the value defining the order. The closer to 0 the earlier the module's action will be called

Reimplemented from StelModule.

◆ handleKeys()

virtual void ArchaeoLines::handleKeys ( class QKeyEvent *  e)
inlinevirtual

Please note that most of the interactions will be done through the GUI module.

Parameters
ethe Key event
Returns
set the event as accepted if it was intercepted

Reimplemented from StelModule.

◆ init()

virtual void ArchaeoLines::init ( )
virtual

If the initialization takes significant time, the progress should be displayed on the loading bar.

Implements StelModule.

◆ loadSettings()

void ArchaeoLines::loadSettings ( )

Settings are kept in the "ArchaeoLines" section in Stellarium's configuration file. If no such section exists, it will load default values.

See also
restoreDefaultSettings()

◆ restoreDefaultSettings()

void ArchaeoLines::restoreDefaultSettings ( )

Replace the plug-in's settings in Stellarium's configuration file with the default values and re-load them. Uses internally loadSettings().

◆ update()

virtual void ArchaeoLines::update ( double  deltaTime)
virtual
Parameters
deltaTimethe time increment in second since last call.

Implements StelModule.