Stellarium 0.13.0
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
StelSkyImageTile Class Reference

Base class for any astro image with a fixed position. More...

#include <StelSkyImageTile.hpp>

Public Member Functions

 StelSkyImageTile ()
 Default constructor. More...
 
 StelSkyImageTile (const QString &url, StelSkyImageTile *parent=NULL)
 Constructor. More...
 
 StelSkyImageTile (const QVariantMap &map, StelSkyImageTile *parent)
 Constructor. More...
 
 ~StelSkyImageTile ()
 Destructor. More...
 
void draw (StelCore *core, StelPainter &sPainter, 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...
 
bool isReadyToDisplay () const
 Return true if the tile is fully loaded and can be displayed. More...
 
QVariantMap toQVariantMap () const
 Convert the image informations to a map following the JSON structure. More...
 
QString getAbsoluteImageURI () const
 Return the absolute path/URL to the image file. More...
 
virtual QString getLayerDescriptionHtml () const
 Return an HTML description of the image to be displayed in the GUI. 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...
 
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)
 Reimplement the abstract method. 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

ServerCredits serverCredits
 The credits of the server where this data come from. More...
 
DataSetCredits dataSetCredits
 The credits for the data set. More...
 
QString absoluteImageURI
 URL where the image is located. More...
 
float luminance
 The image luminance in cd/m^2. More...
 
bool alphaBlend
 Whether the texture must be blended. More...
 
bool noTexture
 True if the tile is just a list of other tiles without texture for itself. More...
 
QList< SphericalRegionPskyConvexPolygons
 list of all the polygons. More...
 
StelTextureSP tex
 The texture of the tile. More...
 
float minResolution
 Minimum resolution of the data of the texture in degree/pixel. 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 astro image with a fixed position.

Definition at line 64 of file StelSkyImageTile.hpp.

Constructor & Destructor Documentation

StelSkyImageTile::StelSkyImageTile ( )

Default constructor.

StelSkyImageTile::StelSkyImageTile ( const QString &  url,
StelSkyImageTile parent = NULL 
)

Constructor.

StelSkyImageTile::StelSkyImageTile ( const QVariantMap &  map,
StelSkyImageTile parent 
)

Constructor.

StelSkyImageTile::~StelSkyImageTile ( )

Destructor.

Member Function Documentation

void StelSkyImageTile::draw ( StelCore core,
StelPainter sPainter,
float  opacity = 1. 
)
virtual

Draw the image on the screen.

Implements StelSkyLayer.

QString StelSkyImageTile::getAbsoluteImageURI ( ) const
inline

Return the absolute path/URL to the image file.

Definition at line 99 of file StelSkyImageTile.hpp.

DataSetCredits StelSkyImageTile::getDataSetCredits ( ) const
inline

Return the dataset credits to use in the progress bar.

Definition at line 86 of file StelSkyImageTile.hpp.

virtual QString StelSkyImageTile::getLayerDescriptionHtml ( ) const
inlinevirtual

Return an HTML description of the image to be displayed in the GUI.

Reimplemented from StelSkyLayer.

Definition at line 102 of file StelSkyImageTile.hpp.

ServerCredits StelSkyImageTile::getServerCredits ( ) const
inline

Return the server credits to use in the progress bar.

Definition at line 89 of file StelSkyImageTile.hpp.

bool StelSkyImageTile::isReadyToDisplay ( ) const

Return true if the tile is fully loaded and can be displayed.

virtual void StelSkyImageTile::loadFromQVariantMap ( const QVariantMap &  map)
protectedvirtual

Reimplement the abstract method.

Load the tile from a valid QVariantMap.

Implements MultiLevelJsonBase.

QVariantMap StelSkyImageTile::toQVariantMap ( ) const

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

It can be saved as JSON using the StelJsonParser methods.

Member Data Documentation

QString StelSkyImageTile::absoluteImageURI
protected

URL where the image is located.

Definition at line 116 of file StelSkyImageTile.hpp.

bool StelSkyImageTile::alphaBlend
protected

Whether the texture must be blended.

Definition at line 122 of file StelSkyImageTile.hpp.

DataSetCredits StelSkyImageTile::dataSetCredits
protected

The credits for the data set.

Definition at line 113 of file StelSkyImageTile.hpp.

float StelSkyImageTile::luminance
protected

The image luminance in cd/m^2.

Definition at line 119 of file StelSkyImageTile.hpp.

float StelSkyImageTile::minResolution
protected

Minimum resolution of the data of the texture in degree/pixel.

Definition at line 134 of file StelSkyImageTile.hpp.

bool StelSkyImageTile::noTexture
protected

True if the tile is just a list of other tiles without texture for itself.

Definition at line 125 of file StelSkyImageTile.hpp.

ServerCredits StelSkyImageTile::serverCredits
protected

The credits of the server where this data come from.

Definition at line 110 of file StelSkyImageTile.hpp.

QList<SphericalRegionP> StelSkyImageTile::skyConvexPolygons
protected

list of all the polygons.

Definition at line 128 of file StelSkyImageTile.hpp.

StelTextureSP StelSkyImageTile::tex
protected

The texture of the tile.

Definition at line 131 of file StelSkyImageTile.hpp.


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