Kstars

fovsnapshot.h
1 /*
2  SPDX-FileCopyrightText: 2011 Rafał Kułaga <[email protected]>
3 
4  SPDX-License-Identifier: GPL-2.0-or-later
5 */
6 
7 #ifndef FOVSNAPSHOT_H
8 #define FOVSNAPSHOT_H
9 
10 #include "fov.h"
11 #include "skypoint.h"
12 #include "QPixmap"
13 #include "QString"
14 
15 class FOV;
16 
17 /**
18  * \class FovSnapshot
19  * \brief Class that represents single field of view snapshot.
20  * FovSnapshot class stores data of single FOV snapshot: image, description, FOV symbol at which it was
21  * captured and its central point.
22  * \author Rafał Kułaga
23  */
25 {
26  public:
27  /**
28  * \brief Constructor.
29  * \param pixmap Snapshot image.
30  * \param description Snapshot description.
31  * \param fov FOV symbol at which snapshot was captured.
32  * \param center Central point of the snapshot.
33  */
34  FovSnapshot(const QPixmap &pixmap, const QString description, FOV *fov, const SkyPoint &center);
35 
36  /**
37  * \brief Get snapshot image.
38  * \return Image of the snapshot.
39  */
40  QPixmap getPixmap() { return m_Pixmap; }
41 
42  /**
43  * \brief Get snapshot description.
44  * \return Description of the snapshot.
45  */
46  QString getDescription() { return m_Description; }
47 
48  /**
49  * \brief Get FOV symbol at which snapshot was captured.
50  * \return FOV of the snapshot.
51  */
52  FOV *getFov() { return m_Fov; }
53 
54  /**
55  * \brief Get central point of the snapshot.
56  * \return Central point of the snapshot.
57  */
58  SkyPoint getCentralPoint() { return m_CentralPoint; }
59 
60  /**
61  * \brief Set snapshot image.
62  * \param pixmap Snapshot image.
63  */
64  void setPixmap(const QPixmap &pixmap) { m_Pixmap = pixmap; }
65 
66  /**
67  * \brief Set snapshot description.
68  * \param description Snapshot description.
69  */
70  void setDescription(const QString &description) { m_Description = description; }
71 
72  /**
73  * \brief Set snapshot FOV symbol.
74  * \param fov FOV symbol of the snapshot.
75  */
76  void setFov(FOV *fov) { m_Fov = fov; }
77 
78  /**
79  * \brief Set central point of the snapshot.
80  * \param point Central point of the snapshot.
81  */
82  void setCentralPoint(const SkyPoint &point) { m_CentralPoint = point; }
83 
84  private:
85  QPixmap m_Pixmap;
86  QString m_Description;
87  FOV *m_Fov;
88  SkyPoint m_CentralPoint;
89 };
90 
91 #endif // FOVSNAPSHOT_H
Definition: fov.h:27
void setPixmap(const QPixmap &pixmap)
Set snapshot image.
Definition: fovsnapshot.h:64
Class that represents single field of view snapshot. FovSnapshot class stores data of single FOV snap...
Definition: fovsnapshot.h:24
Stores dms coordinates for a point in the sky. for converting between coordinate systems.
Definition: skypoint.h:44
QString getDescription()
Get snapshot description.
Definition: fovsnapshot.h:46
SkyPoint getCentralPoint()
Get central point of the snapshot.
Definition: fovsnapshot.h:58
void setFov(FOV *fov)
Set snapshot FOV symbol.
Definition: fovsnapshot.h:76
void setCentralPoint(const SkyPoint &point)
Set central point of the snapshot.
Definition: fovsnapshot.h:82
FOV * getFov()
Get FOV symbol at which snapshot was captured.
Definition: fovsnapshot.h:52
FovSnapshot(const QPixmap &pixmap, const QString description, FOV *fov, const SkyPoint &center)
Constructor.
Definition: fovsnapshot.cpp:9
void setDescription(const QString &description)
Set snapshot description.
Definition: fovsnapshot.h:70
QPixmap getPixmap()
Get snapshot image.
Definition: fovsnapshot.h:40
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Aug 14 2022 04:13:56 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.