Stellarium 0.12.2
List of all members | Public Slots | Public Member Functions
MilkyWay Class Reference

Manages the displaying of the Milky Way. More...

#include <MilkyWay.hpp>

Public Slots

double getIntensity () const
 Get Milky Way intensity. More...
 
void setIntensity (double aintensity)
 Set Milky Way intensity. More...
 
Vec3f getColor () const
 Get the color used for rendering the milky way. More...
 
void setColor (const Vec3f &c)
 Sets the color to use for rendering the milky way. More...
 
void setFlagShow (bool b)
 Sets whether to show the Milky Way. More...
 
bool getFlagShow (void) const
 Gets whether the Milky Way is displayed. More...
 

Public Member Functions

virtual void init ()
 Initialize the class. More...
 
virtual void draw (StelCore *core, class StelRenderer *renderer)
 Draw the Milky Way. 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 deleted, and before the renderer is destroyed. More...
 
virtual bool drawPartial (StelCore *core, class StelRenderer *renderer)
 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...
 

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

Detailed Description

Manages the displaying of the Milky Way.

Definition at line 31 of file MilkyWay.hpp.

Member Function Documentation

virtual void MilkyWay::draw ( StelCore core,
class StelRenderer renderer 
)
virtual

Draw the Milky Way.

Parameters
coreThe StelCore object.
rendererRenderer to draw with.

Reimplemented from StelModule.

virtual double MilkyWay::getCallOrder ( StelModuleActionName  actionName) const
inlinevirtual

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

Reimplemented from StelModule.

Definition at line 57 of file MilkyWay.hpp.

Vec3f MilkyWay::getColor ( ) const
inlineslot

Get the color used for rendering the milky way.

Definition at line 68 of file MilkyWay.hpp.

bool MilkyWay::getFlagShow ( void  ) const
slot

Gets whether the Milky Way is displayed.

double MilkyWay::getIntensity ( ) const
inlineslot

Get Milky Way intensity.

Definition at line 63 of file MilkyWay.hpp.

virtual void MilkyWay::init ( )
virtual

Initialize the class.

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

Implements StelModule.

void MilkyWay::setColor ( const Vec3f c)
inlineslot

Sets the color to use for rendering the milky way.

Definition at line 70 of file MilkyWay.hpp.

void MilkyWay::setFlagShow ( bool  b)
slot

Sets whether to show the Milky Way.

void MilkyWay::setIntensity ( double  aintensity)
inlineslot

Set Milky Way intensity.

Definition at line 65 of file MilkyWay.hpp.

virtual void MilkyWay::update ( double  deltaTime)
virtual

Update and time-dependent state.

Updates the fade level while the Milky way 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: