StelSkyPolygon Class Reference

Base class for any polygon with a fixed position in the sky. More...

#include <StelSkyPolygon.hpp>

Public Member Functions
	StelSkyPolygon ()
	Default constructor. More...
	StelSkyPolygon (const QString &url, StelSkyPolygon *parent=NULL)
	Constructor. More...
	StelSkyPolygon (const QVariantMap &map, StelSkyPolygon *parent)
	Constructor. More...
	~StelSkyPolygon ()
	Destructor. More...
void	draw (StelCore *core, class StelRenderer *renderer, StelProjectorP projector, float opacity=1.)
	Draw the image on the screen. More...
DataSetCredits	getDataSetCredits () const
	Return the dataset credits to use in the progress bar. More...
ServerCredits	getServerCredits () const
	Return the server credits to use in the progress bar. More...
QVariantMap	toQVariantMap () const
	Convert the polygon informations to a map following the JSON structure. More...
Public Member Functions inherited from MultiLevelJsonBase
	MultiLevelJsonBase (MultiLevelJsonBase *parent=NULL)
	Default constructor. More...
void	initFromUrl (const QString &url)
	Init the element from a URL. More...
void	initFromQVariantMap (const QVariantMap &map)
	Init the element from a QVariantMap. More...
	~MultiLevelJsonBase ()
	Destructor. More...
QString	getShortName () const
	Return the short name for this image to be used in the loading bar. More...
bool	hasErrorOccured () const
	Return true if an error occured while loading the data. More...
int	getLevel () const
	Get the depth level in the tree. More...
QVariantMap	toQVariantMap () const
	Convert the image informations to a map following the JSON structure. More...
void	scheduleChildsDeletion ()
	Schedule a deletion for all the childs. More...
Public Member Functions inherited from StelSkyLayer
	StelSkyLayer (QObject *parent=NULL)
virtual QString	getShortServerCredits () const
	Return the short server name to display in the loading bar. More...
virtual QString	getKeyHint () const
	Return a hint on which key to use for referencing this layer. More...
virtual QString	getLayerDescriptionHtml () const
	Return a human readable description of the layer with e.g. More...
void	setFrameType (StelCore::FrameType ft)
	Set the reference frame type. More...
StelCore::FrameType	getFrameType ()
	Get the reference frame type. More...

Protected Member Functions
virtual void	loadFromQVariantMap (const QVariantMap &map)
	Load the polygon from a valid QVariantMap. More...
Protected Member Functions inherited from MultiLevelJsonBase
bool	isDeletionScheduled () const
	Return true if a deletion is currently scheduled. More...
void	updatePercent (int tot, int numToBeLoaded)
void	deleteUnusedSubTiles ()
	Delete all the subtiles which were not displayed since more than lastDrawTrigger seconds. More...
void	cancelDeletion ()
	If a deletion was scheduled, cancel it. More...

Protected Attributes
float	minResolution
	Minimum resolution at which the next level needs to be loaded in degree/pixel. More...
ServerCredits	serverCredits
	The credits of the server where this data come from. More...
DataSetCredits	dataSetCredits
	The credits for the data set. More...
QList< SphericalConvexPolygon >	skyConvexPolygons
	Direction of the vertices of the convex hull in ICRS frame. More...
Protected Attributes inherited from MultiLevelJsonBase
QString	shortName
	The very short name for this image set to be used in loading bar. More...
QString	baseUrl
	Base URL to prefix to relative URL. More...
QString	contructorUrl
	The relative URL passed to the constructor. More...
QList< MultiLevelJsonBase * >	subTiles
	The list of all the created subtiles for this tile. More...
bool	errorOccured
	Set to true if an error occured with this tile and it should not be displayed. More...
bool	downloading
	true if the JSON descriptor file is currently downloading More...

Additional Inherited Members
Signals inherited from StelSkyLayer
void	loadingStateChanged (bool b)
	Emitted when loading of data started or stopped. More...
void	percentLoadedChanged (int percentage)
	Emitted when the percentage of loading tiles/tiles to be displayed changed. More...
Static Protected Member Functions inherited from MultiLevelJsonBase
static QVariantMap	loadFromJSON (QIODevice &input, bool qZcompressed=false, bool gzCompressed=false)
	Load the element information from a JSON file. More...

Detailed Description

Base class for any polygon with a fixed position in the sky.

Definition at line 31 of file StelSkyPolygon.hpp.

Constructor & Destructor Documentation

StelSkyPolygon::StelSkyPolygon ( )

inline

Default constructor.

Definition at line 37 of file StelSkyPolygon.hpp.

StelSkyPolygon::StelSkyPolygon	(	const QString &	url,
		StelSkyPolygon *	parent = NULL
	)

Constructor.

StelSkyPolygon::StelSkyPolygon	(	const QVariantMap &	map,
		StelSkyPolygon *	parent
	)

Constructor.

StelSkyPolygon::~StelSkyPolygon

(

)

Destructor.

Member Function Documentation

void StelSkyPolygon::draw ( StelCore *  core, class StelRenderer *  renderer, StelProjectorP  projector, float  opacity = 1.  )

virtual

Draw the image on the screen.

Implements StelSkyLayer.

DataSetCredits StelSkyPolygon::getDataSetCredits ( ) const

inline

Return the dataset credits to use in the progress bar.

Definition at line 51 of file StelSkyPolygon.hpp.

ServerCredits StelSkyPolygon::getServerCredits ( ) const

inline

Return the server credits to use in the progress bar.

Definition at line 54 of file StelSkyPolygon.hpp.

virtual void StelSkyPolygon::loadFromQVariantMap ( const QVariantMap &  map )

protectedvirtual

Load the polygon from a valid QVariantMap.

Implements MultiLevelJsonBase.

QVariantMap StelSkyPolygon::toQVariantMap

(

)

const

Convert the polygon informations to a map following the JSON structure.

It can be saved as JSON using the StelJsonParser methods.

Member Data Documentation

DataSetCredits StelSkyPolygon::dataSetCredits

protected

The credits for the data set.

Definition at line 68 of file StelSkyPolygon.hpp.

float StelSkyPolygon::minResolution

protected

Minimum resolution at which the next level needs to be loaded in degree/pixel.

Definition at line 62 of file StelSkyPolygon.hpp.

ServerCredits StelSkyPolygon::serverCredits

protected

The credits of the server where this data come from.

Definition at line 65 of file StelSkyPolygon.hpp.

QList<SphericalConvexPolygon> StelSkyPolygon::skyConvexPolygons

protected

Direction of the vertices of the convex hull in ICRS frame.

Definition at line 71 of file StelSkyPolygon.hpp.

---

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

• core/StelSkyPolygon.hpp