feat: edit constellations (#128)

Author: xLPMG

plugins/SkyCultureMaker/src/CMakeLists.txt

@@ -30,10 +30,10 @@ SET( SkyCultureMaker_SRCS
      gui/ScmConstellationDialog.cpp
      gui/ScmSkyCultureDialog.hpp
      gui/ScmSkyCultureDialog.cpp
-     gui/ScmImageAnchor.hpp
-     gui/ScmImageAnchor.cpp
-     gui/ScmImageAnchored.hpp
-     gui/ScmImageAnchored.cpp
+     gui/ScmConstellationImageAnchor.hpp
+     gui/ScmConstellationImageAnchor.cpp
+     gui/ScmConstellationImage.hpp
+     gui/ScmConstellationImage.cpp
      gui/ScmSkyCultureExportDialog.hpp
      gui/ScmSkyCultureExportDialog.cpp
      gui/ScmHideOrAbortMakerDialog.hpp

plugins/SkyCultureMaker/src/ScmConstellation.cpp

@@ -27,8 +27,8 @@
 
 scm::ScmConstellation::ScmConstellation(const std::vector<scm::CoordinateLine> &coordinates,
                                         const std::vector<scm::StarLine> &stars)
-	: constellationCoordinates(coordinates)
-	, constellationStars(stars)
+	: coordinates(coordinates)
+	, stars(stars)
 {
 	QSettings *conf = StelApp::getInstance().getSettings();
 	constellationNameFont.setPixelSize(conf->value("viewing/constellation_font_size", 15).toInt());
@@ -65,32 +65,66 @@ void scm::ScmConstellation::setNativeName(const std::optional<QString> &name)
 	nativeName = name;
 }
 
+std::optional<QString> scm::ScmConstellation::getNativeName() const
+{
+	return nativeName;
+}
+
 void scm::ScmConstellation::setPronounce(const std::optional<QString> &pronounce)
 {
 	ScmConstellation::pronounce = pronounce;
 }
 
+std::optional<QString> scm::ScmConstellation::getPronounce() const
+{
+	return pronounce;
+}
+
 void scm::ScmConstellation::setIPA(const std::optional<QString> &ipa)
 {
 	ScmConstellation::ipa = ipa;
 }
 
+std::optional<QString> scm::ScmConstellation::getIPA() const
+{
+	return ipa;
+}
+
 void scm::ScmConstellation::setArtwork(const ScmConstellationArtwork &artwork)
 {
 	ScmConstellation::artwork = artwork;
 }
 
+const scm::ScmConstellationArtwork &scm::ScmConstellation::getArtwork() const
+{
+	return artwork;
+}
+
 void scm::ScmConstellation::setConstellation(const std::vector<CoordinateLine> &coordinates,
                                              const std::vector<StarLine> &stars)
 {
-	constellationCoordinates = coordinates;
-	constellationStars       = stars;
+	scm::ScmConstellation::coordinates = coordinates;
+	scm::ScmConstellation::stars       = stars;
 
 	updateTextPosition();
 }
 
+const std::vector<scm::CoordinateLine>& scm::ScmConstellation::getCoordinates() const
+{
+	return coordinates;
+}
+
+const std::vector<scm::StarLine>& scm::ScmConstellation::getStars() const
+{
+	return stars;
+}
+
 void scm::ScmConstellation::drawConstellation(StelCore *core, const Vec3f &lineColor, const Vec3f &nameColor) const
 {
+	if (isHidden)
+	{
+		return;
+	}
 	StelPainter painter(core->getProjection(drawFrame));
 	painter.setBlending(true);
 	painter.setLineSmooth(true);
@@ -99,7 +133,7 @@ void scm::ScmConstellation::drawConstellation(StelCore *core, const Vec3f &lineC
 	bool alpha = 1.0f;
 	painter.setColor(lineColor, alpha);
 
-	for (CoordinateLine p : constellationCoordinates)
+	for (CoordinateLine p : coordinates)
 	{
 		painter.drawGreatCircleArc(p.start, p.end);
 	}
@@ -111,11 +145,20 @@ void scm::ScmConstellation::drawConstellation(StelCore *core, const Vec3f &lineC
 
 void scm::ScmConstellation::drawConstellation(StelCore *core) const
 {
+	if (isHidden)
+	{
+		return;
+	}
 	drawConstellation(core, defaultConstellationLineColor, defaultConstellationNameColor);
 }
 
 void scm::ScmConstellation::drawNames(StelCore *core, StelPainter &sPainter, const Vec3f &nameColor) const
 {
+	if (isHidden)
+	{
+		return;
+	}
+
 	sPainter.setBlending(true);
 
 	Vec3d velocityObserver(0.);
@@ -141,6 +184,11 @@ void scm::ScmConstellation::drawNames(StelCore *core, StelPainter &sPainter, con
 
 void scm::ScmConstellation::drawNames(StelCore *core, StelPainter &sPainter) const
 {
+	if (isHidden)
+	{
+		return;
+	}
+
 	drawNames(core, sPainter, defaultConstellationNameColor);
 }
 
@@ -151,18 +199,18 @@ QJsonObject scm::ScmConstellation::toJson(const QString &skyCultureId) const
 	// Assemble lines object
 	QJsonArray linesArray;
 
-	if (constellationStars.size() != 0)
+	if (stars.size() != 0)
 	{
 		// Stars are NOT empty
-		for (const auto &star : constellationStars)
+		for (const auto &star : stars)
 		{
 			linesArray.append(star.toJson());
 		}
 	}
 	else
 	{
 		// Stars are empty, use the coordinates
-		for (const auto &coord : constellationCoordinates)
+		for (const auto &coord : coordinates)
 		{
 			linesArray.append(coord.toJson());
 		}
@@ -223,10 +271,20 @@ bool scm::ScmConstellation::saveArtwork(const QString &directory)
 void scm::ScmConstellation::updateTextPosition()
 {
 	XYZname.set(0., 0., 0.);
-	for (CoordinateLine p : constellationCoordinates)
+	for (CoordinateLine p : coordinates)
 	{
 		XYZname += p.end;
 		XYZname += p.start;
 	}
 	XYZname.normalize();
 }
+
+void scm::ScmConstellation::hide()
+{
+	isHidden = true;
+}
+
+void scm::ScmConstellation::show()
+{
+	isHidden = false;
+}

plugins/SkyCultureMaker/src/ScmConstellation.hpp

@@ -82,27 +82,55 @@ class ScmConstellation
     */
 	void setNativeName(const std::optional<QString> &name);
 
+	/**
+	* @brief Gets the native name of the constellation
+	* 
+	* @return The native name
+	*/
+	std::optional<QString> getNativeName() const;
+
 	/**
     * @brief Sets the pronounciation of the constellation
     * 
     * @param pronounce The pronounciation
     */
 	void setPronounce(const std::optional<QString> &pronounce);
 
+	/**
+	 * @brief Gets the pronounciation of the constellation
+	 * 
+	 * @return The pronounciation
+	 */
+	std::optional<QString> getPronounce() const;
+
 	/**
     * @brief Sets the IPA.
     * 
     * @param ipa The optional ipa
 	 */
 	void setIPA(const std::optional<QString> &ipa);
 
+	/**
+	 * @brief Gets the IPA.
+	 * 
+	 * @return The optional ipa
+	 */
+	std::optional<QString> getIPA() const;
+
 	/**
 	 * @brief Sets the artwork.
 	 * 
 	 * @param artwork The artwork.
 	 */
 	void setArtwork(const ScmConstellationArtwork &artwork);
 
+	/**
+	 * @brief Gets the artwork.
+	 * 
+	 * @return The artwork.
+	 */
+	const ScmConstellationArtwork &getArtwork() const;
+
 	/**
     * @brief Sets the coordinate lines and star lines of the constellation.
     * 
@@ -111,6 +139,20 @@ class ScmConstellation
     */
 	void setConstellation(const std::vector<CoordinateLine> &coordinates, const std::vector<StarLine> &stars);
 
+	/**
+	 * @brief Gets the coordinates of the constellation.
+	 * 
+	 * @return The coordinates of the constellation.
+	 */
+	const std::vector<CoordinateLine> &getCoordinates() const;
+
+	/**
+	 * @brief Gets the stars of the constellation.
+	 * 
+	 * @return The stars of the constellation.
+	 */
+	const std::vector<StarLine> &getStars() const;
+
 	/**
 	 * @brief Draws the constellation based on the coordinates.
 	 *
@@ -160,6 +202,16 @@ class ScmConstellation
 	 */
 	bool saveArtwork(const QString &directory);
 
+	/**
+	 * @brief Hides the constellation from being drawn.
+	 */
+	void hide();
+
+	/**
+	 * @brief Enables the constellation to be drawn.
+	 */
+	void show();
+
 private:
 	/// Identifier of the constellation
 	QString id;
@@ -180,10 +232,10 @@ class ScmConstellation
 	std::optional<QVector<int>> references;
 
 	/// List of coordinates forming the segments.
-	std::vector<CoordinateLine> constellationCoordinates;
+	std::vector<CoordinateLine> coordinates;
 
 	/// List of stars forming the segments. Might be empty.
-	std::vector<StarLine> constellationStars;
+	std::vector<StarLine> stars;
 
 	/// Direction vector pointing on constellation name drawing position
 	Vec3d XYZname;
@@ -203,6 +255,9 @@ class ScmConstellation
 	/// Holds the path the artwork was saved to.
 	QString artworkPath;
 
+	/// Whether the constellation should be drawn or not.
+	bool isHidden = false;
+
 	/**
 	 * @brief Updates the XYZname that is used for the text position.
 	 */

plugins/SkyCultureMaker/src/ScmConstellationArtwork.cpp

@@ -72,8 +72,8 @@ void scm::ScmConstellationArtwork::setupArt()
 	// check for null pointers
 	if (s1obj.isNull() || s2obj.isNull() || s3obj.isNull())
 	{
-		qWarning() << "SkyCultureMaker: could not find stars:" << anchors[0].hip << ", " << anchors[1].hip << "or "
-			   << anchors[2].hip;
+		qWarning() << "SkyCultureMaker: could not find stars:" << anchors[0].hip << ", " << anchors[1].hip
+			   << "or " << anchors[2].hip;
 		return;
 	}
 
@@ -180,6 +180,12 @@ bool scm::ScmConstellationArtwork::getHasArt() const
 	return hasArt;
 }
 
+void scm::ScmConstellationArtwork::reset()
+{
+	hasArt  = false;
+	isSetup = false;
+}
+
 void scm::ScmConstellationArtwork::draw(StelCore *core) const
 {
 	const StelProjectorP prj = core->getProjection(StelCore::FrameJ2000);
@@ -254,16 +260,16 @@ bool scm::ScmConstellationArtwork::save(const QString &filepath) const
 	bool success = fileInfo.absoluteDir().mkpath(fileInfo.absolutePath());
 	if (success == false)
 	{
-		qWarning() << "SkyCultureMaker: Failed to create the directory structure for: '" << fileInfo.absolutePath()
-			   << "'";
+		qWarning() << "SkyCultureMaker: Failed to create the directory structure for: '"
+			   << fileInfo.absolutePath() << "'";
 		return false;
 	}
 
 	success = artwork.save(fileInfo.absoluteFilePath());
 	if (success == false)
 	{
-		qWarning() << "SkyCultureMaker: Failed to save the image to the given path: '" << fileInfo.absoluteFilePath()
-			   << "'";
+		qWarning() << "SkyCultureMaker: Failed to save the image to the given path: '"
+			   << fileInfo.absoluteFilePath() << "'";
 		return false;
 	}
 

plugins/SkyCultureMaker/src/ScmConstellationArtwork.hpp

@@ -114,6 +114,11 @@ class ScmConstellationArtwork
 	 */
 	bool save(const QString &filepath) const;
 
+	/**
+	 * @brief Resets the artwork state.
+	 */
+	void reset();
+
 private:
 	/**
      * @brief Draw the artwork in an optimized manner.

plugins/SkyCultureMaker/src/ScmDraw.cpp

@@ -406,6 +406,24 @@ std::vector<scm::CoordinateLine> scm::ScmDraw::getCoordinates() const
 	return drawnLines.coordinates;
 }
 
+void scm::ScmDraw::loadLines(const std::vector<CoordinateLine>& coordinates, const std::vector<StarLine>& stars)
+{
+	// copy the coordinates and stars to drawnLines
+	drawnLines.coordinates = coordinates;
+	drawnLines.stars       = stars;
+
+	if (!drawnLines.coordinates.empty())
+	{
+		currentLine = std::make_tuple(drawnLines.coordinates.back(), drawnLines.stars.back());
+		drawState   = Drawing::hasFloatingEnd;
+	}
+	else
+	{
+		currentLine = std::make_tuple(CoordinateLine(), StarLine());
+		drawState   = Drawing::None;
+	}
+}
+
 void scm::ScmDraw::setTool(scm::DrawTools tool)
 {
 	activeTool    = tool;

plugins/SkyCultureMaker/src/ScmDraw.hpp

@@ -180,6 +180,12 @@ public slots:
 	 */
 	std::vector<CoordinateLine> getCoordinates() const;
 
+	/**
+	 * @brief Loads lines into the buffer from a tuple of coordinates and stars.
+	 *
+	 */
+	void loadLines(const std::vector<CoordinateLine>& coordinates, const std::vector<StarLine>& stars);
+
 	/**
 	 * @brief Set the active draw tool
 	 *