15670918640

Committed 16 Jun 2025 02:08AM UTC coverage: 11.775% (-0.2%) from 11.931%

Build # 15670918640

Build Type

push

github

Committed by

alex-w

Commit Message

Updated data

Run Details

14700 of 124846 relevant lines covered (11.77%)

18324.52 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/core/modules/Asterism.hpp

/*
 * Stellarium
 * Copyright (C) 2017 Alexander Wolf
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef ASTERISM_HPP
#define ASTERISM_HPP

#include "StelObject.hpp"
#include "StelTranslator.hpp"
#include "StelFader.hpp"
#include "StelSphereGeometry.hpp"
#include "AsterismMgr.hpp"

#include <vector>
#include <QString>
#include <QFont>

class StarMgr;
class StelPainter;
class QJsonObject;

//! @class Asterism
//! The Asterism class models a grouping of stars in a Sky Culture.
//! Each Asterism consists of a list of stars identified by their
//! abbreviation and Hipparcos catalogue numbers (taken from file: asterismship.fab),
//! another entry in file asterism_names.eng.fab with the defining abbreviated name
//! and translatable englishName (translation goes into nameI18).
class Asterism : public StelObject
{
        friend class AsterismMgr;
public:
        static const QString ASTERISM_TYPE;
private:
        Asterism();
        ~Asterism() override;

        // StelObject method to override
        //! Get a string with data about the Asterism.
        //! Constellations support the following InfoStringGroup flags:
        //! - Name
        //! @param core the StelCore object
        //! @param flags a set of InfoStringGroup items to include in the return value.
        //! @return a QString a description of the constellation.
        QString getInfoString(const StelCore*, const InfoStringGroup& flags) const override;

        //! Get the module/object type string.
        //! @return "Asterism"
        QString getType() const override {return ASTERISM_TYPE;}
        QString getObjectType() const override {return N_("asterism"); }
        QString getObjectTypeI18n() const override {return q_(getObjectType()); }
        QString getID() const override { return abbreviation; }

        //! observer centered J2000 coordinates.
        //! These are either automatically computed from all stars forming the lines,
        //! or from the manually defined label point(s).
        Vec3d getJ2000EquatorialPos(const StelCore*) const override;

        //! @param record string containing the following whitespace
        //! separated fields: abbreviation - a three character abbreviation
        //! for the asterism, a number of lines (pairs), and a list of Hipparcos
        //! catalogue numbers which, when connected pairwise, form the lines of the
        //! asterism.
        //! @param starMgr a pointer to the StarManager object.
        //! @param excludeRefs a QSet of reference exclusions (user-defined preference in config.ini)
        //! @return false if can't parse record, else true.
        bool read(const QJsonObject& data, StarMgr *starMgr, const QSet<int> &excludeRefs);

        //! Draw the asterism name
        void drawName(const Vec3d &xyName, StelPainter& sPainter) const;

        //! Get the translated name for the Asterism.
        QString getNameI18n() const override {return culturalName.translatedI18n;}
        //! Get the English name for the Asterism.
        QString getEnglishName() const override {return culturalName.translated;}
        //! Get the native name for the Asterism
        QString getNameNative() const override {return culturalName.native;}
        //! Get (translated) pronouncement of the native name for the Asterism
        QString getNamePronounce() const override {return (culturalName.pronounceI18n.isEmpty() ? culturalName.native : culturalName.pronounceI18n);}
        //! Get the short name for the Asterism (returns the translated version of abbreviation).
        QString getShortName() const {return abbreviationI18n;}
        //! Combine screen label from various components, depending on settings in SkyCultureMgr
        QString getScreenLabel() const override;
        //! Combine InfoString label from various components, depending on settings in SkyCultureMgr
        QString getInfoLabel() const override;
        //! Underlying worker
        QString getCultureLabel(StelObject::CulturalDisplayStyle style) const;
        //! Draw the lines for the Asterism.
        //! This method uses the coords of the stars (optimized for use through
        //! the class AsterismMgr only).
        void drawOptim(StelPainter& sPainter, const StelCore* core, const SphericalCap& viewportHalfspace) const;
        //! Update fade levels according to time since various events.
        void update(int deltaTime);
        //! Turn on and off Asterism line rendering.
        //! @param b new state for line drawing.
        void setFlagLines(const bool b) { lineFader=b; }
        //! Turn on and off ray helper rendering.
        //! @param b new state for ray helper drawing.
        void setFlagRayHelpers(const bool b) { rayHelperFader=b; }
        //! Turn on and off Asterism name label rendering.
        //! @param b new state for name label drawing.
        void setFlagLabels(const bool b) { nameFader=b; }
        //! Get the current state of Asterism line rendering.
        //! @return true if Asterism line rendering it turned on, else false.
        bool getFlagLines() const { return lineFader; }
        //! Get the current state of ray helper rendering.
        //! @return true if ray helper rendering it turned on, else false.
        bool getFlagRayHelpers() const { return rayHelperFader; }
        //! Get the current state of Asterism name label rendering.
        //! @return true if Asterism name label rendering it turned on, else false.
        bool getFlagLabels() const { return nameFader; }

        //! @return true if a (real) named asterism, false for a ray helper
        bool isAsterism() const { return flagAsterism; }

        //! Asterism name. This is a culture-dependent thing, and in each skyculture an asterism has one name entry only.
        //! Given multiple aspects of naming, we need all the components and more.
        CulturalName culturalName;
        //! Abbreviation
        //! A skyculture designer must invent it. (usually 2-5 letters)
        //! This MUST be filled and be unique within a sky culture.
        //! @note Given their possible screen use, using numerical labels as abbreviation is not recommended.
        QString abbreviation;
        //! Translated version of abbreviation (the short name or designation of asterism)
        //! Latin-based languages should not translate it, but it may be useful to translate for other glyph systems.
        QString abbreviationI18n;
        //! Context for name
        QString context;
        //! Direction vectors pointing on constellation name drawing position (J2000.0 coordinates)
        //! Usually a single position is computed from averaging star positions forming the constellation, but we can override with an entry in index.json,
        //! and even give more positions (e.g. for long or split-up constellations like Serpens.
        QList<Vec3d> XYZname;
        enum class Type
        {
                RayHelper,          //!< Ray helper
                Asterism,           //!< An asterism with lines between HIP/Gaia stars
                TelescopicAsterism, //!< An asterism with lines defined by J2000.0 coordinates
        };
        //! Type of asterism
        Type typeOfAsterism = Type::Asterism;
        bool flagAsterism; //!< True for genuine asterisms, false for ray helpers
        //! List of stars forming the segments
        std::vector<StelObjectP> asterism;
        //! In case this describes a single-star asterism (i.e. just one line segment that starts and ends at the same star),
        //! or we have a line segment with such single star somewhere within the asterism,
        //! we will draw a circle with this opening radius.
        double singleStarAsterismRadius;

        SphericalCap boundingCap;

        //! Define whether lines and names must be drawn
        LinearFader lineFader, rayHelperFader, nameFader;

        //! Currently we only need one color for all asterisms, this may change at some point
        static Vec3f lineColor;
        static Vec3f rayHelperColor;
        static Vec3f labelColor;
};

#endif // ASTERISM_HPP

1	/*
2	* Stellarium
3	* Copyright (C) 2017 Alexander Wolf
4	*
5	* This program is free software; you can redistribute it and/or
6	* modify it under the terms of the GNU General Public License
7	* as published by the Free Software Foundation; either version 2
8	* of the License, or (at your option) any later version.
9	*
10	* This program is distributed in the hope that it will be useful,
11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	* GNU General Public License for more details.
14	*
15	* You should have received a copy of the GNU General Public License
16	* along with this program; if not, write to the Free Software
17	* Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA.
18	*/
19
20	#ifndef ASTERISM_HPP
21	#define ASTERISM_HPP
22
23	#include "StelObject.hpp"
24	#include "StelTranslator.hpp"
25	#include "StelFader.hpp"
26	#include "StelSphereGeometry.hpp"
27	#include "AsterismMgr.hpp"
28
29	#include <vector>
30	#include <QString>
31	#include <QFont>
32
33	class StarMgr;
34	class StelPainter;
35	class QJsonObject;
36
37	//! @class Asterism
38	//! The Asterism class models a grouping of stars in a Sky Culture.
39	//! Each Asterism consists of a list of stars identified by their
40	//! abbreviation and Hipparcos catalogue numbers (taken from file: asterismship.fab),
41	//! another entry in file asterism_names.eng.fab with the defining abbreviated name
42	//! and translatable englishName (translation goes into nameI18).
43	class Asterism : public StelObject
44	{
45	friend class AsterismMgr;
46	public:
47	static const QString ASTERISM_TYPE;
48	private:
49	Asterism();
50	~Asterism() override;
51
52	// StelObject method to override
53	//! Get a string with data about the Asterism.
54	//! Constellations support the following InfoStringGroup flags:
55	//! - Name
56	//! @param core the StelCore object
57	//! @param flags a set of InfoStringGroup items to include in the return value.
58	//! @return a QString a description of the constellation.
59	QString getInfoString(const StelCore*, const InfoStringGroup& flags) const override;
60
61	//! Get the module/object type string.
62	//! @return "Asterism"
63	QString getType() const override {return ASTERISM_TYPE;}	×
64	QString getObjectType() const override {return N_("asterism"); }	×
65	QString getObjectTypeI18n() const override {return q_(getObjectType()); }	×
66	QString getID() const override { return abbreviation; }	×
67
68	//! observer centered J2000 coordinates.
69	//! These are either automatically computed from all stars forming the lines,
70	//! or from the manually defined label point(s).
71	Vec3d getJ2000EquatorialPos(const StelCore*) const override;
72
73	//! @param record string containing the following whitespace
74	//! separated fields: abbreviation - a three character abbreviation
75	//! for the asterism, a number of lines (pairs), and a list of Hipparcos
76	//! catalogue numbers which, when connected pairwise, form the lines of the
77	//! asterism.
78	//! @param starMgr a pointer to the StarManager object.
79	//! @param excludeRefs a QSet of reference exclusions (user-defined preference in config.ini)
80	//! @return false if can't parse record, else true.
81	bool read(const QJsonObject& data, StarMgr *starMgr, const QSet<int> &excludeRefs);
82
83	//! Draw the asterism name
84	void drawName(const Vec3d &xyName, StelPainter& sPainter) const;
85
86	//! Get the translated name for the Asterism.
87	QString getNameI18n() const override {return culturalName.translatedI18n;}	×
88	//! Get the English name for the Asterism.
89	QString getEnglishName() const override {return culturalName.translated;}	×
90	//! Get the native name for the Asterism
91	QString getNameNative() const override {return culturalName.native;}	×
92	//! Get (translated) pronouncement of the native name for the Asterism
93	QString getNamePronounce() const override {return (culturalName.pronounceI18n.isEmpty() ? culturalName.native : culturalName.pronounceI18n);}	×
94	//! Get the short name for the Asterism (returns the translated version of abbreviation).
95	QString getShortName() const {return abbreviationI18n;}
96	//! Combine screen label from various components, depending on settings in SkyCultureMgr
97	QString getScreenLabel() const override;
98	//! Combine InfoString label from various components, depending on settings in SkyCultureMgr
99	QString getInfoLabel() const override;
100	//! Underlying worker
101	QString getCultureLabel(StelObject::CulturalDisplayStyle style) const;
102	//! Draw the lines for the Asterism.
103	//! This method uses the coords of the stars (optimized for use through
104	//! the class AsterismMgr only).
105	void drawOptim(StelPainter& sPainter, const StelCore* core, const SphericalCap& viewportHalfspace) const;
106	//! Update fade levels according to time since various events.
107	void update(int deltaTime);
108	//! Turn on and off Asterism line rendering.
109	//! @param b new state for line drawing.
110	void setFlagLines(const bool b) { lineFader=b; }	×
111	//! Turn on and off ray helper rendering.
112	//! @param b new state for ray helper drawing.
113	void setFlagRayHelpers(const bool b) { rayHelperFader=b; }	×
114	//! Turn on and off Asterism name label rendering.
115	//! @param b new state for name label drawing.
116	void setFlagLabels(const bool b) { nameFader=b; }	×
117	//! Get the current state of Asterism line rendering.
118	//! @return true if Asterism line rendering it turned on, else false.
119	bool getFlagLines() const { return lineFader; }
120	//! Get the current state of ray helper rendering.
121	//! @return true if ray helper rendering it turned on, else false.
122	bool getFlagRayHelpers() const { return rayHelperFader; }
123	//! Get the current state of Asterism name label rendering.
124	//! @return true if Asterism name label rendering it turned on, else false.
125	bool getFlagLabels() const { return nameFader; }
126
127	//! @return true if a (real) named asterism, false for a ray helper
128	bool isAsterism() const { return flagAsterism; }	×
129
130	//! Asterism name. This is a culture-dependent thing, and in each skyculture an asterism has one name entry only.
131	//! Given multiple aspects of naming, we need all the components and more.
132	CulturalName culturalName;
133	//! Abbreviation
134	//! A skyculture designer must invent it. (usually 2-5 letters)
135	//! This MUST be filled and be unique within a sky culture.
136	//! @note Given their possible screen use, using numerical labels as abbreviation is not recommended.
137	QString abbreviation;
138	//! Translated version of abbreviation (the short name or designation of asterism)
139	//! Latin-based languages should not translate it, but it may be useful to translate for other glyph systems.
140	QString abbreviationI18n;
141	//! Context for name
142	QString context;
143	//! Direction vectors pointing on constellation name drawing position (J2000.0 coordinates)
144	//! Usually a single position is computed from averaging star positions forming the constellation, but we can override with an entry in index.json,
145	//! and even give more positions (e.g. for long or split-up constellations like Serpens.
146	QList<Vec3d> XYZname;
147	enum class Type
148	{
149	RayHelper, //!< Ray helper
150	Asterism, //!< An asterism with lines between HIP/Gaia stars
151	TelescopicAsterism, //!< An asterism with lines defined by J2000.0 coordinates
152	};
153	//! Type of asterism
154	Type typeOfAsterism = Type::Asterism;
155	bool flagAsterism; //!< True for genuine asterisms, false for ray helpers
156	//! List of stars forming the segments
157	std::vector<StelObjectP> asterism;
158	//! In case this describes a single-star asterism (i.e. just one line segment that starts and ends at the same star),
159	//! or we have a line segment with such single star somewhere within the asterism,
160	//! we will draw a circle with this opening radius.
161	double singleStarAsterismRadius;
162
163	SphericalCap boundingCap;
164
165	//! Define whether lines and names must be drawn
166	LinearFader lineFader, rayHelperFader, nameFader;
167
168	//! Currently we only need one color for all asterisms, this may change at some point
169	static Vec3f lineColor;
170	static Vec3f rayHelperColor;
171	static Vec3f labelColor;
172	};
173
174	#endif // ASTERISM_HPP

Stellarium / stellarium / 15670918640

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous