Stellarium  0.16.0
List of all members | Public Types | Public Slots | Signals | Public Member Functions | Properties
Pulsars Class Reference

Main class of the Pulsars plugin. More...

#include <Pulsars.hpp>

+ Inheritance diagram for Pulsars:
+ Collaboration diagram for Pulsars:

Public Types

enum  UpdateState {
  Updating, CompleteNoUpdates, CompleteUpdates, DownloadError,
  OtherError
}
 Used for keeping for track of the download/update status. More...
 
- 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...
 

Public Slots

void setFlagShowPulsarsButton (bool b)
 Define whether the button toggling pulsars should be visible. More...
 
bool getFlagShowPulsarsButton (void)
 
void setFlagShowPulsars (bool b)
 Enable/disable display of markers of pulsars. More...
 
bool getFlagShowPulsars (void)
 Get status to display of markers of pulsars. More...
 
bool getDisplayMode (void)
 Get status to display of distribution of pulsars. More...
 
void setDisplayMode (bool b)
 Enable/disable display of distribution of pulsars. More...
 
bool getGlitchFlag (void)
 Get status for usage of separate color for pulsars with glitches. More...
 
void setGlitchFlag (bool b)
 Enable/disable the use of a separate color for pulsars with glitches. More...
 
Vec3f getMarkerColor (bool mtype=true)
 Get color for pulsars markers. More...
 
void setMarkerColor (const Vec3f &c, bool mtype=true)
 Set color for pulsars markers. More...
 
int getCountPulsars (void)
 Get count of pulsars from catalog. More...
 
void updateJSON (void)
 Download JSON from web recources described in the module section of the module.ini file and update the local JSON file. More...
 

Signals

void updateStateChanged (Pulsars::UpdateState state)
 
void jsonUpdateComplete (void)
 emitted after a JSON update has run. More...
 
void flagPulsarsVisibilityChanged (bool b)
 

Public Member Functions

virtual void init ()
 Initialize itself. More...
 
virtual void deinit ()
 Called before the module will be delete, and before the openGL context is suppressed. More...
 
virtual void update (double)
 Update the module with respect to the time. More...
 
virtual void draw (StelCore *core)
 Execute all the drawing functions for this module. More...
 
virtual void drawPointer (StelCore *core, StelPainter &painter)
 
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 QList< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const
 Used to get a list of objects which are near to some position. More...
 
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const
 Return the matching satellite object's pointer if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByName (const QString &name) const
 Return the matching satellite if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByID (const QString &id) const
 Return the StelObject with the given ID if exists or the empty StelObject if not found. More...
 
virtual QStringList listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const
 Find and return the list of at most maxNbItem objects auto-completing the passed object name. More...
 
virtual QStringList listAllObjects (bool inEnglish) const
 List all StelObjects. More...
 
virtual QString getName () const
 Gets a user-displayable name of the object category. More...
 
virtual QString getStelObjectType () const
 Returns the name that will be returned by StelObject::getType() for the objects this module manages. More...
 
PulsarP getByID (const QString &id) const
 get a Pulsar object by identifier More...
 
virtual bool configureGui (bool show=true)
 Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin. More...
 
void restoreDefaults (void)
 Set up the plugin with default values. More...
 
void readSettingsFromConfig (void)
 Read (or re-read) settings from the main config file. More...
 
void saveSettingsToConfig (void)
 Save the settings to the main configuration file. More...
 
bool getUpdatesEnabled (void)
 get whether or not the plugin will try to update catalog data from the internet More...
 
void setUpdatesEnabled (bool b)
 set whether or not the plugin will try to update catalog data from the internet More...
 
void setEnableAtStartup (bool b)
 
bool getEnableAtStartup (void)
 
QDateTime getLastUpdate (void)
 get the date and time the pulsars were updated More...
 
int getUpdateFrequencyDays (void)
 get the update frequency in days More...
 
void setUpdateFrequencyDays (int days)
 
int getSecondsToUpdate (void)
 get the number of seconds till the next update More...
 
UpdateState getUpdateState (void)
 Get the current updateState. 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
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 bool handlePinch (qreal scale, bool started)
 Handle pinch gesture events. More...
 

Properties

bool pulsarsVisible
 

Additional Inherited Members

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

Detailed Description

Main class of the Pulsars plugin.

Author
Alexander Wolf

Definition at line 73 of file Pulsars.hpp.

Member Enumeration Documentation

Used for keeping for track of the download/update status.

Enumerator
Updating 

Update in progress.

CompleteNoUpdates 

Update completed, there we no updates.

CompleteUpdates 

Update completed, there were updates.

DownloadError 

Error during download phase.

OtherError 

Other error.

Definition at line 84 of file Pulsars.hpp.

Member Function Documentation

virtual bool Pulsars::configureGui ( bool  show = true)
virtual

Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin.

Reimplemented from StelModule.

virtual void Pulsars::deinit ( )
virtual

Called before the module will be delete, and before the openGL context is suppressed.

Deinitialize all openGL texture in this method.

Reimplemented from StelModule.

virtual void Pulsars::draw ( StelCore core)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

PulsarP Pulsars::getByID ( const QString &  id) const

get a Pulsar object by identifier

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

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.

int Pulsars::getCountPulsars ( void  )
inlineslot

Get count of pulsars from catalog.

Returns
count of pulsars

Definition at line 228 of file Pulsars.hpp.

bool Pulsars::getDisplayMode ( void  )
slot

Get status to display of distribution of pulsars.

Returns
true if distribution of pulsars is enabled
bool Pulsars::getFlagShowPulsars ( void  )
inlineslot

Get status to display of markers of pulsars.

Returns
true if it's visible

Definition at line 197 of file Pulsars.hpp.

bool Pulsars::getGlitchFlag ( void  )
slot

Get status for usage of separate color for pulsars with glitches.

Returns
true if separate color is used for pulsars with glitches
QDateTime Pulsars::getLastUpdate ( void  )
inline

get the date and time the pulsars were updated

Definition at line 166 of file Pulsars.hpp.

Vec3f Pulsars::getMarkerColor ( bool  mtype = true)
slot

Get color for pulsars markers.

Parameters
mtypeset false if you want get color of pulsars with glitches
Returns
color
virtual QString Pulsars::getName ( ) const
inlinevirtual

Gets a user-displayable name of the object category.

Implements StelObjectModule.

Definition at line 133 of file Pulsars.hpp.

int Pulsars::getSecondsToUpdate ( void  )

get the number of seconds till the next update

virtual QString Pulsars::getStelObjectType ( ) const
inlinevirtual

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

Implements StelObjectModule.

Definition at line 134 of file Pulsars.hpp.

int Pulsars::getUpdateFrequencyDays ( void  )
inline

get the update frequency in days

Definition at line 169 of file Pulsars.hpp.

bool Pulsars::getUpdatesEnabled ( void  )
inline

get whether or not the plugin will try to update catalog data from the internet

Returns
true if updates are set to be done, false otherwise

Definition at line 157 of file Pulsars.hpp.

UpdateState Pulsars::getUpdateState ( void  )
inline

Get the current updateState.

Definition at line 176 of file Pulsars.hpp.

virtual void Pulsars::init ( )
virtual

Initialize itself.

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

Implements StelModule.

void Pulsars::jsonUpdateComplete ( void  )
signal

emitted after a JSON update has run.

virtual QStringList Pulsars::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.

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

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.

void Pulsars::readSettingsFromConfig ( void  )

Read (or re-read) settings from the main config file.

This will be called from init and also when restoring defaults (i.e. from the configuration dialog / restore defaults button).

void Pulsars::restoreDefaults ( void  )

Set up the plugin with default values.

This means clearing out the Pulsars section in the main config.ini (if one already exists), and populating it with default values. It also creates the default pulsars.json file from the resource embedded in the plugin lib/dll file.

void Pulsars::saveSettingsToConfig ( void  )

Save the settings to the main configuration file.

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

Used to get a list of objects which are near to some position.

Parameters
va vector representing the position in th sky around which to search for nebulae.
limitFovthe field of view around the position v in which to search for satellites.
corethe StelCore to use for computations.
Returns
an list containing the satellites located inside the limitFov circle around position v.

Implements StelObjectModule.

virtual StelObjectP Pulsars::searchByID ( const QString &  id) const
inlinevirtual

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

Parameters
namethe english object name

Implements StelObjectModule.

Definition at line 121 of file Pulsars.hpp.

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

Return the matching satellite if exists or Q_NULLPTR.

Parameters
nameThe case in-sensistive standard program name

Implements StelObjectModule.

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

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

Parameters
nameI18nThe case in-sensistive satellite name

Implements StelObjectModule.

void Pulsars::setDisplayMode ( bool  b)
slot

Enable/disable display of distribution of pulsars.

Parameters
b
void Pulsars::setFlagShowPulsars ( bool  b)
slot

Enable/disable display of markers of pulsars.

Parameters
bboolean flag
void Pulsars::setFlagShowPulsarsButton ( bool  b)
slot

Define whether the button toggling pulsars should be visible.

void Pulsars::setGlitchFlag ( bool  b)
slot

Enable/disable the use of a separate color for pulsars with glitches.

Parameters
booleanflag
void Pulsars::setMarkerColor ( const Vec3f c,
bool  mtype = true 
)
slot

Set color for pulsars markers.

Parameters
ccolor
mtypeset false if you want set color for pulsars with glitches
// example of usage in scripts
Pulsars.setMarkerColor(Vec3f(1.0,0.0,0.0), true);
void Pulsars::setUpdatesEnabled ( bool  b)
inline

set whether or not the plugin will try to update catalog data from the internet

Parameters
bif true, updates will be enabled, else they will be disabled

Definition at line 160 of file Pulsars.hpp.

virtual void Pulsars::update ( double  deltaTime)
inlinevirtual

Update the module with respect to the time.

Parameters
deltaTimethe time increment in second since last call.

Implements StelModule.

Definition at line 99 of file Pulsars.hpp.

void Pulsars::updateJSON ( void  )
slot

Download JSON from web recources described in the module section of the module.ini file and update the local JSON file.

void Pulsars::updateStateChanged ( Pulsars::UpdateState  state)
signal
Parameters
statethe new update state.

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