Stellarium  HEAD
Public Slots | Public Member Functions
HighlightMgr Class Reference

A simple StelObjectModule to draw markers. More...

#include <HighlightMgr.hpp>

Public Slots

void setColor (const Vec3f &c)
 Set the color used to draw of the highlight markers. More...
 
Vec3f getColor (void) const
 Get the current color used to draw of the highlight markers. More...
 
void setMarkersSize (const float size)
 Set the size of highlight markers. More...
 
float getMarkersSize (void) const
 Get the current size used to highlight markers. More...
 
void cleanHighlightList ()
 Clean the list of highlight markers.
 
void addPoint (const QString &ra, const QString &dec)
 Add the point into list of the highlight markers. More...
 
void addPointRaDec (const QString &ra, const QString &dec)
 Add the point into list of the highlight markers. More...
 
void addPointAltAzi (const QString &alt, const QString &azi)
 Add the point into list of the highlight markers. More...
 

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 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...
 
void drawHighlights (StelCore *core, StelPainter &painter)
 
QList< StelObjectPsearchAround (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 Highlight by name. More...
 
StelObjectP searchByName (const QString &name) const override
 Find a Highlight by name. More...
 
StelObjectP searchByID (const QString &id) const override
 
QStringList listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const override
 Find and return the list of at most maxNbItem objects auto-completing the passed object name. More...
 
QStringList 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.
 
void fillHighlightList (QList< Vec3d > list)
 Fill the list highlight markers. More...
 
- Public Member Functions inherited from StelObjectModule
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 QSettings * getSettings ()
 Return module-specific settings. More...
 
virtual void update (double deltaTime)
 Update the module with respect to the time. 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...
 

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

A simple StelObjectModule to draw markers.

Currently all search... functions just return empty lists or Q_NULLPTR.

Member Function Documentation

◆ addPoint

void HighlightMgr::addPoint ( const QString &  ra,
const QString &  dec 
)
slot

Add the point into list of the highlight markers.

Parameters
ra- right ascension angle (J2000.0 frame) of highlight marker
dec- declination angle (J2000.0 frame) of highlight marker
// example of usage in scripts
HighlightMgr.addPoint("2h10m15s", "60d01m15s");

◆ addPointAltAzi

void HighlightMgr::addPointAltAzi ( const QString &  alt,
const QString &  azi 
)
slot

Add the point into list of the highlight markers.

Parameters
alt- altitude of highlight marker
azi- azimuth of highlight marker
// example of usage in scripts
HighlightMgr.addPointAltAzi("2d10m15s", "60d01m15s");

◆ addPointRaDec

void HighlightMgr::addPointRaDec ( const QString &  ra,
const QString &  dec 
)
slot

Add the point into list of the highlight markers.

Parameters
ra- right ascension angle (on date) of highlight marker
dec- declination angle (on date) of highlight marker
// example of usage in scripts
HighlightMgr.addPointRaDec("2h10m15s", "60d01m15s");

◆ deinit()

void HighlightMgr::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 HighlightMgr::draw ( StelCore core)
overridevirtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

◆ fillHighlightList()

void HighlightMgr::fillHighlightList ( QList< Vec3d list)

Fill the list highlight markers.

Parameters
list- list of coordinates of the highlights (J2000.0 frame)

◆ getCallOrder()

double HighlightMgr::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
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.

◆ getColor

Vec3f HighlightMgr::getColor ( void  ) const
slot

Get the current color used to draw of the highlight markers.

Returns
current color

◆ getMarkersSize

float HighlightMgr::getMarkersSize ( void  ) const
slot

Get the current size used to highlight markers.

Returns
current size

◆ init()

void HighlightMgr::init ( )
overridevirtual

Initialize itself.

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

Implements StelModule.

◆ listAllObjects()

QStringList HighlightMgr::listAllObjects ( bool  inEnglish) const
overridevirtual

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.

◆ listMatchingObjects()

QStringList HighlightMgr::listMatchingObjects ( const QString &  objPrefix,
int  maxNbItem = 5,
bool  useStartOfWords = false 
) const
overridevirtual

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

Parameters
objPrefixthe case insensitive first letters of the searched object
maxNbItemthe maximum number of returned object names
useStartOfWordsthe autofill mode for returned objects names
Returns
a list of matching object name by order of relevance, or an empty list if nothing match

Reimplemented from StelObjectModule.

◆ searchAround()

QList<StelObjectP> HighlightMgr::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
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.

Implements StelObjectModule.

◆ searchByID()

StelObjectP HighlightMgr::searchByID ( const QString &  id) const
overridevirtual
Parameters
idthe english ID
Returns
Q_NULLPTR

Implements StelObjectModule.

◆ searchByName()

StelObjectP HighlightMgr::searchByName ( const QString &  name) const
overridevirtual

Find a Highlight by name.

Parameters
nameThe case in-sensitive standard program name
Returns
Q_NULLPTR

Implements StelObjectModule.

◆ searchByNameI18n()

StelObjectP HighlightMgr::searchByNameI18n ( const QString &  nameI18n) const
overridevirtual

Find a Highlight by name.

Parameters
nameI18nThe translated case in-sensitive name for the current sky locale.
Returns
Q_NULLPTR

Implements StelObjectModule.

◆ setColor

void HighlightMgr::setColor ( const Vec3f c)
slot

Set the color used to draw of the highlight markers.

Parameters
cThe color of the highlight markers (R,G,B)
// example of usage in scripts
HighlightMgr.setColor(Vec3f(1.0,0.0,0.0));

◆ setMarkersSize

void HighlightMgr::setMarkersSize ( const float  size)
slot

Set the size of highlight markers.

Parameters
sizeThe size of the highlight markers
// example of usage in scripts