Oculars Class Reference

Main class of the Oculars plug-in. More...

#include <Oculars.hpp>

Public Slots
void	updateLists ()
	Update the ocular, telescope and sensor lists after the removal of a member. More...
void	ccdRotationReset ()
void	decrementCCDIndex ()
void	decrementOcularIndex ()
void	decrementTelescopeIndex ()
void	decrementLensIndex ()
void	displayPopupMenu ()
void	enableOcular (bool b)
	This method is called with we detect that our hot key is pressed. More...
void	incrementCCDIndex ()
void	incrementOcularIndex ()
void	incrementTelescopeIndex ()
void	incrementLensIndex ()
void	disableLens ()
void	rotateCCD (QString amount)
	amount must be a number. More...
void	selectCCDAtIndex (QString indexString)
	indexString must be an integer, in the range of -1:ccds.count() More...
void	selectOcularAtIndex (QString indexString)
	indexString must be an integer, in the range of -1:oculars.count() More...
void	selectTelescopeAtIndex (QString indexString)
	indexString must be an integer, in the range of -1:telescopes.count() More...
void	selectLensAtIndex (QString indexString)
	indexString must be an integer, in the range -1:lense.count<() More...
void	toggleCCD (bool show)
	Toggles the sensor frame overlay. More...
void	toggleCCD ()
	Toggles the sensor frame overlay (overloaded for blind switching). More...
void	toggleCrosshairs (bool show=true)
void	toggleTelrad (bool show)
	Toggles the Telrad sight overlay. More...
void	toggleTelrad ()
	Toggles the Telrad sight overlay (overloaded for blind switching). More...
void	enableGuiPanel (bool enable=true)
void	setFlagDecimalDegrees (const bool b)
bool	getFlagDecimalDegrees (void) const

Signals
void	selectedCCDChanged ()
void	selectedOcularChanged ()
void	selectedTelescopeChanged ()
void	selectedLensChanged ()

Public Member Functions
virtual void	init ()
	Initialize itself. More...
virtual void	deinit ()
	Called before the module will be deleted, and before the renderer is destroyed. More...
virtual bool	configureGui (bool show=true)
	Detect or show the configuration GUI elements for the module. More...
virtual void	draw (StelCore *core, class StelRenderer *renderer)
	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 const StelStyle	getModuleStyleSheet (const StelStyle &style)
	Returns the module-specific style sheet. More...
virtual void	handleKeys (class QKeyEvent *event)
	This method is needed because the MovementMgr classes handleKeys() method consumes the event. More...
virtual void	handleMouseClicks (class QMouseEvent *event)
	Handle mouse clicks. More...
virtual void	update (double)
	Update the module with respect to the time. More...
QString	getDimensionsString (double fovX, double fovY) const
QString	getFOVString (double fov) const
Public Member Functions inherited from StelModule
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	handleMouseWheel (class QWheelEvent *)
	Handle mouse wheel. More...
virtual bool	handleMouseMoves (int x, int y, Qt::MouseButtons b)
	Handle mouse moves. More...

Static Public Member Functions
static QSettings *	appSettings ()

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

Main class of the Oculars plug-in.

Definition at line 49 of file Oculars.hpp.

Member Function Documentation

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

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 Oculars::deinit ( )

virtual

Called before the module will be deleted, and before the renderer is destroyed.

Deinitialize all textures in this method.

Reimplemented from StelModule.

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

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing
renderer	Renderer to draw with.

Reimplemented from StelModule.

void Oculars::enableOcular ( bool  b )

slot

This method is called with we detect that our hot key is pressed.

It handles determining if we should do anything - based on a selected object.

virtual double Oculars::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.

virtual const StelStyle Oculars::getModuleStyleSheet ( const StelStyle &  style )

virtual

Returns the module-specific style sheet.

The main StelStyle instance should be passed.

virtual void Oculars::handleKeys ( class QKeyEvent *  event )

virtual

This method is needed because the MovementMgr classes handleKeys() method consumes the event.

Because we want the ocular view to track, we must intercept & process ourselves. Only called while flagShowOculars or flagShowCCD == true.

Reimplemented from StelModule.

virtual void Oculars::handleMouseClicks ( class QMouseEvent *  )

virtual

Handle mouse clicks.

Please note that most of the interactions will be done through the GUI module.

Returns

set the event as accepted if it was intercepted

Reimplemented from StelModule.

virtual void Oculars::init ( )

virtual

Initialize itself.

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

Implements StelModule.

void Oculars::rotateCCD ( QString  amount )

slot

amount must be a number.

void Oculars::selectCCDAtIndex ( QString  indexString )

slot

indexString must be an integer, in the range of -1:ccds.count()

void Oculars::selectLensAtIndex ( QString  indexString )

slot

indexString must be an integer, in the range -1:lense.count<()

void Oculars::selectOcularAtIndex ( QString  indexString )

slot

indexString must be an integer, in the range of -1:oculars.count()

void Oculars::selectTelescopeAtIndex ( QString  indexString )

slot

indexString must be an integer, in the range of -1:telescopes.count()

void Oculars::toggleCCD ( bool  show )

slot

Toggles the sensor frame overlay.

void Oculars::toggleCCD ( )

slot

Toggles the sensor frame overlay (overloaded for blind switching).

void Oculars::toggleTelrad ( bool  show )

slot

Toggles the Telrad sight overlay.

void Oculars::toggleTelrad ( )

slot

Toggles the Telrad sight overlay (overloaded for blind switching).

virtual void Oculars::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 76 of file Oculars.hpp.

void Oculars::updateLists ( )

slot

Update the ocular, telescope and sensor lists after the removal of a member.

Necessary because of the way model/view management in the OcularDialog is implemented.

---

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

• /home/aw/devel/stellarium/trunk/plugins/Oculars/src/Oculars.hpp