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

#include <RemoteSync.hpp>

Inheritance diagram for RemoteSync:

Collaboration diagram for RemoteSync:

Public Types
enum	SyncState { IDLE, SERVER, CLIENT, CLIENT_CONNECTING }

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	setClientServerHost (const QString &clientServerHost)

void	setClientServerPort (const int port)

void	setServerPort (const int port)

void	startServer ()
	Starts the plugin in server mode, on the port specified by the serverPort property. More...

void	stopServer ()
	Tries to disconnect all current clients and stops the server, returning to the IDLE state. More...

void	connectToServer ()
	Connects the plugin to the server specified by the clientServerHost and clientServerPort properties. More...

void	disconnectFromServer ()
	Disconnects from the server and returns to the IDLE state. More...

void	loadSettings ()
	Load the plug-in's settings from the configuration file. More...

void	saveSettings ()
	Save the plug-in's settings to the configuration file. More...

void	restoreDefaultSettings ()
	Restore the plug-in's settings to the default state. More...

Signals
void	errorOccurred (const QString errorString)

void	clientServerHostChanged (const QString clientServerHost)

void	clientServerPortChanged (const int port)

void	serverPortChanged (const int port)

void	stateChanged (RemoteSync::SyncState state)

Public Member Functions
virtual void	init () Q_DECL_OVERRIDE
	Initialize itself. More...

virtual void	update (double deltaTime) Q_DECL_OVERRIDE
	Update the module with respect to the time. More...

virtual double	getCallOrder (StelModuleActionName actionName) const Q_DECL_OVERRIDE
	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=true) Q_DECL_OVERRIDE
	Detect or show the configuration GUI elements for the module. More...

QString	getClientServerHost () const

int	getClientServerPort () const

int	getServerPort () const

SyncState	getState () const

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 void	draw (StelCore *core)
	Execute all the drawing functions for this module. 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...

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 RemoteSync plug-in.

Provides a synchronization mechanism for multiple Stellarium instances in a network. This plugin has been developed during ESA SoCiS 2015.

Definition at line 35 of file RemoteSync.hpp.

Member Function Documentation

virtual bool RemoteSync::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.

void RemoteSync::connectToServer ( )

slot

Connects the plugin to the server specified by the clientServerHost and clientServerPort properties.

If currently in a state other than IDLE, this call has no effect.

void RemoteSync::disconnectFromServer ( )

slot

Disconnects from the server and returns to the IDLE state.

Only has an effect in the CLIENT state.

virtual double RemoteSync::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 void RemoteSync::init ( )

virtual

Initialize itself.

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

Implements StelModule.

void RemoteSync::loadSettings ( )

slot

Load the plug-in's settings from the configuration file.

Settings are kept in the "RemoteSync" section in Stellarium's configuration file. If no such section exists, it will load default values.

See also: saveSettings(), restoreSettings()

void RemoteSync::restoreDefaultSettings ( )

slot

Restore the plug-in's settings to the default state.

Replace the plug-in's settings in Stellarium's configuration file with the default values and re-load them. Uses internally loadSettings() and saveSettings().

void RemoteSync::saveSettings ( )

slot

Save the plug-in's settings to the configuration file.

See also: loadSettings(), restoreSettings()

void RemoteSync::startServer ( )

slot

Starts the plugin in server mode, on the port specified by the serverPort property.

If currently in a state other than IDLE, this call has no effect.

void RemoteSync::stopServer ( )

slot

Tries to disconnect all current clients and stops the server, returning to the IDLE state.

Only has an effect in the SERVER state.

virtual void RemoteSync::update ( double deltaTime )

virtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

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

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

Public Types

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation