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	isPolarCirclesDisplayed () 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	isCustomAltitude1Displayed () const

bool	isCustomAltitude2Displayed () 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	showPolarCircles (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 (const 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 (const QString &label)

void	setGeographicLocation2Label (const 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 (const QString &label)

void	setCustomAzimuth2Label (const QString &label)

QString	getCustomAzimuth1Label () const

QString	getCustomAzimuth2Label () const

void	showCustomAltitude1 (bool b)

void	showCustomAltitude2 (bool b)

void	setCustomAltitude1 (double alt)

double	getCustomAltitude1 () const

void	setCustomAltitude2 (double alt)

double	getCustomAltitude2 () const

void	setCustomAltitude1Label (const QString &label)

void	setCustomAltitude2Label (const QString &label)

QString	getCustomAltitude1Label () const

QString	getCustomAltitude2Label () 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 (const QString &label)

void	setCustomDeclination2Label (const 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	getPolarCirclesColor () 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	getCustomAltitude1Color () const

Vec3f	getCustomAltitude2Color () const

Vec3f	getCustomDeclination1Color () const

Vec3f	getCustomDeclination2Color () const

void	setEquinoxColor (const Vec3f &color)

void	setSolsticesColor (const Vec3f &color)

void	setCrossquartersColor (const Vec3f &color)

void	setMajorStandstillColor (const Vec3f &color)

void	setMinorStandstillColor (const Vec3f &color)

void	setPolarCirclesColor (const Vec3f &color)

void	setZenithPassageColor (const Vec3f &color)

void	setNadirPassageColor (const Vec3f &color)

void	setSelectedObjectColor (const Vec3f &color)

void	setSelectedObjectAzimuthColor (const Vec3f &color)

void	setSelectedObjectHourAngleColor (const Vec3f &color)

void	setCurrentSunColor (const Vec3f &color)

void	setCurrentMoonColor (const Vec3f &color)

void	setCurrentPlanetColor (const Vec3f &color)

void	setGeographicLocation1Color (const Vec3f &color)

void	setGeographicLocation2Color (const Vec3f &color)

void	setCustomAzimuth1Color (const Vec3f &color)

void	setCustomAzimuth2Color (const Vec3f &color)

void	setCustomAltitude1Color (const Vec3f &color)

void	setCustomAltitude2Color (const Vec3f &color)

void	setCustomDeclination1Color (const Vec3f &color)

void	setCustomDeclination2Color (const Vec3f &color)

int	getLineWidth () const

void	setLineWidth (int width)

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	showPolarCirclesChanged (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	showCustomAltitude1Changed (double az)

void	showCustomAltitude2Changed (double az)

void	customAltitude1Changed (double az)

void	customAltitude2Changed (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 (const QString &label)

void	geographicLocation2LabelChanged (const QString &label)

void	customAzimuth1LabelChanged (const QString &label)

void	customAzimuth2LabelChanged (const QString &label)

void	customAltitude1LabelChanged (const QString &label)

void	customAltitude2LabelChanged (const QString &label)

void	customDeclination1LabelChanged (const QString &label)

void	customDeclination2LabelChanged (const QString &label)

void	equinoxColorChanged (const Vec3f &color)

void	solsticesColorChanged (const Vec3f &color)

void	crossquartersColorChanged (const Vec3f &color)

void	majorStandstillColorChanged (const Vec3f &color)

void	minorStandstillColorChanged (const Vec3f &color)

void	polarCirclesColorChanged (const Vec3f &color)

void	zenithPassageColorChanged (const Vec3f &color)

void	nadirPassageColorChanged (const Vec3f &color)

void	selectedObjectColorChanged (const Vec3f &color)

void	selectedObjectAzimuthColorChanged (const Vec3f &color)

void	selectedObjectHourAngleColorChanged (const Vec3f &color)

void	currentSunColorChanged (const Vec3f &color)

void	currentMoonColorChanged (const Vec3f &color)

void	currentPlanetColorChanged (const Vec3f &color)

void	geographicLocation1ColorChanged (const Vec3f &color)

void	geographicLocation2ColorChanged (const Vec3f &color)

void	customAzimuth1ColorChanged (const Vec3f &color)

void	customAzimuth2ColorChanged (const Vec3f &color)

void	customAltitude1ColorChanged (const Vec3f &color)

void	customAltitude2ColorChanged (const Vec3f &color)

void	customDeclination1ColorChanged (const Vec3f &color)

void	customDeclination2ColorChanged (const Vec3f &color)

void	lineWidthChanged (int width)

Public Member Functions
void	init () override
	Initialize itself. More...

void	update (double deltaTime) override
	Update the module with respect to the time. More...

void	draw (StelCore *core) override
	Execute all the drawing functions for this module. More...

double	getCallOrder (StelModuleActionName actionName) const override
	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...

void	handleKeys (class QKeyEvent *event) override
	Handle key events. More...

bool	configureGui (bool show=true) override
	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
	StelModule ()
	Constructor. Every derived class MUST call setObjectName(className) in its constructor.

virtual void	deinit ()
	Called before the module will be deleted, and before the OpenGL context is suppressed. More...

virtual QSettings *	getSettings ()
	Return module-specific settings. 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 address 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	flagShowPolarCircles

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	flagShowCustomAltitude1

bool	flagShowCustomAltitude2

double	customAltitude1

double	customAltitude2

bool	flagShowCustomDeclination1

bool	flagShowCustomDeclination2

double	customDeclination1

double	customDeclination2

QString	geographicLocation1Label

QString	geographicLocation2Label

QString	customAzimuth1Label

QString	customAzimuth2Label

QString	customAltitude1Label

QString	customAltitude2Label

QString	customDeclination1Label

QString	customDeclination2Label

Vec3f	equinoxColor

Vec3f	solsticesColor

Vec3f	crossquartersColor

Vec3f	majorStandstillColor

Vec3f	minorStandstillColor

Vec3f	polarCirclesColor

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	customAltitude1Color

Vec3f	customAltitude2Color

Vec3f	customDeclination1Color

Vec3f	customDeclination2Color

int	lineWidth

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 StelAction *	addAction (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 StelAction *	addAction (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...

StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, QObject *contextObject, std::function< void()> lambda, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to Lambda functor) to the StelActionMgr object. More...

Detailed Description

Main class of the ArchaeoLines plug-in.

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

Member Function Documentation

◆ configureGui()

bool ArchaeoLines::configureGui ( bool show = true )

overridevirtual

Detect or show the configuration GUI elements for the module.

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

Parameters

show	if 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()

void ArchaeoLines::draw ( StelCore * core )

overridevirtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

◆ getCallOrder()

double ArchaeoLines::getCallOrder ( StelModuleActionName actionName ) const

overridevirtual

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.

Parameters

actionName the 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()

void ArchaeoLines::handleKeys ( class QKeyEvent * e )

inlineoverridevirtual

Handle key events.

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

Parameters

e	the Key event

Returns: set the event as accepted if it was intercepted

Reimplemented from StelModule.

◆ init()

void ArchaeoLines::init ( )

overridevirtual

Initialize itself.

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

Implements StelModule.

◆ loadSettings()

void ArchaeoLines::loadSettings ( )

Load the plug-in's settings from the configuration file.

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 ( )

Restore the plug-in's settings to the default state.

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

◆ update()

void ArchaeoLines::update ( double deltaTime )

overridevirtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Reimplemented from StelModule.

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ configureGui()

◆ draw()

◆ getCallOrder()

◆ handleKeys()

◆ init()

◆ loadSettings()

◆ restoreDefaultSettings()

◆ update()