add drawing modes

Author: xLPMG

plugins/SkyCultureMaker/src/ScmConstellation.cpp

@@ -26,9 +26,10 @@
 #include <QFileInfo>
 
 scm::ScmConstellation::ScmConstellation(const std::vector<scm::CoordinateLine> &coordinates,
-                                        const std::vector<scm::StarLine> &stars)
+                                        const std::vector<scm::StarLine> &stars, const bool isDarkConstellation)
 	: coordinates(coordinates)
 	, stars(stars)
+	, isDarkConstellation(isDarkConstellation)
 {
 	QSettings *conf = StelApp::getInstance().getSettings();
 	constellationNameFont.setPixelSize(conf->value("viewing/constellation_font_size", 15).toInt());
@@ -109,12 +110,12 @@ void scm::ScmConstellation::setConstellation(const std::vector<CoordinateLine> &
 	updateTextPosition();
 }
 
-const std::vector<scm::CoordinateLine>& scm::ScmConstellation::getCoordinates() const
+const std::vector<scm::CoordinateLine> &scm::ScmConstellation::getCoordinates() const
 {
 	return coordinates;
 }
 
-const std::vector<scm::StarLine>& scm::ScmConstellation::getStars() const
+const std::vector<scm::StarLine> &scm::ScmConstellation::getStars() const
 {
 	return stars;
 }
@@ -198,17 +199,17 @@ QJsonObject scm::ScmConstellation::toJson(const QString &skyCultureId) const
 	// Assemble lines object
 	QJsonArray linesArray;
 
-	if (stars.size() != 0)
+	if (!isDarkConstellation)
 	{
-		// Stars are NOT empty
+		// not a dark constellation, so we can add stars
 		for (const auto &star : stars)
 		{
 			linesArray.append(star.toJson());
 		}
 	}
 	else
 	{
-		// Stars are empty, use the coordinates
+		// dark constellation, so only add coordinates
 		for (const auto &coord : coordinates)
 		{
 			linesArray.append(coord.toJson());
@@ -220,7 +221,7 @@ QJsonObject scm::ScmConstellation::toJson(const QString &skyCultureId) const
 	if (artwork.getHasArt() && !artworkPath.isEmpty())
 	{
 		QFileInfo fileInfo(artworkPath);
-		// the '/' separator is default in all skycultures
+		// the '/' separator is default in all sky cultures
 		json["image"] = artwork.toJson("illustrations/" + fileInfo.fileName());
 	}
 

plugins/SkyCultureMaker/src/ScmConstellation.hpp

@@ -42,7 +42,11 @@ namespace scm
 class ScmConstellation
 {
 public:
-	ScmConstellation(const std::vector<CoordinateLine> &coordinates, const std::vector<StarLine> &stars);
+	ScmConstellation(const std::vector<CoordinateLine> &coordinates, const std::vector<StarLine> &stars,
+	                 bool isDarkConstellation = false)
+		: coordinates(coordinates)
+		, stars(stars)
+		, isDarkConstellation(isDarkConstellation) {};
 
 	/// The frame that is used for calculation and is drawn on.
 	static const StelCore::FrameType drawFrame = StelCore::FrameJ2000;
@@ -258,6 +262,9 @@ class ScmConstellation
 	/// Whether the constellation should be drawn or not.
 	bool isHidden = false;
 
+	/// Indicates if the constellation is a dark constellation.
+	bool isDarkConstellation = false;
+
 	/**
 	 * @brief Updates the XYZname that is used for the text position.
 	 */

plugins/SkyCultureMaker/src/ScmDraw.cpp

@@ -123,7 +123,7 @@ bool scm::ScmDraw::segmentIntersect(const Vec2d &startA, const Vec2d &directionA
 
 scm::ScmDraw::ScmDraw()
 	: drawState(Drawing::None)
-	, snapToStar(true)
+	, drawingMode(DrawingMode::StarsAndDSO)
 {
 	std::get<CoordinateLine>(currentLine).start.set(0, 0, 0);
 	std::get<CoordinateLine>(currentLine).end.set(0, 0, 0);
@@ -191,46 +191,48 @@ void scm::ScmDraw::handleMouseClicks(class QMouseEvent *event)
 		// Draw line
 		if (event->button() == Qt::RightButton && event->type() == QEvent::MouseButtonPress)
 		{
-			StelApp &app       = StelApp::getInstance();
-			StelCore *core     = app.getCore();
-			StelProjectorP prj = core->getProjection(drawFrame);
-			Vec3d point;
-			std::optional<QString> starID;
-			prj->unProject(x, y, point);
-
-			// We want to combine any near start point to an existing point so that we don't create
-			// duplicates.
-			std::optional<StarPoint> nearest = findNearestPoint(x, y, prj);
-			if (nearest.has_value())
-			{
-				point  = nearest.value().coordinate;
-				starID = nearest.value().star;
-			}
-			else if (snapToStar)
+			StelApp &app   = StelApp::getInstance();
+			StelCore *core = app.getCore();
+
+			if (drawingMode == DrawingMode::StarsAndDSO)
 			{
-				if (hasFlag(drawState, Drawing::hasEndExistingPoint))
-				{
-					point  = std::get<CoordinateLine>(currentLine).end;
-					starID = std::get<StarLine>(currentLine).end;
-				}
-				else
+				StelObjectMgr &objectMgr = app.getStelObjectMgr();
+				if (objectMgr.getWasSelected())
 				{
-					StelObjectMgr &objectMgr = app.getStelObjectMgr();
-
-					if (objectMgr.getWasSelected())
+					StelObjectP stelObj = objectMgr.getLastSelectedObject();
+					Vec3d stelPos       = stelObj->getJ2000EquatorialPos(core);
+					if (stelObj->getType() == "Star" || stelObj->getType() == "Nebula")
 					{
-						StelObjectP stelObj = objectMgr.getLastSelectedObject();
-						Vec3d stelPos       = stelObj->getJ2000EquatorialPos(core);
-						point               = stelPos;
-						if (stelObj->getType() == "Star")
+						QString stelObjID = stelObj->getID();
+						if (stelObjID.trimmed().isEmpty())
 						{
-							starID = stelObj->getID();
+							qDebug() << "SkyCultureMaker: Ignored sky object with empty ID";
+						}
+						else
+						{
+							appendDrawPoint(stelPos, stelObjID);
+							qDebug() << "SkyCultureMaker: Added sky object to "
+								    "constellation with ID "
+								 << stelObjID;
 						}
 					}
 				}
 			}
-
-			appendDrawPoint(point, starID);
+			else if (drawingMode == DrawingMode::Coordinates)
+			{
+				StelProjectorP prj = core->getProjection(drawFrame);
+				Vec3d point;
+				prj->unProject(x, y, point);
+
+				// We want to combine any near start point to an existing point so that we don't create
+				// duplicates.
+				std::optional<StarPoint> nearest = findNearestPoint(x, y, prj);
+				if (nearest.has_value())
+				{
+					point = nearest.value().coordinate;
+					appendDrawPoint(point, std::nullopt);
+				}
+			}
 
 			event->accept();
 			return;
@@ -272,16 +274,22 @@ bool scm::ScmDraw::handleMouseMoves(int x, int y, Qt::MouseButtons b)
 
 	if (activeTool == DrawTools::Pen)
 	{
-		if (snapToStar)
+		if (drawingMode == DrawingMode::StarsAndDSO)
 		{
 			// this wouldve been easier with cleverFind but that is private
 			StelObjectMgr &objectMgr = app.getStelObjectMgr();
 			bool found               = objectMgr.findAndSelect(core, x, y);
-			// only keep the selection if a star was selected
 			if (found && objectMgr.getWasSelected())
 			{
 				StelObjectP stelObj = objectMgr.getLastSelectedObject();
-				if (stelObj->getType() != "Star")
+				// only keep the selection if a star or nebula was selected
+				// and it has a valid id
+				if (stelObj->getType() != "Star" && stelObj->getType() != "Nebula")
+				{
+					objectMgr.unSelect();
+				}
+				// also unselect if the id is empty or only whitespace
+				else if (stelObj->getID().trimmed().isEmpty())
 				{
 					objectMgr.unSelect();
 				}
@@ -293,26 +301,8 @@ bool scm::ScmDraw::handleMouseMoves(int x, int y, Qt::MouseButtons b)
 			StelProjectorP prj = core->getProjection(drawFrame);
 			Vec3d position;
 			prj->unProject(x, y, position);
-			if (snapToStar)
-			{
-				StelObjectMgr &objectMgr = app.getStelObjectMgr();
-				if (objectMgr.getWasSelected())
-				{
-					StelObjectP stelObj = objectMgr.getLastSelectedObject();
-					Vec3d stelPos       = stelObj->getJ2000EquatorialPos(core);
-					std::get<CoordinateLine>(currentLine).end = stelPos;
-				}
-				else
-				{
-					std::get<CoordinateLine>(currentLine).end = position;
-				}
-			}
-			else
-			{
-				std::get<CoordinateLine>(currentLine).end = position;
-			}
-
-			drawState = Drawing::hasFloatingEnd;
+			std::get<CoordinateLine>(currentLine).end = position;
+			drawState                                 = Drawing::hasFloatingEnd;
 		}
 	}
 	else if (activeTool == DrawTools::Eraser)
@@ -368,13 +358,6 @@ void scm::ScmDraw::handleKeys(QKeyEvent *e)
 {
 	if (activeTool == DrawTools::Pen)
 	{
-		if (e->key() == Qt::Key::Key_Control)
-		{
-			snapToStar = e->type() != QEvent::KeyPress;
-
-			e->accept();
-		}
-
 		if (e->key() == Qt::Key::Key_Z && e->modifiers() == Qt::Modifier::CTRL)
 		{
 			undoLastLine();

plugins/SkyCultureMaker/src/ScmDraw.hpp

@@ -30,6 +30,7 @@
 #include "enumBitops.hpp"
 #include "types/CoordinateLine.hpp"
 #include "types/DrawTools.hpp"
+#include "types/DrawingMode.hpp"
 #include "types/Drawing.hpp"
 #include "types/Lines.hpp"
 #include "types/StarLine.hpp"
@@ -57,8 +58,8 @@ class ScmDraw : public QObject
 	/// Indicates that the startPoint has been set.
 	Drawing drawState = Drawing::None;
 
-	/// Indicates if a line start or end will snap to the nearest star.
-	bool snapToStar = false;
+	/// The current drawing mode.
+	DrawingMode drawingMode = DrawingMode::StarsAndDSO;
 
 	/// The current pending point.
 	std::tuple<CoordinateLine, StarLine> currentLine;

plugins/SkyCultureMaker/src/gui/ScmConstellationDialog.hpp

@@ -94,15 +94,13 @@ private slots:
 		/// Help text on how to use the pen for Mac users.
 		const QString helpDrawInfoPen = "Use RightClick or Control + Click to draw a connected line.\n"
 						"Use Double-RightClick or Control + Double-Click to stop drawing the line.\n"
-						"Use Command to disable snap to stars.\n"
 						"Use Command + F to search and connect stars.";
 		/// Help text on how to use the eraser for Mac users.
 		const QString helpDrawInfoEraser = "Hold RightClick or Control + Click to delete the line under the cursor.\n";
 	#else
 		/// Help text on how to use the pen for non-Mac users.
 		const QString helpDrawInfoPen = "Use RightClick to draw a connected line.\n"
 						"Use Double-RightClick to stop drawing the line.\n"
-						"Use CTRL to disable snap to stars.\n"
 						"Use CTRL + F to search and connect stars.";
 		/// Help text on how to use the eraser for non-Mac users.
 		const QString helpDrawInfoEraser = "Hold RightClick to delete the line under the cursor.\n";

plugins/SkyCultureMaker/src/types/DrawingMode.hpp

@@ -0,0 +1,38 @@
+/*
+ * Sky Culture Maker plug-in for Stellarium
+ *
+ * Copyright (C) 2025 Vincent Gerlach
+ * Copyright (C) 2025 Luca-Philipp Grumbach
+ * Copyright (C) 2025 Fabian Hofer
+ * Copyright (C) 2025 Mher Mnatsakanyan
+ * Copyright (C) 2025 Richard Hofmann
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef SCM_TYPES_DRAWINGMODE_HPP
+#define SCM_TYPES_DRAWINGMODE_HPP
+
+namespace scm
+{
+
+enum class DrawingMode
+{
+	StarsAndDSO,
+    
+    Coordinates
+};
+} // namespace scm
+
+#endif

plugins/SkyCultureMaker/src/types/StarLine.hpp

@@ -45,7 +45,7 @@ struct StarLine
 	 * 
 	 * @param starId The ID of the star, which may contain identifiers like "HIP" or "Gaia DR3".
 	 */
-	static QString getStarIdNumber(QString starId)
+	static QString getStarId(QString starId)
 	{
 		QRegularExpression hipExpression(R"(HIP\s+(\d+))");
 		QRegularExpression gaiaExpression(R"(Gaia DR3\s+(\d+))");
@@ -60,7 +60,8 @@ struct StarLine
 		{
 			return gaiaMatch.captured(1);
 		}
-		return "-1";
+		// Neither HIP nor Gaia, return as DSO
+		return "DSO:" + starId.remove(' ');
 	}
 
 	/**
@@ -74,7 +75,7 @@ struct StarLine
 
 		if (start.has_value())
 		{
-			QString number = getStarIdNumber(start.value());
+			QString number = getStarId(start.value());
 
 			if (start.value().contains("HIP"))
 			{
@@ -83,7 +84,7 @@ struct StarLine
 			}
 			else
 			{
-				// Gaia is required as string
+				// Other ids are required as string
 				json.append(number);
 			}
 		}
@@ -94,7 +95,7 @@ struct StarLine
 
 		if (end.has_value())
 		{
-			QString number = getStarIdNumber(end.value());
+			QString number = getStarId(end.value());
 
 			if (end.value().contains("HIP"))
 			{
@@ -103,7 +104,7 @@ struct StarLine
 			}
 			else
 			{
-				// Gaia is required as string
+				// Other ids are required as string
 				json.append(number);
 			}
 		}