Stellarium 0.13.0
List of all members | Public Slots | Signals | Public Member Functions | Properties
GridLinesMgr Class Reference

The GridLinesMgr controls the drawing of the Azimuthal and Equatorial Grids, as well as the great circles: Meridian Line, Ecliptic Line and Equator Line. More...

#include <GridLinesMgr.hpp>

Public Slots

void setFlagAzimuthalGrid (const bool displayed)
 Setter for displaying Azimuthal Grid. More...
 
bool getFlagAzimuthalGrid (void) const
 Accessor for displaying Azimuthal Grid. More...
 
Vec3f getColorAzimuthalGrid (void) const
 Get the current color of the Azimuthal Grid. More...
 
void setColorAzimuthalGrid (const Vec3f &newColor)
 Set the color of the Azimuthal Grid. More...
 
void setFlagEquatorGrid (const bool displayed)
 Setter for displaying Equatorial Grid. More...
 
bool getFlagEquatorGrid (void) const
 Accessor for displaying Equatorial Grid. More...
 
Vec3f getColorEquatorGrid (void) const
 Get the current color of the Equatorial Grid. More...
 
void setColorEquatorGrid (const Vec3f &newColor)
 Set the color of the Equatorial Grid. More...
 
void setFlagEquatorJ2000Grid (const bool displayed)
 Setter for displaying Equatorial Grid. More...
 
bool getFlagEquatorJ2000Grid (void) const
 Accessor for displaying Equatorial Grid. More...
 
Vec3f getColorEquatorJ2000Grid (void) const
 Get the current color of the Equatorial J2000 Grid. More...
 
void setColorEquatorJ2000Grid (const Vec3f &newColor)
 Set the color of the Equatorial J2000 Grid. More...
 
void setFlagEclipticJ2000Grid (const bool displayed)
 Setter for displaying Ecliptic Grid. More...
 
bool getFlagEclipticJ2000Grid (void) const
 Accessor for displaying Ecliptic Grid. More...
 
Vec3f getColorEclipticJ2000Grid (void) const
 Get the current color of the Ecliptic J2000 Grid. More...
 
void setColorEclipticJ2000Grid (const Vec3f &newColor)
 Set the color of the Ecliptic J2000 Grid. More...
 
void setFlagGalacticGrid (const bool displayed)
 Setter for displaying Galactic Grid. More...
 
bool getFlagGalacticGrid (void) const
 Accessor for displaying Galactic Grid. More...
 
Vec3f getColorGalacticGrid (void) const
 Get the current color of the Galactic Grid. More...
 
void setColorGalacticGrid (const Vec3f &newColor)
 Set the color of the Galactic Grid. More...
 
void setFlagEquatorLine (const bool displayed)
 Setter for displaying Equatorial Line. More...
 
bool getFlagEquatorLine (void) const
 Accessor for displaying Equatorial Line. More...
 
Vec3f getColorEquatorLine (void) const
 Get the current color of the Equatorial Line. More...
 
void setColorEquatorLine (const Vec3f &newColor)
 Set the color of the Equator Line. More...
 
void setFlagEclipticLine (const bool displayed)
 Setter for displaying Ecliptic Line. More...
 
bool getFlagEclipticLine (void) const
 Accessor for displaying Ecliptic Line. More...
 
Vec3f getColorEclipticLine (void) const
 Get the current color of the Ecliptic Line. More...
 
void setColorEclipticLine (const Vec3f &newColor)
 Set the color of the Ecliptic Line. More...
 
void setFlagMeridianLine (const bool displayed)
 Setter for displaying Meridian Line. More...
 
bool getFlagMeridianLine (void) const
 Accessor for displaying Meridian Line. More...
 
Vec3f getColorMeridianLine (void) const
 Get the current color of the Meridian Line. More...
 
void setColorMeridianLine (const Vec3f &newColor)
 Set the color of the Meridian Line. More...
 
void setFlagHorizonLine (const bool displayed)
 Setter for displaying Horizon Line. More...
 
bool getFlagHorizonLine (void) const
 Accessor for displaying Horizon Line. More...
 
Vec3f getColorHorizonLine (void) const
 Get the current color of the Horizon Line. More...
 
void setColorHorizonLine (const Vec3f &newColor)
 Set the color of the Horizon Line. More...
 
void setFlagGalacticPlaneLine (const bool displayed)
 Setter for displaying Galactic Plane Line. More...
 
bool getFlagGalacticPlaneLine (void) const
 Accessor for displaying Galactic Plane Line. More...
 
Vec3f getColorGalacticPlaneLine (void) const
 Get the current color of the Galactic Plane Line. More...
 
void setColorGalacticPlaneLine (const Vec3f &newColor)
 Set the color of the Galactic Plane Line. More...
 

Signals

void azimuthalGridDisplayedChanged (const bool) const
 
void azimuthalGridColorChanged (const Vec3f &newColor) const
 
void equatorGridDisplayedChanged (const bool displayed) const
 
void equatorGridColorChanged (const Vec3f &newColor) const
 
void equatorJ2000GridDisplayedChanged (const bool displayed) const
 
void equatorJ2000GridColorChanged (const Vec3f &newColor) const
 
void eclipticJ2000GridDisplayedChanged (const bool displayed) const
 
void eclipticJ2000GridColorChanged (const Vec3f &newColor) const
 
void galacticGridDisplayedChanged (const bool displayed) const
 
void galacticGridColorChanged (const Vec3f &newColor) const
 
void equatorLineDisplayedChanged (const bool displayed) const
 
void equatorLineColorChanged (const Vec3f &newColor) const
 
void eclipticLineDisplayedChanged (const bool displayed) const
 
void eclipticLineColorChanged (const Vec3f &newColor) const
 
void meridianLineDisplayedChanged (const bool displayed) const
 
void meridianLineColorChanged (const Vec3f &newColor) const
 
void horizonLineDisplayedChanged (const bool displayed) const
 
void horizonLineColorChanged (const Vec3f &newColor) const
 
void galacticPlaneLineDisplayedChanged (const bool displayed) const
 
void galacticPlaneLineColorChanged (const Vec3f &newColor) const
 

Public Member Functions

virtual void init ()
 Initialize the GridLinesMgr. More...
 
virtual QString getModuleID () const
 Get the module ID, returns, "gridlines". More...
 
virtual void draw (StelCore *core)
 Draw the grids and great circle lines. More...
 
virtual void update (double deltaTime)
 Update time-dependent features. More...
 
virtual double getCallOrder (StelModuleActionName actionName) const
 Used to determine the order in which the various modules are drawn. More...
 
- Public Member Functions inherited from StelModule
virtual void deinit ()
 Called before the module will be delete, and before the openGL context is suppressed. More...
 
virtual bool drawPartial (StelCore *core)
 Iterate through the drawing sequence. 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 bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 

Properties

bool azimuthalGridDisplayed
 
Vec3f azimuthalGridColor
 
bool equatorGridDisplayed
 
Vec3f equatorGridColor
 
bool equatorJ2000GridDisplayed
 
bool eclipticJ2000GridDisplayed
 
Vec3f equatorJ2000GridColor
 
bool galacticGridDisplayed
 
Vec3f galacticGridColor
 
bool equatorLineDisplayed
 
Vec3f equatorLineColor
 
bool eclipticLineDisplayed
 
Vec3f eclipticLineColor
 
bool meridianLineDisplayed
 
Vec3f meridianLineColor
 
bool horizonLineDisplayed
 
Vec3f horizonLineColor
 
bool galacticPlaneLineDisplayed
 
Vec3f galacticPlaneLineColor
 

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 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 to the StelActionMgr object. More...
 

Detailed Description

The GridLinesMgr controls the drawing of the Azimuthal and Equatorial Grids, as well as the great circles: Meridian Line, Ecliptic Line and Equator Line.

Member Function Documentation

virtual void GridLinesMgr::draw ( StelCore core)
virtual

Draw the grids and great circle lines.

Draws the Equatorial Grid, Azimuthal Grid, Meridian Line, Equator Line and Ecliptic Line according to the various flags which control their visibility.

Reimplemented from StelModule.

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

Used to determine the order in which the various modules are drawn.

Reimplemented from StelModule.

Vec3f GridLinesMgr::getColorAzimuthalGrid ( void  ) const
slot

Get the current color of the Azimuthal Grid.

Vec3f GridLinesMgr::getColorEclipticJ2000Grid ( void  ) const
slot

Get the current color of the Ecliptic J2000 Grid.

Vec3f GridLinesMgr::getColorEclipticLine ( void  ) const
slot

Get the current color of the Ecliptic Line.

Vec3f GridLinesMgr::getColorEquatorGrid ( void  ) const
slot

Get the current color of the Equatorial Grid.

Vec3f GridLinesMgr::getColorEquatorJ2000Grid ( void  ) const
slot

Get the current color of the Equatorial J2000 Grid.

Vec3f GridLinesMgr::getColorEquatorLine ( void  ) const
slot

Get the current color of the Equatorial Line.

Vec3f GridLinesMgr::getColorGalacticGrid ( void  ) const
slot

Get the current color of the Galactic Grid.

Vec3f GridLinesMgr::getColorGalacticPlaneLine ( void  ) const
slot

Get the current color of the Galactic Plane Line.

Vec3f GridLinesMgr::getColorHorizonLine ( void  ) const
slot

Get the current color of the Horizon Line.

Vec3f GridLinesMgr::getColorMeridianLine ( void  ) const
slot

Get the current color of the Meridian Line.

bool GridLinesMgr::getFlagAzimuthalGrid ( void  ) const
slot

Accessor for displaying Azimuthal Grid.

bool GridLinesMgr::getFlagEclipticJ2000Grid ( void  ) const
slot

Accessor for displaying Ecliptic Grid.

bool GridLinesMgr::getFlagEclipticLine ( void  ) const
slot

Accessor for displaying Ecliptic Line.

bool GridLinesMgr::getFlagEquatorGrid ( void  ) const
slot

Accessor for displaying Equatorial Grid.

bool GridLinesMgr::getFlagEquatorJ2000Grid ( void  ) const
slot

Accessor for displaying Equatorial Grid.

bool GridLinesMgr::getFlagEquatorLine ( void  ) const
slot

Accessor for displaying Equatorial Line.

bool GridLinesMgr::getFlagGalacticGrid ( void  ) const
slot

Accessor for displaying Galactic Grid.

bool GridLinesMgr::getFlagGalacticPlaneLine ( void  ) const
slot

Accessor for displaying Galactic Plane Line.

bool GridLinesMgr::getFlagHorizonLine ( void  ) const
slot

Accessor for displaying Horizon Line.

bool GridLinesMgr::getFlagMeridianLine ( void  ) const
slot

Accessor for displaying Meridian Line.

virtual QString GridLinesMgr::getModuleID ( ) const
inlinevirtual

Get the module ID, returns, "gridlines".

virtual void GridLinesMgr::init ( )
virtual

Initialize the GridLinesMgr.

This process checks the values in the application settings, and according to the settings there sets the visibility of the Equatorial Grid, Azimuthal Grid, Meridian Line, Equator Line and Ecliptic Line.

Implements StelModule.

void GridLinesMgr::setColorAzimuthalGrid ( const Vec3f newColor)
slot

Set the color of the Azimuthal Grid.

Parameters
newColorThe color of azimuthal grid
// example of usage in scripts
void GridLinesMgr::setColorEclipticJ2000Grid ( const Vec3f newColor)
slot

Set the color of the Ecliptic J2000 Grid.

Parameters
newColorThe color of ecliptic J2000 grid
// example of usage in scripts
void GridLinesMgr::setColorEclipticLine ( const Vec3f newColor)
slot

Set the color of the Ecliptic Line.

Parameters
newColorThe color of ecliptic line
// example of usage in scripts
void GridLinesMgr::setColorEquatorGrid ( const Vec3f newColor)
slot

Set the color of the Equatorial Grid.

Parameters
newColorThe color of equatorial grid
// example of usage in scripts
void GridLinesMgr::setColorEquatorJ2000Grid ( const Vec3f newColor)
slot

Set the color of the Equatorial J2000 Grid.

Parameters
newColorThe color of equatorial J2000 grid
// example of usage in scripts
void GridLinesMgr::setColorEquatorLine ( const Vec3f newColor)
slot

Set the color of the Equator Line.

Parameters
newColorThe color of equator line
// example of usage in scripts
void GridLinesMgr::setColorGalacticGrid ( const Vec3f newColor)
slot

Set the color of the Galactic Grid.

Parameters
newColorThe color of galactic grid
// example of usage in scripts
void GridLinesMgr::setColorGalacticPlaneLine ( const Vec3f newColor)
slot

Set the color of the Galactic Plane Line.

Parameters
newColorThe color of galactic plane line
// example of usage in scripts
void GridLinesMgr::setColorHorizonLine ( const Vec3f newColor)
slot

Set the color of the Horizon Line.

Parameters
newColorThe color of horizon line
// example of usage in scripts
void GridLinesMgr::setColorMeridianLine ( const Vec3f newColor)
slot

Set the color of the Meridian Line.

Parameters
newColorThe color of meridian line
// example of usage in scripts
void GridLinesMgr::setFlagAzimuthalGrid ( const bool  displayed)
slot

Setter for displaying Azimuthal Grid.

void GridLinesMgr::setFlagEclipticJ2000Grid ( const bool  displayed)
slot

Setter for displaying Ecliptic Grid.

void GridLinesMgr::setFlagEclipticLine ( const bool  displayed)
slot

Setter for displaying Ecliptic Line.

void GridLinesMgr::setFlagEquatorGrid ( const bool  displayed)
slot

Setter for displaying Equatorial Grid.

void GridLinesMgr::setFlagEquatorJ2000Grid ( const bool  displayed)
slot

Setter for displaying Equatorial Grid.

void GridLinesMgr::setFlagEquatorLine ( const bool  displayed)
slot

Setter for displaying Equatorial Line.

void GridLinesMgr::setFlagGalacticGrid ( const bool  displayed)
slot

Setter for displaying Galactic Grid.

void GridLinesMgr::setFlagGalacticPlaneLine ( const bool  displayed)
slot

Setter for displaying Galactic Plane Line.

void GridLinesMgr::setFlagHorizonLine ( const bool  displayed)
slot

Setter for displaying Horizon Line.

void GridLinesMgr::setFlagMeridianLine ( const bool  displayed)
slot

Setter for displaying Meridian Line.

virtual void GridLinesMgr::update ( double  deltaTime)
virtual

Update time-dependent features.

Used to control fading when turning on and off the grid lines and great circles.

Implements StelModule.