Specialization of StelModule which manages a collection of StelObject. More...

#include <StelObjectModule.hpp>

Public Member Functions
virtual QList< StelObjectP >	searchAround (const Vec3d &v, double limitFov, const StelCore *core) const =0
	Search for StelObject in an area around a specifid point. More...

virtual StelObjectP	searchByNameI18n (const QString &nameI18n) const =0
	Find a StelObject by name. More...

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

virtual QStringList	listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const =0
	Find and return the list of at most maxNbItem objects auto-completing passed object I18 name. More...

virtual QStringList	listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const =0
	Find and return the list of at most maxNbItem objects auto-completing passed object English name. More...

virtual QStringList	listAllObjects (bool inEnglish) const =0

virtual QString	getName () const =0

Public Member Functions inherited from StelModule
virtual void	init ()=0
	Initialize itself. More...

virtual void	deinit ()
	Called before the module will be deleted, and before the renderer is destroyed. More...

virtual void	draw (StelCore core, class StelRenderer renderer)
	Execute all the drawing functions for this module. More...

virtual bool	drawPartial (StelCore core, class StelRenderer renderer)
	Iterate through the drawing sequence. More...

virtual void	update (double deltaTime)=0
	Update the module with respect to the time. More...

virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version. More...

virtual QString	getAuthorName () const
	Get the name of the module author. More...

virtual QString	getAuthorEmail () const
	Get the email adress of the module author. More...

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 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 bool	configureGui (bool show=true)
	Detect or show the configuration GUI elements for the module. More...

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

Detailed Description

Specialization of StelModule which manages a collection of StelObject.

Instances deriving from the StelObjectModule class can be managed by the StelObjectMgr. The class defines extra abstract functions for searching and listing StelObjects.

Definition at line 34 of file StelObjectModule.hpp.

Member Function Documentation

virtual QStringList StelObjectModule::listMatchingObjects	(	const QString &	objPrefix,
		int	maxNbItem = `5`,
		bool	useStartOfWords = `false`
	)		const

pure virtual

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

Parameters

objPrefix	the first letters of the searched object
maxNbItem	the maximum number of returned object names
useStartOfWords	the autofill mode for returned objects names

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

Implemented in ConstellationMgr, StarMgr, SolarSystem, and NebulaMgr.

virtual QStringList StelObjectModule::listMatchingObjectsI18n	(	const QString &	objPrefix,
		int	maxNbItem = `5`,
		bool	useStartOfWords = `false`
	)		const

pure virtual

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

Parameters

objPrefix	the first letters of the searched object
maxNbItem	the maximum number of returned object names
useStartOfWords	the autofill mode for returned objects names

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

Implemented in ConstellationMgr, StarMgr, SolarSystem, and NebulaMgr.

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

pure virtual

Search for StelObject in an area around a specifid point.

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

Parameters

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

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

Implemented in ConstellationMgr, StarMgr, SolarSystem, and NebulaMgr.

virtual StelObjectP StelObjectModule::searchByName ( const QString & name ) const

pure virtual

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

Parameters

name	the english object name

Implemented in ConstellationMgr, StarMgr, SolarSystem, and NebulaMgr.

virtual StelObjectP StelObjectModule::searchByNameI18n ( const QString & nameI18n ) const

pure virtual

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.

Implemented in ConstellationMgr, StarMgr, SolarSystem, and NebulaMgr.

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

core/StelObjectModule.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation