Observability Class Reference

Main class of the Observability Analysis plug-in. More...

#include <Observability.hpp>

Public Slots
void	resetConfiguration ()
	Restore and reload the default plug-in settings. More...
void	saveConfiguration ()
	Save the plug-in's configuration to the main configuration file. More...
void	setFontColor (const Vec3f &color)
	Set the color of the font used to display the report. More...
void	setFontSize (int size)
	Set the size of the font used to display the report. More...
void	setTwilightAltitude (int altitude)
	Set the angular altitude below the horizon of the Sun at twilight. More...
void	setHorizonAltitude (int altitude)
	Set the angular altitude of the visual horizon. More...
void	showReport (bool b)
	Controls whether an observability report will be displayed. More...
Fields displayed in the observability report.
void	enableTodayField (bool enabled=true)
	Display today's events (rise, set and transit times). More...
void	enableAcroCosField (bool enabled=true)
	Display acronychal and cosmical rising/setting. More...
void	enableGoodNightsField (bool enabled=true)
	Display nights when the object is above the horizon after darkness. More...
void	enableOppositionField (bool enabled=true)
	Display when selected object is in opposition. More...
void	enableFullMoonField (bool enabled=true)
	Display date of the full moon. More...

Public Member Functions
virtual void	init ()
virtual void	update (double)
virtual void	draw (StelCore *core)
virtual double	getCallOrder (StelModuleActionName actionName) const
virtual bool	configureGui (bool show=true)
	Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin. More...
void	loadConfiguration ()
	Read (or re-read) settings from the main config file. More...
bool	getShowFlags (int)
	get Show Flags from current configuration: More...
Vec3f	getFontColor (void)
	get the current font color: More...
int	getFontSize (void)
	get current font size: More...
int	getTwilightAltitude ()
	Get the user-defined Sun altitude at twilight. More...
int	getHorizonAltitude ()
	Get the user-defined altitude of the visual horizon. More...
bool	isShownReport () const

Detailed Description

Main class of the Observability Analysis plug-in.

Definition at line 54 of file Observability.hpp.

Member Function Documentation

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

virtual

Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin.

void Observability::enableAcroCosField ( bool  enabled = true )

slot

Display acronychal and cosmical rising/setting.

void Observability::enableFullMoonField ( bool  enabled = true )

slot

Display date of the full moon.

Has any effect only if the Moon is selected.

void Observability::enableGoodNightsField ( bool  enabled = true )

slot

Display nights when the object is above the horizon after darkness.

void Observability::enableOppositionField ( bool  enabled = true )

slot

Display when selected object is in opposition.

void Observability::enableTodayField ( bool  enabled = true )

slot

Display today's events (rise, set and transit times).

Vec3f Observability::getFontColor

(

void

)

get the current font color:

int Observability::getFontSize

(

void

)

get current font size:

int Observability::getHorizonAltitude

(

)

Get the user-defined altitude of the visual horizon.

bool Observability::getShowFlags

(

int

)

get Show Flags from current configuration:

int Observability::getTwilightAltitude

(

)

Get the user-defined Sun altitude at twilight.

Returns

A value in degrees.

void Observability::loadConfiguration

(

)

Read (or re-read) settings from the main config file.

Default values are provided for all settings. Called in init() and resetConfiguration().

void Observability::resetConfiguration ( )

slot

Restore and reload the default plug-in settings.

void Observability::saveConfiguration ( )

slot

Save the plug-in's configuration to the main configuration file.

void Observability::setFontColor ( const Vec3f &  color )

slot

Set the color of the font used to display the report.

Applies only to what is drawn on the viewport.

Parameters

color

Color vector in Stellarium's RGB format.

void Observability::setFontSize ( int  size )

slot

Set the size of the font used to display the report.

Applies only to what is drawn on the viewport.

void Observability::setHorizonAltitude ( int  altitude )

slot

Set the angular altitude of the visual horizon.

Parameters

altitude

An angle in degrees.

void Observability::setTwilightAltitude ( int  altitude )

slot

Set the angular altitude below the horizon of the Sun at twilight.

This determines the boundaries of day/night for observation purposes.

Parameters

altitude

An angle in degrees; as this is altitude below the horizon, it should be negative.

Note

If you want the slider in the configuration dialog to be inverted, you can use the invertedAppearance property of QSlider.

void Observability::showReport ( bool  b )

slot

Controls whether an observability report will be displayed.

---

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

• Observability.hpp