StelCore: reduce confusion around location signals

guide/app_config_ini.tex

@@ -629,7 +629,7 @@ \subsection{\big[navigation\big]}
                                            or \emph{Preset} (start at time defined by preset\_sky\_time)\\%\midrule
 flag\_enable\_zoom\_keys        & bool   & Set to \emph{false} if you want to disable the zoom\\%\midrule
 flag\_manual\_zoom              & bool   & Set to \emph{false} for normal zoom behaviour as described in this guide. 
-                                           When set to true, the auto zoom feature only moves in a small amount and must be pressed many times\\%\midrule
+                                           When set to \emph{true}, the auto zoom feature only moves in a small amount and must be pressed many times\\%\midrule
 flag\_enable\_move\_keys        & bool   & Set to \emph{false} if you want to disable the arrow keys\\%\midrule
 flag\_enable\_mouse\_navigation & bool   & Set to \emph{false} if you want to disable the mouse pan (drag).\\%\midrule
 flag\_enable\_mouse\_zooming & bool   & Set to \emph{false} if you want to disable the mouse zooming (mousewheel).\\%\midrule
@@ -646,7 +646,6 @@ \subsection{\big[navigation\big]}
 zoom\_speed                     & float  & Sets the zoom speed\\%\midrule
 viewing\_mode                   & string & If set to \emph{horizon}, the viewing mode simulate an alt/azi mount, 
                                            if set to \emph{equator}, the viewing mode simulates an equatorial mount\\%\midrule
-flag\_manual\_zoom              & bool   & Set to \emph{true} if you want to auto-zoom in incrementally.\\%\midrule
 auto\_zoom\_out\_resets\_direction & bool & Set to \emph{true} if you want to auto-zoom restoring direction.\\%\midrule
 time\_correction\_algorithm     & string & Algorithm of DeltaT correction.\\\bottomrule %% TODO: list values! And write ref. chapter!
 \end{longtable}
@@ -952,7 +951,9 @@ \subsection{\big[viewing\big]}
 flag\_night                        & bool  & Enable night mode (red-only mode) on startup\\\midrule
 light\_pollution\_luminance        & float & Sets the level of the light pollution simulation\\\midrule %% TODO: WHAT IS THIS?
 use\_luminance\_adaptation         & bool  & Enable dynamic eye adaptation\\\midrule %% TODO: DESCRIBE!
-sky\_brightness\_label\_threshold  & float & Sky brightness [$cd/m^2$] to show infotext in black \\ %% 
+sky\_brightness\_label\_threshold  & float & Sky brightness [$cd/m^2$] to show infotext in black \\\midrule  %% 
+flag\_landscape\_autoselection     & bool  & load fitting landscape after changing planet (use \emph{zero} landscape when no fitting found).\\
+flag\_environment\_auto\_enable    & bool  & Enable/disable atmosphere, fog and cardinals for observer location when switching planet.\\
 \bottomrule
 \end{longtable}
 

guide/ch_interface.tex

@@ -61,7 +61,7 @@ \section{Setting Your Location}
 \label{sec:gui:location}
 
 \begin{figure}[htbp]
-\centering\includegraphics[width=0.75\textwidth]{location_dialog.png}
+\centering\includegraphics[width=0.85\textwidth]{location_dialog.png}
 \caption{Location window}
 \label{fig:gui:location}
 \end{figure}
@@ -113,6 +113,16 @@ \section{Setting Your Location}
 ``use as default'' checkbox, disable ``Get location from Network'',
 and close the location window.
 
+Two settings may influence the Landscape when changing locations:
+\begin{description}
+\item[Auto select landscapes] When changing the planet, 
+a fitting landscape panorama will be shown when available. 
+Also, \newFeature{23.2} when clicking on the earth map, 
+a zero-altitude landscape is displayed in the approximate color of that location (taken from the map).
+\item[Auto-enable atmosphere] When changing planet during
+  location change, the atmosphere will be switched as required.
+\end{description}
+
 \subsection{Time Zones}
 \label{sec:gui:location:timezones}
 Locations in Stellarium's location database include their respective
@@ -337,8 +347,6 @@ \subsection{The Tools Tab}
 \item[Select single constellation] When active, clicking on a star
   that is member in the constellation lines will make the
   constellation stand out. See section~\ref{sec:starlore:singleConstellations} for details.
-\item[Auto-enabling for the environment] When changing planet during
-  location change, atmosphere will be switched as required.
 \item[Dithering] options to allow select better simulation of sky on different hardware.
 \item[Auto zoom out returns to initial direction of view] When enabled,
   this option changes the behavior of the zoom out key
@@ -363,8 +371,6 @@ \subsection{The Tools Tab}
   Usually it should be enabled. (See~\ref{sec:Concepts:Parallax:Topocentric})
 \item[Include nutation] Compute the slight wobble of earth's
   axis. This feature is active only about 500 years around J2000.0.
-\item[Auto select landscapes] When changing the planet in the location
-  panel, a fitting landscape panorama will be shown when available.
 \item[Indication for mount mode] You can activate the short display of a message when switching type of used mount.
 \item[Edit keyboard shortcuts\ldots] See section~\ref{sec:gui:help:hotkeys}.
 \item[Mouse cursor timeout] You can decide whether, and when, the

plugins/RemoteSync/src/SyncClientHandlers.cpp

@@ -208,7 +208,7 @@ bool ClientLocationHandler::handleMessage(QDataStream &stream, SyncProtocol::tPa
 		//create a normal observer
 		core->setObserver(new StelObserver(msg.stelLocation));
 	}
-	emit core->targetLocationChanged(msg.stelLocation);
+	emit core->targetLocationChanged(msg.stelLocation, QString());
 	emit core->locationChanged(core->getCurrentLocation());
 
 

plugins/RemoteSync/src/SyncServerEventSenders.cpp

@@ -59,7 +59,8 @@ Time TimeEventSender::constructMessage()
 
 LocationEventSender::LocationEventSender()
 {
-	connect(core,SIGNAL(targetLocationChanged(StelLocation)), this, SLOT(reactToStellariumEvent()));
+	//connect(core,&StelCore::targetLocationChanged, this, &LocationEventSender::reactToStellariumEvent);
+	connect(core,&StelCore::locationChanged, this, &LocationEventSender::reactToStellariumEvent);
 }
 
 Location LocationEventSender::constructMessage()

src/core/StelCore.cpp

@@ -1091,7 +1091,9 @@ void StelCore::returnToDefaultLocation()
 	StelLocationMgr& locationMgr = StelApp::getInstance().getLocationMgr();
 	StelLocation loc = locationMgr.locationForString(defaultLocationID);
 	if (loc.isValid())
-		moveObserverTo(loc, 0.);
+		moveObserverTo(loc, 1., 2.);
+	else
+		qDebug() << "StelCore::returnToDefaultLocation: Location " << loc.serializeToLine().replace('\t', '|') << "is invalid. Store an entry from the locations list as default location.";
 }
 
 void StelCore::returnToHome()
@@ -1231,7 +1233,7 @@ void StelCore::moveObserverToSelected()
 				if (!results.isEmpty())
 					loc = results.value(results.firstKey()); // ...and use it!
 
-				moveObserverTo(loc);
+				moveObserverTo(loc, 1, 1, pl->getEnglishName());
 			}
 		}
 		else
@@ -1240,15 +1242,10 @@ void StelCore::moveObserverToSelected()
 			if (ni)
 			{
 				// We need to move to the nomenclature item's host planet.
-				StelLocation loc; //  = getCurrentLocation();
-				loc.planetName = ni->getPlanet()->getEnglishName();
-				loc.name=ni->getEnglishName();
-				loc.state = "";
-				loc.setLongitude(ni->getLongitude());
-				loc.setLatitude(ni->getLatitude());
-				loc.lightPollutionLuminance = 0;
+				StelLocation loc(ni->getEnglishName(), "", "", ni->getPlanet()->getEnglishName(), ni->getLongitude(), ni->getLatitude(), 0, 0, getCurrentTimeZone(), 1, 'X', ni->getPlanet()->getEnglishName());
+				loc.lightPollutionLuminance = 0; // be dead sure it's zero!
 
-				moveObserverTo(loc);
+				moveObserverTo(loc, 1, 1, pl->getEnglishName());
 				objmgr->unSelect(); // no use to keep it: Marker will flicker around the screen.
 			}
 		}
@@ -1285,7 +1282,8 @@ void StelCore::setObserver(StelObserver *obs)
 // Smoothly move the observer to the given location
 void StelCore::moveObserverTo(const StelLocation& target, double duration, double durationIfPlanetChange, const QString &landscapeID)
 {
-	double d = (getCurrentLocation().planetName==target.planetName) ? duration : durationIfPlanetChange;
+	const double d = (getCurrentLocation().planetName==target.planetName) ? duration : durationIfPlanetChange;
+	//qDebug() << "StelCore::moveObserverTo" << target.name << "in" << d << "seconds with Landscape" << landscapeID ;
 	if (d>0.)
 	{
 		StelLocation curLoc = getCurrentLocation();
@@ -1321,7 +1319,7 @@ void StelCore::moveObserverTo(const StelLocation& target, double duration, doubl
 			}
 		}
 	}
-	emit targetLocationChanged(target, landscapeID);
+	emit targetLocationChanged(target, landscapeID); // inform others about our next location. E.g., let LandscapeMgr load a new landscape.
 	emit locationChanged(getCurrentLocation());
 }
 
@@ -2021,7 +2019,9 @@ void StelCore::updateTime(double deltaTime)
 		position = newObs;
 	}
 	if (position->update(deltaTime))
+	{
 		emit locationChanged(getCurrentLocation());
+	}
 
 	// Position of sun and all the satellites (ie planets)
 	// GZ maybe setting this static can speedup a bit?

src/core/StelCore.hpp

@@ -793,8 +793,9 @@ public slots:
 signals:
 	//! This signal is emitted when the observer location has changed.
 	void locationChanged(const StelLocation&);
-	//! This signal is emitted whenever the targeted location changes. The second parameter can transmit a landscapeID.
-	void targetLocationChanged(const StelLocation&, const QString& = QString());
+	//! This signal is emitted whenever the targeted location changes, i.e., at the onset of location transitions.
+	//! The second parameter can transmit a landscapeID or should be QString().
+	void targetLocationChanged(const StelLocation& loc, const QString& id);
 	//! This signal is emitted when the current timezone name is changed.
 	void currentTimeZoneChanged(const QString& tz);
 	//! This signal is emitted when custom timezone use is activated (true) or deactivated (false).

src/core/StelLocation.cpp

@@ -57,6 +57,14 @@ StelLocation::StelLocation(const QString &lName, const QString &lState, const QS
 {
 }
 
+StelLocation::StelLocation(const QString &lName, const QString &lState, const QString &lRegion, const QString &plName, const float lng, const float lat, const int alt,
+						   const int populationK, const QString &timeZone, const int bortleIndex, const QChar roleKey, const QString &landscapeID)
+	: StelLocation(lName, lState, lRegion, lng, lat, alt, populationK, timeZone, bortleIndex, roleKey, landscapeID)
+{
+	planetName=plName;
+}
+
+
 // Output the location as a string ready to be stored in the user_location file
 QString StelLocation::serializeToLine() const
 {

src/core/StelLocation.hpp

@@ -31,10 +31,11 @@ class StelLocation
 {
 public:
 	StelLocation() : altitude(0), population(0), role('X'), isUserLocation(true), longitude(0.f), latitude(0.f) {}
-	//! constructor for ad-hoc locations.
+	//! constructors for ad-hoc locations. The first, shorter version is only for earth locations
 	//! @arg lName location name
 	//! @arg lState may be usedful if region has more than one such name
 	//! @arg lRegion must be the long name of UN UM49 only! (E.g., "Western Europe")
+	//! @arg plName planetName. This must be identical to the englishName of a solar system object.
 	//! @arg lng geographical longitude, east-positive, degrees
 	//! @arg lat geographical latitude, north-positive, degrees
 	//! @arg alt altitude above mean sea level
@@ -45,6 +46,8 @@ class StelLocation
 	//! @arg landscapeID a fitting landscape
 	StelLocation(const QString &lName, const QString &lState, const QString &lRegion, const float lng, const float lat, const int alt,
 				 const int populationK, const QString &timeZone, const int bortleIndex, const QChar roleKey='X', const QString &landscapeID=QString());
+	StelLocation(const QString &lName, const QString &lState, const QString &lRegion, const QString &plName, const float lng, const float lat, const int alt,
+							   const int populationK, const QString &timeZone, const int bortleIndex, const QChar roleKey, const QString &landscapeID);
 
 	//! Return a short string which can be used in a list view.
 	QString getID() const;

src/core/StelLocationMgr.cpp

@@ -17,11 +17,13 @@
  */
 
 #include "StelLocationMgr.hpp"
+#include "SolarSystem.hpp"
 #include "StelLocationMgr_p.hpp"
 
 #include "StelApp.hpp"
 #include "StelCore.hpp"
 #include "StelFileMgr.hpp"
+#include "StelModuleMgr.hpp"
 #include "StelUtils.hpp"
 #include "StelJsonParser.hpp"
 
@@ -491,6 +493,10 @@ StelLocationMgr::StelLocationMgr()
 #endif
 	// Init to Paris France because it's the center of the world.
 	lastResortLocation = locationForString(conf->value("init_location/last_location", "Paris, Western Europe").toString());
+
+	planetName="Earth";
+	planetSurfaceMap=QImage(":/graphicGui/miscWorldMap.jpg");
+	connect(StelApp::getInstance().getCore(), SIGNAL(locationChanged(StelLocation)), this, SLOT(changePlanetMapForLocation(StelLocation)));
 }
 
 StelLocationMgr::~StelLocationMgr()
@@ -1075,8 +1081,8 @@ void StelLocationMgr::changeLocationFromGPSQuery(const StelLocation &locin)
 	loc.name=QString("GPS %1%2 %3%4")
 		.arg(loc.getLatitude()<0?"S":"N").arg(qRound(abs(loc.getLatitude())))
 		.arg(loc.getLongitude()<0?"W":"E").arg(qRound(abs(loc.getLongitude())));
-
-	core->moveObserverTo(loc, 0.0, 0.0);
+	QColor color=getColorForCoordinates(loc.getLongitude(), loc.getLatitude());
+	core->moveObserverTo(loc, 0.0, 0.0, QString("ZeroColor(%1)").arg(Vec3f(color).toStr()));
 	if (nmeaHelper)
 	{
 		if (verbose)
@@ -1154,15 +1160,17 @@ void StelLocationMgr::changeLocationFromNetworkLookup()
 			// Ensure that ipTimeZone is a valid IANA timezone name!
 			QTimeZone ipTZ(ipTimeZone.toUtf8());
 			core->setCurrentTimeZone( !ipTZ.isValid() || ipTimeZone.isEmpty() ? "LMST" : ipTimeZone);
-			core->moveObserverTo(loc, 0.0, 0.0);
+			QColor color=getColorForCoordinates(loc.getLongitude(), loc.getLatitude());
+			core->moveObserverTo(loc, 0.0, 0.0, QString("ZeroColor(%1)").arg(Vec3f(color).toStr()));
+
 			QSettings* conf = StelApp::getInstance().getSettings();
 			conf->setValue("init_location/last_location", QString("%1, %2").arg(latitude).arg(longitude));
 		}
 		catch (const std::exception& e)
 		{
 			qDebug() << "Failure getting IP-based location: answer is in not acceptable format! Error: " << e.what()
 					<< "\nLet's use Paris, France as default location...";
-			core->moveObserverTo(getLastResortLocation(), 0.0, 0.0); // Answer is not in JSON format! A possible block by DNS server or firewall
+			core->moveObserverTo(getLastResortLocation(), 0.0, 0.0, "guereins"); // Answer is not in JSON format! A possible block by DNS server or firewall
 		}
 	}
 	else
@@ -1173,7 +1181,7 @@ void StelLocationMgr::changeLocationFromNetworkLookup()
 	networkReply->deleteLater();
 }
 
-LocationMap StelLocationMgr::pickLocationsNearby(const QString planetName, const float longitude, const float latitude, const float radiusDegrees)
+LocationMap StelLocationMgr::pickLocationsNearby(const QString &planetName, const float longitude, const float latitude, const float radiusDegrees)
 {
 	QMap<QString, StelLocation> results;
 	QMapIterator<QString, StelLocation> iter(locations);
@@ -1190,7 +1198,7 @@ LocationMap StelLocationMgr::pickLocationsNearby(const QString planetName, const
 	return results;
 }
 
-LocationMap StelLocationMgr::pickLocationsInRegion(const QString region)
+LocationMap StelLocationMgr::pickLocationsInRegion(const QString &region)
 {
 	QMap<QString, StelLocation> results;
 	QMapIterator<QString, StelLocation> iter(locations);
@@ -1324,13 +1332,13 @@ QStringList StelLocationMgr::getRegionNames(const QString& planet) const
 	return allregions;
 }
 
-QString StelLocationMgr::pickRegionFromCountryCode(const QString countryCode)
+QString StelLocationMgr::pickRegionFromCountryCode(const QString &countryCode)
 {
 	QMap<QString, QString>::ConstIterator i = countryCodeToRegionMap.find(countryCode);
 	return (i!=countryCodeToRegionMap.constEnd()) ? i.value() : QString();
 }
 
-QString StelLocationMgr::pickRegionFromCountry(const QString country)
+QString StelLocationMgr::pickRegionFromCountry(const QString &country)
 {
 	QMap<QString, QString>::ConstIterator i = countryNameToCodeMap.find(country);
 	QString code = (i!=countryNameToCodeMap.constEnd()) ? i.value() : QString();
@@ -1556,3 +1564,38 @@ QStringList StelLocationMgr::getAllTimezoneNames() const
 	ret.sort();
 	return ret;
 }
+
+// To be connected from StelCore::locationChanged(loc)
+void StelLocationMgr::changePlanetMapForLocation(StelLocation loc)
+{
+	if (loc.planetName==planetName)
+		return;
+
+	planetName=loc.planetName;
+	if (planetName=="Earth")
+		planetSurfaceMap=QImage(":/graphicGui/miscWorldMap.jpg");
+	else
+	{
+		SolarSystem *ssm=GETSTELMODULE(SolarSystem);
+		PlanetP p=ssm->searchByEnglishName(loc.planetName); // nullptr for "SpaceShip" transitions
+		QString mapName="textures/" + (p ? p->getTextMapName() : planetName) + ".png";
+
+		if (!planetSurfaceMap.load(StelFileMgr::findFile(mapName, StelFileMgr::File)))
+		{
+			// texture not found. Use a gray pixel.
+			planetSurfaceMap=QImage(16,16,QImage::Format_RGB32);
+			planetSurfaceMap.fill(QColor(64, 64, 64));
+		}
+	}
+}
+
+QColor StelLocationMgr::getColorForCoordinates(const double lng, const double lat) const
+{
+	QPoint imgPoint( (lng+180.)/ 360. * planetSurfaceMap.width(),
+			 (90.-lat) / 180. * planetSurfaceMap.height());
+
+	// Sample the map pixel color. Use a small box to avoid 1-pixel surprises.
+	QImage sampledPix=planetSurfaceMap.copy(QRect(imgPoint-QPoint(1,1), QSize(2,2))).scaled(1,1);
+	return sampledPix.pixelColor(0,0);
+
+}

src/core/StelLocationMgr.hpp

@@ -24,6 +24,7 @@
 #include <QObject>
 #include <QMetaType>
 #include <QMap>
+#include <QImage>
 #ifdef Q_OS_WIN
 #include <QtPositioning/QGeoPositionInfoSource>
 #endif
@@ -91,17 +92,17 @@ class StelLocationMgr : public QObject
 	bool deleteUserLocation(const QString& id);
 
 	//! Find list of locations within @param radiusDegrees of selected (usually screen-clicked) coordinates.
-	LocationMap pickLocationsNearby(const QString planetName, const float longitude, const float latitude, const float radiusDegrees);
+	LocationMap pickLocationsNearby(const QString& planetName, const float longitude, const float latitude, const float radiusDegrees);
 	//! Find list of locations in a particular region only.
-	LocationMap pickLocationsInRegion(const QString region);
+	LocationMap pickLocationsInRegion(const QString& region);
 
 	//! return a QStringList of region names by planet (return all list of regions if planet name is empty)
 	QStringList getRegionNames(const QString& planet = "") const;
 
 	//! Pick region name from ISO 3166-1 two-letter country codes
-	static QString pickRegionFromCountryCode(const QString countryCode);
+	static QString pickRegionFromCountryCode(const QString& countryCode);
 	//! Pick region name from country English name
-	static QString pickRegionFromCountry(const QString country);
+	static QString pickRegionFromCountry(const QString& country);
 	//! Pick region name from region code
 	static QString pickRegionFromCode(int regionCode);
 
@@ -136,6 +137,9 @@ public slots:
 	//! return a QStringList of valid timezone names in Stellarium's location database.
 	QStringList getAllTimezoneNames() const;
 
+	//! Retrieve a color from coordinate lookup into the current planet texture (or specialized earth map)
+	QColor getColorForCoordinates(const double lng, const double lat) const;
+
 #ifdef ENABLE_GPS
 	//! Try to get a location from GPS lookup.
 	//! This prefers GPSD on non-Windows platforms, and uses Qt positioning with a NMEA serial device otherwise
@@ -171,6 +175,8 @@ public slots:
 private slots:
 	//! Process answer from online lookup of IP address
 	void changeLocationFromNetworkLookup();
+	//! To be connected from StelCore::locationChanged(loc)
+	void changePlanetMapForLocation(StelLocation loc);
 #ifdef ENABLE_GPS
 	void changeLocationFromGPSQuery(const StelLocation& loc);
 	void gpsQueryError(const QString& err);
@@ -206,6 +212,12 @@ private slots:
 
 	StelLocation lastResortLocation;
 
+	//! Used to sample a color from our current planet's surface map.
+	//! This must be kept in-sync with the map shown in the LocationDialog.
+	QImage planetSurfaceMap;
+	//! Auxiliary to the surface map. This tracks whether we actually have to load a new image.
+	QString planetName;
+
 	GPSLookupHelper *nmeaHelper,*libGpsHelper;
 #ifdef Q_OS_WIN
 	QGeoPositionInfoSource *positionSource=Q_NULLPTR;