Stellarium  23.4
Public Slots | Signals | Public Member Functions | Properties
AsterismMgr Class Reference

Display and manage the asterisms. More...

#include <AsterismMgr.hpp>

Public Slots

void setLinesColor (const Vec3f &color)
 Define line color. More...
 
Vec3f getLinesColor () const
 Get line color.
 
void setFlagLines (const bool displayed)
 Set whether asterism lines will be displayed.
 
bool getFlagLines (void) const
 Get whether asterism lines are displayed.
 
void setRayHelpersColor (const Vec3f &color)
 Define ray helper color. More...
 
Vec3f getRayHelpersColor () const
 Get ray helper color.
 
void setFlagRayHelpers (const bool displayed)
 Set whether ray helpers will be displayed.
 
bool getFlagRayHelpers (void) const
 Get whether ray helpers are displayed.
 
void setLabelsColor (const Vec3f &color)
 Set label color for names. More...
 
Vec3f getLabelsColor () const
 Get label color for names.
 
void setFlagLabels (const bool displayed)
 Set whether asterism names will be displayed.
 
bool getFlagLabels (void) const
 Set whether asterism names are displayed.
 
void setFontSize (const float newFontSize)
 Set the font size used for asterism names display.
 
float getFontSize () const
 Get the font size used for asterism names display.
 
void setAsterismLineThickness (const int thickness)
 Set the thickness of lines of the asterisms. More...
 
int getAsterismLineThickness () const
 Get the thickness of lines of the asterisms.
 
void setRayHelperThickness (const int thickness)
 Set the thickness of ray helpers of the asterisms. More...
 
int getRayHelperThickness () const
 Get the thickness of ray helper of the asterisms.
 
bool isLinesDefined ()
 
void setFlagIsolateAsterismSelected (const bool isolate)
 Set whether selected asterism must be displayed alone.
 
bool getFlagIsolateAsterismSelected (void) const
 Get whether selected asterism is displayed alone.
 
void selectAsterism (const QString &englishName)
 Select the asterism by his English name. More...
 
void deselectAsterism (const QString &englishName)
 Remove the asterism from list of selected asterisms by his English name. More...
 
void deselectAsterisms (void)
 Remove asterisms from selected objects.
 
void selectAllAsterisms (void)
 Select all asterisms.
 

Signals

void fontSizeChanged (const float newSize)
 
void linesColorChanged (const Vec3f &color)
 
void linesDisplayedChanged (const bool displayed)
 
void namesColorChanged (const Vec3f &color)
 
void namesDisplayedChanged (const bool displayed)
 
void asterismLineThicknessChanged (int thickness)
 
void rayHelpersColorChanged (const Vec3f &color)
 
void rayHelpersDisplayedChanged (const bool displayed)
 
void rayHelperThicknessChanged (int thickness)
 
void isolateAsterismSelectedChanged (const bool isolate)
 

Public Member Functions

 AsterismMgr (StarMgr *stars)
 Constructor.
 
virtual ~AsterismMgr () Q_DECL_OVERRIDE
 Destructor.
 
virtual void init () Q_DECL_OVERRIDE
 Initialize the AsterismMgr. More...
 
virtual void draw (StelCore *core) Q_DECL_OVERRIDE
 Draw asterism lines, art, names and boundaries.
 
virtual void update (double deltaTime) Q_DECL_OVERRIDE
 Updates time-varying state for each asterism.
 
virtual double getCallOrder (StelModuleActionName actionName) const Q_DECL_OVERRIDE
 Return the value defining the order of call for the given action. More...
 
virtual QList< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const Q_DECL_OVERRIDE
 Search for StelObject in an area around a specified point. More...
 
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const Q_DECL_OVERRIDE
 Return the matching asterism object's pointer if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByName (const QString &name) const Q_DECL_OVERRIDE
 Return the matching asterism if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByID (const QString &id) const Q_DECL_OVERRIDE
 Return the StelObject with the given ID if exists or the empty StelObject if not found. More...
 
virtual QStringList listAllObjects (bool inEnglish) const Q_DECL_OVERRIDE
 List all StelObjects. More...
 
virtual QString getName () const Q_DECL_OVERRIDE
 Gets a user-displayable name of the object category.
 
virtual QString getStelObjectType () const Q_DECL_OVERRIDE
 Returns the name that will be returned by StelObject::getType() for the objects this module manages.
 
- Public Member Functions inherited from StelObjectModule
virtual QStringList listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const
 Find and return the list of at most maxNbItem objects auto-completing passed object name. More...
 
virtual QStringList 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 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 void handleKeys (class QKeyEvent *e)
 Handle key events. More...
 
virtual bool handlePinch (qreal scale, bool started)
 Handle pinch gesture events. More...
 
virtual bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 

Properties

float fontSize
 
Vec3f linesColor
 
Vec3f rayHelpersColor
 
Vec3f namesColor
 

loadNames():

Load asterism line shapes from data files.

Parameters
fileNameThe name of the asterism data file
Note
The abbreviation used in
Parameters
filenameis required for cross-identifying translatable names in
bool linesDisplayed
 
bool rayHelpersDisplayed
 
bool namesDisplayed
 
int asterismLineThickness
 
int rayHelperThickness
 
bool isolateAsterismSelected
 

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

Display and manage the asterisms.

It can display asterisms lines and names. It also supports several different sky cultures.

Member Function Documentation

◆ deselectAsterism

void AsterismMgr::deselectAsterism ( const QString &  englishName)
slot

Remove the asterism from list of selected asterisms by his English name.

Calling this method will enable isolated selection for the asterisms if it is not enabled yet.

Parameters
englishNamethe English name of the asterism
// example of usage in scripts: remove selection from the "Summer Triangle" asterism
AsterismMgr.deselectAsterism("Summer Triangle");
Note
all asterisms will be hidden when list of selected asterisms will be empty

◆ getCallOrder()

virtual double AsterismMgr::getCallOrder ( StelModuleActionName  actionName) const
virtual

Return the value defining the order of call for the given action.

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

virtual void AsterismMgr::init ( )
virtual

Initialize the AsterismMgr.

Reads from the asterism parser object and updates the loading bar as asterism objects are loaded for the required sky culture.

Implements StelModule.

◆ isLinesDefined

bool AsterismMgr::isLinesDefined ( )
inlineslot
Returns
true if asterism lines is defined

◆ listAllObjects()

virtual QStringList AsterismMgr::listAllObjects ( bool  inEnglish) const
virtual

List all StelObjects.

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

◆ searchAround()

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

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

Implements StelObjectModule.

◆ searchByID()

virtual StelObjectP AsterismMgr::searchByID ( const QString &  id) const
virtual

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

Parameters
namethe english object name

Implements StelObjectModule.

◆ searchByName()

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

Return the matching asterism if exists or Q_NULLPTR.

Parameters
nameThe case in-sensitive standard program name (three letter abbreviation)

Implements StelObjectModule.

◆ searchByNameI18n()

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

Return the matching asterism object's pointer if exists or Q_NULLPTR.

Parameters
nameI18nThe case in-sensitive asterism name

Implements StelObjectModule.

◆ selectAsterism

void AsterismMgr::selectAsterism ( const QString &  englishName)
slot

Select the asterism by his English name.

Calling this method will enable isolated selection for the asterisms if it is not enabled yet.

Parameters
englishNamethe English name of the asterism
// example of usage in scripts: select the "Summer Triangle" asterism
AsterismMgr.selectAsterism("Summer Triangle");

◆ setAsterismLineThickness

void AsterismMgr::setAsterismLineThickness ( const int  thickness)
slot

Set the thickness of lines of the asterisms.

Parameters
thicknessof line in pixels

◆ setLabelsColor

void AsterismMgr::setLabelsColor ( const Vec3f color)
slot

Set label color for names.

Parameters
colorThe color of labels
// example of usage in scripts

◆ setLinesColor

void AsterismMgr::setLinesColor ( const Vec3f color)
slot

Define line color.

Parameters
colorThe color of lines
// example of usage in scripts

◆ setRayHelpersColor

void AsterismMgr::setRayHelpersColor ( const Vec3f color)
slot

Define ray helper color.

Parameters
colorThe color of ray helpers
// example of usage in scripts

◆ setRayHelperThickness

void AsterismMgr::setRayHelperThickness ( const int  thickness)
slot

Set the thickness of ray helpers of the asterisms.

Parameters
thicknessof ray helper in pixels