Stellarium 0.11.0
Home · All Namespaces · All Classes · Functions · Coding Style · Scripting · Plugins · File Structure
Public Member Functions

StelObjectModule Class Reference

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

#include <StelObjectModule.hpp>

List of all members.

Public Member Functions

virtual QList< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const =0
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const =0
virtual StelObjectP searchByName (const QString &name) const =0
virtual QStringList listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5) const =0

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.


Member Function Documentation

virtual QStringList StelObjectModule::listMatchingObjectsI18n ( const QString &  objPrefix,
int  maxNbItem = 5 
) const [pure virtual]

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

Parameters:
objPrefixthe first letters of the searched object
maxNbItemthe maximum number of returned object names
Returns:
a list of matching object name by order of relevance, or an empty list if nothing matches

Implemented in ConstellationMgr, NebulaMgr, SolarSystem, and StarMgr.

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:
vequatorial position at epoch J2000.
limitFovangular diameter of the searching zone in degree.
corethe core instance to use.
Returns:
the list of all the displayed objects contained in the defined zone.

Implemented in ConstellationMgr, NebulaMgr, SolarSystem, and StarMgr.

virtual StelObjectP StelObjectModule::searchByName ( const QString &  name) const [pure virtual]

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

Parameters:
namethe english object name

Implemented in ConstellationMgr, NebulaMgr, SolarSystem, and StarMgr.

virtual StelObjectP StelObjectModule::searchByNameI18n ( const QString &  nameI18n) const [pure virtual]

Find a StelObject by name.

Parameters:
nameI18nThe translated name for the current sky locale.
Returns:
The matching StelObject if exists or the empty StelObject if not found.

Implemented in ConstellationMgr, NebulaMgr, SolarSystem, and StarMgr.