Stellarium 0.90.0
ConstellationMgr.hpp
1 /*
2  * Stellarium
3  * Copyright (C) 2002 Fabien Chereau
4  * Copyright (C) 2012 Timothy Reaves
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA.
19  */
20 
21 #ifndef _CONSTELLATIONMGR_HPP_
22 #define _CONSTELLATIONMGR_HPP_
23 
24 #include "StelObjectType.hpp"
25 #include "StelObjectModule.hpp"
26 #include "StelProjectorType.hpp"
27 
28 #include <vector>
29 #include <QString>
30 #include <QStringList>
31 #include <QFont>
32 
33 class StelToneReproducer;
34 class StarMgr;
35 class Constellation;
36 class StelProjector;
37 class StelPainter;
38 
44 {
45  Q_OBJECT
46  Q_PROPERTY(bool artDisplayed
47  READ getFlagArt
48  WRITE setFlagArt
49  NOTIFY artDisplayedChanged)
50  Q_PROPERTY(float artFadeDuration
52  WRITE setArtFadeDuration
53  NOTIFY artFadeDurationChanged)
54  Q_PROPERTY(float artIntensity
55  READ getArtIntensity
56  WRITE setArtIntensity
57  NOTIFY artIntensityChanged)
58  Q_PROPERTY(Vec3f boundariesColor
60  WRITE setBoundariesColor
61  NOTIFY boundariesColorChanged)
62  Q_PROPERTY(bool boundariesDisplayed
64  WRITE setFlagBoundaries
65  NOTIFY boundariesDisplayedChanged)
66  Q_PROPERTY(float fontSize
67  READ getFontSize
68  WRITE setFontSize
69  NOTIFY fontSizeChanged)
70  Q_PROPERTY(bool isolateSelected
73  NOTIFY isolateSelectedChanged)
74  Q_PROPERTY(Vec3f linesColor
75  READ getLinesColor
76  WRITE setLinesColor
77  NOTIFY linesColorChanged)
78  Q_PROPERTY(bool linesDisplayed
79  READ getFlagLines
80  WRITE setFlagLines
81  NOTIFY linesDisplayedChanged)
82  Q_PROPERTY(Vec3f namesColor
83  READ getLabelsColor
84  WRITE setLabelsColor
85  NOTIFY namesColorChanged)
86  Q_PROPERTY(bool namesDisplayed
87  READ getFlagLabels
88  WRITE setFlagLabels
89  NOTIFY namesDisplayedChanged)
93  NOTIFY constellationsDisplayStyleChanged)
94  Q_PROPERTY(float constellationLineThickness
97  NOTIFY constellationLineThicknessChanged)
98 
99  //Register enum with Qt
101 
102 public:
104  ConstellationMgr(StarMgr *stars);
106  virtual ~ConstellationMgr();
107 
109  // Methods defined in the StelModule class
113  virtual void init();
114 
116  virtual void draw(StelCore* core);
117 
119  virtual void update(double deltaTime);
120 
124  virtual double getCallOrder(StelModuleActionName actionName) const;
125 
127  // Methods defined in StelObjectManager class
128  virtual QList<StelObjectP> searchAround(const Vec3d& v, double limitFov, const StelCore* core) const;
129 
132  virtual StelObjectP searchByNameI18n(const QString& nameI18n) const;
133 
136  virtual StelObjectP searchByName(const QString& name) const;
137 
138  // GZ: I see dubious descriptions and non-fitting var names: objPrefix should just be "string" or "obj",
139  // and useStartOfWord likely should be described as "decide if start of word is searched" (2x)
145  virtual QStringList listMatchingObjects(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const;
146  virtual QStringList listAllObjects(bool inEnglish) const;
147  virtual QString getName() const { return "Constellations"; }
150  {
151  constellationsAbbreviated = 0,
152  constellationsNative = 1,
153  constellationsTranslated = 2,
154  constellationsEnglish = 3 // Maybe this is not useful?
155  };
156 
158  // Properties setters and getters
159 public slots:
161  void setFlagArt(const bool displayed);
163  bool getFlagArt(void) const;
164 
166  void setArtFadeDuration(const float duration);
168  float getArtFadeDuration() const;
169 
173  void setArtIntensity(const float intensity);
177  float getArtIntensity() const;
178 
181  void setArtIntensityMinimumFov(const double fov);
184  double getArtIntensityMinimumFov() const;
185 
189  void setArtIntensityMaximumFov(const double fov);
193  double getArtIntensityMaximumFov() const;
194 
201  void setBoundariesColor(const Vec3f& color);
203  Vec3f getBoundariesColor() const;
204 
206  void setFlagBoundaries(const bool displayed);
208  bool getFlagBoundaries(void) const;
209 
211  void setFlagIsolateSelected(const bool isolate);
213  bool getFlagIsolateSelected(void) const;
214 
216  void setFlagConstellationPick(const bool mode);
218  bool getFlagConstellationPick(void) const;
219 
226  void setLinesColor(const Vec3f& color);
228  Vec3f getLinesColor() const;
229 
231  void setFlagLines(const bool displayed);
233  bool getFlagLines(void) const;
234 
241  void setLabelsColor(const Vec3f& color);
243  Vec3f getLabelsColor() const;
244 
246  void setFlagLabels(const bool displayed);
248  bool getFlagLabels(void) const;
249 
251  void setFontSize(const float newFontSize);
253  float getFontSize() const;
254 
263 
266  void setConstellationLineThickness(const float thickness);
268  float getConstellationLineThickness() const { return constellationLineThickness; }
269 
270 
271 signals:
272  void artDisplayedChanged(const bool displayed) const;
273  void artFadeDurationChanged(const float duration) const;
274  void artIntensityChanged(const double intensity) const;
275  void boundariesColorChanged(const Vec3f & color) const;
276  void boundariesDisplayedChanged(const bool displayed) const;
277  void fontSizeChanged(const float newSize) const;
278  void isolateSelectedChanged(const bool isolate) const;
279  void linesColorChanged(const Vec3f & color) const;
280  void linesDisplayedChanged(const bool displayed) const;
281  void namesColorChanged(const Vec3f & color) const;
282  void namesDisplayedChanged(const bool displayed) const;
283  void constellationsDisplayStyleChanged(const ConstellationMgr::ConstellationDisplayStyle style) const;
284  void constellationLineThicknessChanged(float thickness) const;
285 
286 private slots:
291  void selectedObjectChange(StelModule::StelModuleSelectAction action);
292 
295  void updateSkyCulture(const QString& skyCultureDir);
296 
301  void updateI18n();
302 
303 private:
308  void loadNames(const QString& namesFile);
309 
315  void loadLinesAndArt(const QString& fileName, const QString& artfileName, const QString& cultureName);
316 
330  bool loadBoundaries(const QString& conCatFile);
331 
334  void loadSeasonalRules(const QString& rulesFile);
335 
337  void drawLines(StelPainter& sPainter, const StelCore* core) const;
339  void drawArt(StelPainter& sPainter) const;
341  void drawNames(StelPainter& sPainter) const;
343  void drawBoundaries(StelPainter& sPainter) const;
345  void setSelectedConst(Constellation* c);
347  void unsetSelectedConst(Constellation* c);
349  void setSelected(const QString& abbreviation);
351  StelObjectP setSelectedStar(const QString& abbreviation);
353  void setSelected(const StelObject* s) {if (!s) setSelectedConst(NULL); else setSelectedConst(isStarIn(s));}
355  void deselect() {setSelected(NULL);}
359  StelObject* getSelected(void) const;
361  void deselectConstellations(void);
362 
363  std::vector<Constellation*> selected; // More than one can be selected at a time
364 
365  Constellation* isStarIn(const StelObject *s) const;
366  Constellation* findFromAbbreviation(const QString& abbreviation) const;
367  std::vector<Constellation*> asterisms;
368  QFont asterFont;
369  StarMgr* hipStarMgr;
370 
371  bool isolateSelected; // true to pick individual constellations.
372  bool constellationPickEnabled;
373  std::vector<std::vector<Vec3f> *> allBoundarySegments;
374 
375  QString lastLoadedSkyCulture; // Store the last loaded sky culture directory name
376 
379 
380  // These are THE master settings - individual constellation settings can vary based on selection status
381  float artFadeDuration;
382  float artIntensity;
383  double artIntensityMinimumFov;
384  double artIntensityMaximumFov;
385  bool artDisplayed;
386  bool boundariesDisplayed;
387  bool linesDisplayed;
388  bool namesDisplayed;
389 
390  // Store the thickness of lines of the constellations
391  float constellationLineThickness;
392 };
393 
394 #endif // _CONSTELLATIONMGR_HPP_
Vec3f getLabelsColor() const
Get label color for names.
double getArtIntensityMinimumFov() const
Returns the lower bound on the FOV at which the art intensity fades to zero.
ConstellationMgr::ConstellationDisplayStyle getConstellationDisplayStyle()
get the way how constellation names are displayed: abbbreviated/as-given/translated ...
bool getFlagBoundaries(void) const
Get whether constellation boundaries lines are displayed.
void setFlagArt(const bool displayed)
Set whether constellation art will be displayed.
virtual void draw(StelCore *core)
Draw constellation lines, art, names and boundaries.
void setFlagBoundaries(const bool displayed)
Set whether constellation boundaries lines will be displayed.
The base abstract class for sky objects used in Stellarium like Stars, Planets, Constellations etc...
Definition: StelObject.hpp:36
void setArtIntensityMinimumFov(const double fov)
Sets the lower bound on the FOV at which the art intensity fades to zero.
virtual void update(double deltaTime)
Updates time-varying state for each Constellation.
bool getFlagArt(void) const
Get whether constellation art is displayed.
The Constellation class models a grouping of stars in a Sky Culture.
Main class for Stellarium core processing.
Definition: StelCore.hpp:48
Specialization of StelModule which manages a collection of StelObject.
virtual StelObjectP searchByNameI18n(const QString &nameI18n) const
Return the matching constellation object&#39;s pointer if exists or NULL.
void setArtFadeDuration(const float duration)
Set constellation art fade duration in second.
virtual QList< StelObjectP > searchAround(const Vec3d &v, double limitFov, const StelCore *core) const
Search for StelObject in an area around a specifid point.
Vec3f getBoundariesColor() const
Get current boundary color.
void setFlagIsolateSelected(const bool isolate)
Set whether selected constellation must be displayed alone.
Converts tones in function of the eye adaptation to luminance.
double getArtIntensityMaximumFov() const
Returns the upper bound on the FOV at which the art intensity becomes the maximum set by setArtIntens...
void setFontSize(const float newFontSize)
Set the font size used for constellation names display.
void setLinesColor(const Vec3f &color)
Define line color.
Define the StelObjectP type.
Provides functions for performing openGL drawing operations.
Definition: StelPainter.hpp:40
Provide the main interface to all operations of projecting coordinates from sky to screen...
float getFontSize() const
Get the font size used for constellation names display.
virtual double getCallOrder(StelModuleActionName actionName) const
Return the value defining the order of call for the given action.
void setFlagConstellationPick(const bool mode)
Set whether only one selected constellation must be displayed.
void setConstellationDisplayStyle(ConstellationMgr::ConstellationDisplayStyle style)
Set the way how constellation names are displayed: abbbreviated/as-given/translated.
ConstellationDisplayStyle constellationDisplayStyle
this controls how constellations (and also star names) are printed: Abbreviated/as-given/translated ...
virtual QStringList listAllObjects(bool inEnglish) const
List all StelObjects.
Stores the star catalogue data.
Definition: StarMgr.hpp:88
void setLabelsColor(const Vec3f &color)
Set label color for names.
StelModuleActionName
Define the possible action for which an order is defined.
Definition: StelModule.hpp:121
ConstellationDisplayStyle
Describes how to display constellation labels. The viewDialog GUI has a combobox which corresponds to...
void setFlagLabels(const bool displayed)
Set whether constellation names will be displayed.
static QString getConstellationDisplayStyleString(ConstellationMgr::ConstellationDisplayStyle style)
Returns the currently set constellation display style as string, instead of enum. ...
bool getFlagIsolateSelected(void) const
Get whether selected constellation is displayed alone.
Display and manage the constellations.
float getArtIntensity() const
Return constellation maximum art intensity (between 0 and 1) Note that the art intensity is linearly ...
virtual StelObjectP searchByName(const QString &name) const
Return the matching constellation if exists or NULL.
void setArtIntensity(const float intensity)
Set constellation maximum art intensity (between 0 and 1) Note that the art intensity is linearly fad...
void setConstellationLineThickness(const float thickness)
Set the thickness of lines of the constellations.
bool getFlagLabels(void) const
Set whether constellation names are displayed.
float getArtFadeDuration() const
Get constellation art fade duration in second.
StelModuleSelectAction
Enum used when selecting objects to define whether to add to, replace, or remove from the existing se...
Definition: StelModule.hpp:111
bool getFlagConstellationPick(void) const
Get whether only one selected constellation is displayed.
Define the StelProjectorP type.
float getConstellationLineThickness() const
Get the thickness of lines of the constellations.
bool getFlagLines(void) const
Get whether constellation lines are displayed.
virtual QStringList listMatchingObjects(const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const
Find and return the list of at most maxNbItem objects auto-completing the passed object name...
void setBoundariesColor(const Vec3f &color)
Define boundary color.
virtual void init()
Initialize the ConstellationMgr.
void setFlagLines(const bool displayed)
Set whether constellation lines will be displayed.
Vec3f getLinesColor() const
Get line color.
void setArtIntensityMaximumFov(const double fov)
Sets the upper bound on the FOV at which the art intensity becomes the maximum set by setArtIntensity...