HipsMgr Class Reference

This class controls display of Hierarchical Progressive Surveys (HiPS), all-sky surveys in a particular format defined by the International Virtual Observatory Alliance. More...

#include <HipsMgr.hpp>

Public Types
enum	State { Created , Loading , Loaded }
	The loading state of the survey sources.
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	loadSources ()
	Start to load the default sources.
bool	getFlagShow (void) const
	Get whether the surveys are displayed.
void	setFlagShow (bool b)
	Set whether the surveys are displayed.

Signals
void	showChanged (bool value) const
void	surveysChanged () const
void	stateChanged (State value) const
void	gotNewSurvey (HipsSurveyP survey) const
	Emitted when a new survey has been loaded.
void	toggleDialog () const

Public Member Functions
void	init () override
	Initialize itself. More...
void	deinit () override
	Called before the module will be deleted, and before the OpenGL context is suppressed. More...
void	update (double deltaTime) override
	Update the module with respect to the time. More...
void	draw (StelCore *core) override
	Execute all the drawing functions for this module. More...
double	getCallOrder (StelModuleActionName actionName) const 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...
Q_INVOKABLE HipsSurveyP	getSurveyByUrl (const QString &url)
	Return the hips survey that has a given url.
State	getState () const
bool	isLoaded () const
Public Member Functions inherited from StelModule
	StelModule ()
	Constructor. Every derived class MUST call setObjectName(className) in its constructor.
virtual QSettings *	getSettings ()
	Return module-specific settings. More...
virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version.
virtual QString	getAuthorName () const
	Get the name of the module author.
virtual QString	getAuthorEmail () const
	Get the email address of the module author.
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
QList< HipsSurveyP >	surveys
bool	flagShow
State	state = Created
bool	loaded

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...
StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, QObject *contextObject, std::function< void()> lambda, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to Lambda functor) to the StelActionMgr object. More...

Detailed Description

This class controls display of Hierarchical Progressive Surveys (HiPS), all-sky surveys in a particular format defined by the International Virtual Observatory Alliance.

A full description of the format can be found on the IVOA website. (https://www.ivoa.net/documents/HiPS/20170519/REC-HIPS-1.0-20170519.pdf) Stellarium supports only image-based surveys.

Note

You can finetune the amount of HiPS-related messages in the logfile by configuring the logging category stel.HiPS. For this, e.g. set environment variable QT_LOGGING_RULES="*.debug=false;stel.HiPS.debug=true;". By default, only Info and more severe messages are displayed.

Member Function Documentation

deinit()

void HipsMgr::deinit ( )

overridevirtual

Called before the module will be deleted, and before the OpenGL context is suppressed.

Deinitialize all OpenGL texture in this method.

Reimplemented from StelModule.

draw()

void HipsMgr::draw ( StelCore *  core )

overridevirtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

getCallOrder()

double HipsMgr::getCallOrder ( StelModuleActionName  actionName ) const

overridevirtual

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.

init()

void HipsMgr::init ( )

overridevirtual

Initialize itself.

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

Implements StelModule.

update()

void HipsMgr::update ( double  deltaTime )

overridevirtual

Update the module with respect to the time.

Parameters

deltaTime

the time increment in second since last call.

Reimplemented from StelModule.