Main class of the Pointer Coordinates plugin. More...

#include <PointerCoordinates.hpp>

Inheritance diagram for PointerCoordinates:

Collaboration diagram for PointerCoordinates:

Public Types
enum	CoordinatesPlace { TopCenter, TopRight, RightBottomCorner, Custom }
	Available places of string with coordinates. More...

enum	CoordinateSystem { RaDecJ2000, RaDec, HourAngle, Ecliptic, EclipticJ2000, AltAzi, Galactic, Supergalactic }
	Available coordinate systems. 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	enableCoordinates (bool b)
	Enable plugin usage. More...

void	setFlagEnableAtStartup (bool b)
	Enable plugin usage at startup. More...

void	setFontSize (int size)
	Set font size for message. More...

void	setFlagShowCoordinatesButton (bool b)
	Display plugin button on toolbar. More...

void	setCurrentCoordinatesPlace (CoordinatesPlace place)
	Set the current place of the string with coordinates. More...

CoordinatesPlace	getCurrentCoordinatesPlace () const
	Get the current place of the string with coordinates. More...

QString	getCurrentCoordinatesPlaceKey (void) const
	Get the current place of the string with coordinates. More...

void	setCurrentCoordinatesPlaceKey (QString key)
	Set the current place of the string with coordinates from its key. More...

void	setCurrentCoordinateSystem (CoordinateSystem cs)
	Set the current coordinate system. More...

CoordinateSystem	getCurrentCoordinateSystem () const
	Get the current coordinate system. More...

QString	getCurrentCoordinateSystemKey (void) const
	Get the current coordinate system key. More...

void	setCurrentCoordinateSystemKey (QString key)
	Set the current coordinate system from its key. More...

void	setCustomCoordinatesPlace (int x, int y)

void	setFlagShowConstellation (bool b)

bool	getFlagShowConstellation (void) const

Signals
void	flagCoordinatesVisibilityChanged (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 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 bool	configureGui (bool show)
	Detect or show the configuration GUI elements for the module. More...

void	restoreDefaultConfiguration (void)
	Set up the plugin with default values. More...

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

void	saveConfiguration (void)
	Save the settings to the main configuration file. More...

bool	isEnabled () const
	Is plugin enabled? More...

int	getFontSize (void)
	Get font size for messages. More...

bool	getFlagEnableAtStartup (void)

bool	getFlagShowCoordinatesButton (void)

QPair< int, int >	getCoordinatesPlace (QString text)

QPair< int, int >	getCustomCoordinatesPlace ()

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	enabled

Additional Inherited Members
Protected Member Functions inherited from StelModule
class StelAction *	addAction (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 StelAction *	addAction (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 Pointer Coordinates plugin.

Author: Alexander Wolf

Definition at line 50 of file PointerCoordinates.hpp.

Member Enumeration Documentation

enum PointerCoordinates::CoordinatesPlace

Available places of string with coordinates.

Enumerator
TopCenter	The top center of the screen.
TopRight	In center of the top right half of the screen.
RightBottomCorner	The right bottom corner of the screen.
Custom	The custom position on the screen.

Definition at line 64 of file PointerCoordinates.hpp.

enum PointerCoordinates::CoordinateSystem

Available coordinate systems.

Definition at line 74 of file PointerCoordinates.hpp.

Member Function Documentation

virtual bool PointerCoordinates::configureGui ( bool show )

virtual

Detect or show the configuration GUI elements for the module.

This is to be used with plugins to display a configuration dialog from the plugin list window.

Parameters

show	if true, make the configuration GUI visible. If false, hide the config GUI if there is one.

Returns: true if the module has a configuration GUI, else false.

Reimplemented from StelModule.

virtual void PointerCoordinates::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 PointerCoordinates::draw ( StelCore * core )

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

void PointerCoordinates::enableCoordinates ( bool b )

slot

Enable plugin usage.

virtual double PointerCoordinates::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

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

CoordinatesPlace PointerCoordinates::getCurrentCoordinatesPlace ( ) const

inlineslot

Get the current place of the string with coordinates.

Definition at line 160 of file PointerCoordinates.hpp.

QString PointerCoordinates::getCurrentCoordinatesPlaceKey ( void ) const

slot

Get the current place of the string with coordinates.

CoordinateSystem PointerCoordinates::getCurrentCoordinateSystem ( ) const

inlineslot

Get the current coordinate system.

Definition at line 175 of file PointerCoordinates.hpp.

QString PointerCoordinates::getCurrentCoordinateSystemKey ( void ) const

slot

Get the current coordinate system key.

int PointerCoordinates::getFontSize ( void )

inline

Get font size for messages.

Definition at line 115 of file PointerCoordinates.hpp.

virtual void PointerCoordinates::init ( )

virtual

Initialize itself.

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

Implements StelModule.

bool PointerCoordinates::isEnabled ( ) const

inline

Is plugin enabled?

Definition at line 109 of file PointerCoordinates.hpp.

void PointerCoordinates::loadConfiguration ( 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 PointerCoordinates::restoreDefaultConfiguration ( void )

Set up the plugin with default values.

This means clearing out the PointerCoordinates section in the main config.ini (if one already exists), and populating it with default values.

void PointerCoordinates::saveConfiguration ( void )

Save the settings to the main configuration file.

void PointerCoordinates::setCurrentCoordinatesPlace ( CoordinatesPlace place )

inlineslot

Set the current place of the string with coordinates.

Definition at line 155 of file PointerCoordinates.hpp.

void PointerCoordinates::setCurrentCoordinatesPlaceKey ( QString key )

slot

Set the current place of the string with coordinates from its key.

void PointerCoordinates::setCurrentCoordinateSystem ( CoordinateSystem cs )

inlineslot

Set the current coordinate system.

Definition at line 170 of file PointerCoordinates.hpp.

void PointerCoordinates::setCurrentCoordinateSystemKey ( QString key )

slot

Set the current coordinate system from its key.

void PointerCoordinates::setFlagEnableAtStartup ( bool b )

inlineslot

Enable plugin usage at startup.

Definition at line 142 of file PointerCoordinates.hpp.

void PointerCoordinates::setFlagShowCoordinatesButton ( bool b )

slot

Display plugin button on toolbar.

void PointerCoordinates::setFontSize ( int size )

inlineslot

Set font size for message.

Definition at line 147 of file PointerCoordinates.hpp.

virtual void PointerCoordinates::update ( double deltaTime )

inlinevirtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

Definition at line 92 of file PointerCoordinates.hpp.

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

/home/aw/devel/stellarium/0.15/plugins/PointerCoordinates/src/PointerCoordinates.hpp

Public Types

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation