Public Slots
void	setEnabled (bool value)

void	setFlagShowLabels (bool value)

void	setFlagShowButton (bool value)

void	setLabelMode (int mode)

void	setProviderId (const QString &providerId)

void	setFetchIntervalSec (int seconds)

void	setRadiusNm (int nm)

void	refreshNow ()

Signals
void	enabledChanged (bool value)

void	showLabelsChanged (bool value)

void	showButtonChanged (bool value)

void	labelModeChanged (int mode)

void	providerChanged (const QString &providerId)

void	fetchIntervalChanged (int seconds)

void	radiusChanged (int nm)

void	statusChanged (const QString &status)

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

void	deinit () override
	Called before the module will be deleted, and before the OpenGL context is suppressed. 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...

bool	configureGui (bool show=true) override
	Detect or show the configuration GUI elements for the module. More...

QList< StelObjectP >	searchAround (const Vec3d &v, double limitFov, const StelCore *core) const override
	Search for StelObject in an area around a specified point. More...

StelObjectP	searchByNameI18n (const QString &nameI18n) const override
	Find a StelObject by name. More...

StelObjectP	searchByName (const QString &name) const override
	Return the matching StelObject if exists or the empty StelObject if not found. More...

StelObjectP	searchByID (const QString &id) const override
	Return the StelObject with the given ID if exists or the empty StelObject if not found. More...

QVector< QPair< QString, StelObjectP > >	listMatchingObjects (const QString &objPrefix, int maxNbItem, bool useStartOfWords) const override
	Find and return the list of at most maxNbItem objects auto-completing passed object name. More...

QVector< QPair< QString, StelObjectP > >	listAllObjects (bool inEnglish) const override
	List all StelObjects. More...

QString	getName () const override
	Gets a user-displayable name of the object category.

QString	getStelObjectType () const override
	Returns the name that will be returned by StelObject::getType() for the objects this module manages.

bool	isEnabled () const

bool	getFlagShowLabels () const

bool	getFlagShowButton () const

int	getLabelMode () const

int	getFetchIntervalSec () const

int	getRadiusNm () const

QString	getLastStatus () const

QString	getLastSuccessfulUpdate () const

QString	getProviderId () const

QString	getProviderDisplayName () const

QString	getProviderWebsiteUrl () const

int	getProviderMaxRadiusNm () const

QString	getSourceUrlTemplate () const

Public Member Functions inherited from StelObjectModule
virtual QVector< QPair< QString, StelObjectP > >	listAllObjectsByType (const QString &objType, bool inEnglish) const
	List all StelObjects by type. More...

bool	matchObjectName (const QString &objName, const QString &objPrefix, bool useStartOfWords) const
	Auxiliary method of listMatchingObjects() More...

Public Member Functions inherited from StelModule
	StelModule ()
	Constructor. Every derived class MUST call setObjectName(className) in its constructor.

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 void	handleKeys (class QKeyEvent *e)
	Handle key events. More...

virtual bool	handlePinch (qreal scale, bool started)
	Handle pinch gesture events. More...

Properties
bool	enabled

bool	showLabels

bool	showButton

int	labelMode

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...

Member Function Documentation

◆ configureGui()

bool Planes::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.

◆ deinit()

void Planes::deinit ( )

overridevirtual

Called before the module will be deleted, and before the OpenGL context is suppressed.

Deinitialize all OpenGL texture in this method.

Reimplemented from StelModule.

◆ draw()

void Planes::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 Planes::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.

◆ init()

void Planes::init ( )

overridevirtual

Initialize itself.

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

Implements StelModule.

◆ listAllObjects()

QVector<QPair<QString, StelObjectP> > Planes::listAllObjects ( bool inEnglish ) const

overridevirtual

List all StelObjects.

Parameters

inEnglish list names in English (true) or translated (false)

Returns: a list of matching object name by order of relevance, or an empty list if nothing matches

Implements StelObjectModule.

◆ listMatchingObjects()

QVector<QPair<QString, StelObjectP> > Planes::listMatchingObjects	(	const QString &	objPrefix,
		int	maxNbItem,
		bool	useStartOfWords
	)		const

overridevirtual

Find and return the list of at most maxNbItem objects auto-completing passed object name.

Parameters

objPrefix	the first letters of the searched object
maxNbItem	the maximum number of returned object names
useStartOfWords	decide if start of word is searched

Returns: a list of matching object name by order of relevance, or an empty list if nothing matches

Reimplemented from StelObjectModule.

◆ searchAround()

QList<StelObjectP> Planes::searchAround	(	const Vec3d &	v,
		double	limitFov,
		const StelCore *	core
	)		const

overridevirtual

Search for StelObject in an area around a specified point.

The function searches in a disk of diameter limitFov centered on v. Only visible objects (i.e. currently displayed on screen) should be returned.

Parameters

v	equatorial position at epoch J2000 (without aberration).
limitFov	angular diameter of the searching zone in degree.
core	the StelCore instance to use.

Returns: the list of all the displayed objects contained in the defined zone.

Note: the default just returns an empty list.

Reimplemented from StelObjectModule.

◆ searchByID()

StelObjectP Planes::searchByID ( const QString & id ) const

overridevirtual

Return the StelObject with the given ID if exists or the empty StelObject if not found.

Parameters

name	the english object name

Implements StelObjectModule.

◆ searchByName()

StelObjectP Planes::searchByName ( const QString & name ) const

overridevirtual

Return the matching StelObject if exists or the empty StelObject if not found.

Parameters

name	the english object name

Implements StelObjectModule.

◆ searchByNameI18n()

StelObjectP Planes::searchByNameI18n ( const QString & nameI18n ) const

overridevirtual

Find a StelObject by name.

Parameters

nameI18n The translated name for the current sky locale.

Returns: The matching StelObject if exists or the empty StelObject if not found.

Implements StelObjectModule.

◆ update()

void Planes::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

Member Function Documentation

◆ configureGui()

◆ deinit()

◆ draw()

◆ getCallOrder()

◆ init()

◆ listAllObjects()

◆ listMatchingObjects()

◆ searchAround()

◆ searchByID()

◆ searchByName()

◆ searchByNameI18n()

◆ update()