Stellarium  0.90.0
List of all members | Public Slots | Signals | Public Member Functions | Properties
ZodiacalLight Class Reference

Manages the displaying of the Zodiacal Light. More...

#include <ZodiacalLight.hpp>

+ Inheritance diagram for ZodiacalLight:
+ Collaboration diagram for ZodiacalLight:

Public Slots

double getIntensity () const
 Get Zodiacal Light intensity. More...
 
void setIntensity (double aintensity)
 Set Zodiacal Light intensity. More...
 
Vec3f getColor () const
 Get the color used for rendering the Zodiacal Light. It is modulated by intensity, light pollution and atmospheric extinction. More...
 
void setColor (const Vec3f &c)
 Sets the color to use for rendering the Zodiacal Light. More...
 
void setFlagShow (bool b)
 Sets whether to show the Zodiacal Light. More...
 
bool getFlagShow (void) const
 Gets whether the Zodiacal Light is displayed. More...
 

Signals

void zodiacalLightDisplayedChanged (const bool displayed)
 
void intensityChanged (double intensity)
 
void colorChanged (Vec3f color)
 

Public Member Functions

virtual void init ()
 Initialize the class. More...
 
virtual void draw (StelCore *core)
 Draw the Zodiacal Light. More...
 
virtual void update (double deltaTime)
 Update and time-dependent state. 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 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...
 
virtual bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 

Properties

bool flagZodiacalLightDisplayed
 
double intensity
 
Vec3f color
 

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

Detailed Description

Manages the displaying of the Zodiacal Light.

The brightness values follow the paper: S. M. Kwon, S. S. Hong, J. L. Weinberg An observational model of the zodiacal light brightness distribution New Astronomy 10 (2004) 91-107. doi:10.1016/j.newast.2004.05.004

Definition at line 50 of file ZodiacalLight.hpp.

Member Function Documentation

virtual void ZodiacalLight::draw ( StelCore core)
virtual

Draw the Zodiacal Light.

Reimplemented from StelModule.

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

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

MilkyWay=1, TOAST=7, we use 8. Other actions return 0 for "nothing special".

Reimplemented from StelModule.

Vec3f ZodiacalLight::getColor ( ) const
inlineslot

Get the color used for rendering the Zodiacal Light. It is modulated by intensity, light pollution and atmospheric extinction.

Definition at line 98 of file ZodiacalLight.hpp.

bool ZodiacalLight::getFlagShow ( void  ) const
slot

Gets whether the Zodiacal Light is displayed.

double ZodiacalLight::getIntensity ( ) const
inlineslot

Get Zodiacal Light intensity.

Definition at line 92 of file ZodiacalLight.hpp.

virtual void ZodiacalLight::init ( )
virtual

Initialize the class.

Here we load the texture for the Zodiacal Light and get the display settings from application settings, namely the flag which determines if the Zodiacal Light is displayed or not, and the intensity setting.

Implements StelModule.

void ZodiacalLight::setColor ( const Vec3f c)
inlineslot

Sets the color to use for rendering the Zodiacal Light.

Parameters
cThe color to use for rendering the Zodiacal Light. Default (1.0, 1.0, 1.0).
// example of usage in scripts

Definition at line 105 of file ZodiacalLight.hpp.

void ZodiacalLight::setFlagShow ( bool  b)
slot

Sets whether to show the Zodiacal Light.

// example of usage in scripts
void ZodiacalLight::setIntensity ( double  aintensity)
inlineslot

Set Zodiacal Light intensity.

Default value: 1.

Parameters
aintensityintensity of Zodiacal Light

Definition at line 95 of file ZodiacalLight.hpp.

virtual void ZodiacalLight::update ( double  deltaTime)
virtual

Update and time-dependent state.

Updates the fade level while the Zodiacal Light rendering is being changed from on to off or off to on.

Implements StelModule.


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