Stellarium  23.4
Public Slots | Signals | Public Member Functions | Properties
SpecialMarkersMgr Class Reference

The SpecialMarkersMgr controls the drawing of the special markers, such a rectangular FOV marker. More...

#include <SpecialMarkersMgr.hpp>

Public Slots

void setFlagFOVCenterMarker (const bool displayed)
 Setter for displaying the FOV center marker.
 
bool getFlagFOVCenterMarker () const
 Accessor for displaying FOV center marker.
 
Vec3f getColorFOVCenterMarker () const
 Get the current color of the FOV center marker.
 
void setColorFOVCenterMarker (const Vec3f &newColor)
 Set the color of the FOV center marker. More...
 
void setFlagFOVCircularMarker (const bool displayed)
 Setter for displaying the circular FOV marker.
 
bool getFlagFOVCircularMarker () const
 Accessor for displaying circular FOV marker.
 
void setFOVCircularMarkerSize (const double size)
 Setter for size of circular FOV marker.
 
double getFOVCircularMarkerSize () const
 Accessor for get size of circular FOV marker.
 
Vec3f getColorFOVCircularMarker () const
 Get the current color of the circular FOV marker.
 
void setColorFOVCircularMarker (const Vec3f &newColor)
 Set the color of the circular FOV marker. More...
 
void setFlagFOVRectangularMarker (const bool displayed)
 Setter for displaying the rectangular FOV marker.
 
bool getFlagFOVRectangularMarker () const
 Accessor for displaying rectangular FOV marker.
 
void setFOVRectangularMarkerWidth (const double size)
 Setter for width of rectangular FOV marker.
 
double getFOVRectangularMarkerWidth () const
 Accessor for get width of rectangular FOV marker.
 
void setFOVRectangularMarkerHeight (const double size)
 Setter for height of rectangular FOV marker.
 
double getFOVRectangularMarkerHeight () const
 Accessor for get height of rectangular FOV marker.
 
void setFOVRectangularMarkerRotationAngle (const double pa)
 Setter for rotation angle of rectangular FOV marker.
 
double getFOVRectangularMarkerRotationAngle () const
 Accessor for get rotation angle of rectangular FOV marker.
 
Vec3f getColorFOVRectangularMarker () const
 Get the current color of the rectangular FOV marker.
 
void setColorFOVRectangularMarker (const Vec3f &newColor)
 Set the color of the rectangular FOV marker. More...
 
void setFlagCompassMarks (const bool displayed)
 Setter for displaying the compass marks.
 
bool getFlagCompassMarks () const
 Accessor for displaying compass marks.
 
Vec3f getColorCompassMarks () const
 Get the current color of the compass marks.
 
void setColorCompassMarks (const Vec3f &newColor)
 Set the color of the compass marks. More...
 

Signals

void fovCenterMarkerDisplayedChanged (const bool displayed)
 
void fovCenterMarkerColorChanged (const Vec3f &newColor)
 
void fovCircularMarkerDisplayedChanged (const bool displayed)
 
void fovCircularMarkerSizeChanged (const double size)
 
void fovCircularMarkerColorChanged (const Vec3f &newColor)
 
void fovRectangularMarkerDisplayedChanged (const bool displayed)
 
void fovRectangularMarkerWidthChanged (const double size)
 
void fovRectangularMarkerHeightChanged (const double size)
 
void fovRectangularMarkerRotationAngleChanged (const double size)
 
void fovRectangularMarkerColorChanged (const Vec3f &newColor)
 
void compassMarksDisplayedChanged (const bool displayed)
 
void compassMarksColorChanged (const Vec3f &newColor)
 

Public Member Functions

virtual void init () Q_DECL_OVERRIDE
 Initialize the SpecialMarkersMgr. More...
 
virtual QString getModuleID () const
 Get the module ID, returns "SpecialMarkersMgr".
 
virtual void draw (StelCore *core) Q_DECL_OVERRIDE
 Draw the special markers.
 
virtual void update (double deltaTime) Q_DECL_OVERRIDE
 Update time-dependent features. More...
 
virtual double getCallOrder (StelModuleActionName actionName) const Q_DECL_OVERRIDE
 Used to determine the order in which the various modules are drawn.
 
- Public Member Functions inherited from StelModule
 StelModule ()
 Constructor. Every derived class MUST call setObjectName(className) in its constructor.
 
virtual void deinit ()
 Called before the module will be deleted, and before the OpenGL context is suppressed. More...
 
virtual QSettings * getSettings ()
 Return module-specific settings. More...
 
virtual QString getModuleVersion () const
 Get the version of the module, default is stellarium main version.
 
virtual QString getAuthorName () const
 Get the name of the module author.
 
virtual QString getAuthorEmail () const
 Get the email address of the module author.
 
virtual void handleMouseClicks (class QMouseEvent *)
 Handle mouse clicks. More...
 
virtual void handleMouseWheel (class QWheelEvent *)
 Handle mouse wheel. More...
 
virtual bool handleMouseMoves (int x, int y, Qt::MouseButtons b)
 Handle mouse moves. More...
 
virtual void handleKeys (class QKeyEvent *e)
 Handle key events. More...
 
virtual bool handlePinch (qreal scale, bool started)
 Handle pinch gesture events. More...
 
virtual bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 

Properties

bool fovCenterMarkerDisplayed
 
Vec3f fovCenterMarkerColor
 
bool fovCircularMarkerDisplayed
 
double fovCircularMarkerSize
 
Vec3f fovCircularMarkerColor
 
bool fovRectangularMarkerDisplayed
 
double fovRectangularMarkerWidth
 
double fovRectangularMarkerHeight
 
double fovRectangularMarkerRotationAngle
 
Vec3f fovRectangularMarkerColor
 
bool compassMarksDisplayed
 
Vec3f compassMarksColor
 

Additional Inherited Members

- Public Types inherited from StelModule
enum  StelModuleSelectAction { AddToSelection , ReplaceSelection , RemoveFromSelection }
 Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...
 
enum  StelModuleActionName {
  ActionDraw , ActionUpdate , ActionHandleMouseClicks , ActionHandleMouseMoves ,
  ActionHandleKeys
}
 Define the possible action for which an order is defined. More...
 
- Protected Member Functions inherited from StelModule
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, QObject *target, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to slot) to the StelActionMgr object. More...
 
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to own slot) to the StelActionMgr object. More...
 
StelActionaddAction (const QString &id, const QString &groupId, const QString &text, QObject *contextObject, std::function< void()> lambda, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to Lambda functor) to the StelActionMgr object. More...
 

Detailed Description

The SpecialMarkersMgr controls the drawing of the special markers, such a rectangular FOV marker.

Member Function Documentation

◆ init()

virtual void SpecialMarkersMgr::init ( )
virtual

Initialize the SpecialMarkersMgr.

This process checks the values in the application settings, and according to the settings there sets the visibility of type of the special markers.

Implements StelModule.

◆ setColorCompassMarks

void SpecialMarkersMgr::setColorCompassMarks ( const Vec3f newColor)
slot

Set the color of the compass marks.

Parameters
newColorThe color of compass marks.
// example of usage in scripts

◆ setColorFOVCenterMarker

void SpecialMarkersMgr::setColorFOVCenterMarker ( const Vec3f newColor)
slot

Set the color of the FOV center marker.

Parameters
newColorThe color of FOV center marker.
// example of usage in scripts

◆ setColorFOVCircularMarker

void SpecialMarkersMgr::setColorFOVCircularMarker ( const Vec3f newColor)
slot

Set the color of the circular FOV marker.

Parameters
newColorThe color of circular FOV marker.
// example of usage in scripts

◆ setColorFOVRectangularMarker

void SpecialMarkersMgr::setColorFOVRectangularMarker ( const Vec3f newColor)
slot

Set the color of the rectangular FOV marker.

Parameters
newColorThe color of rectangular FOV marker.
// example of usage in scripts

◆ update()

virtual void SpecialMarkersMgr::update ( double  deltaTime)
virtual

Update time-dependent features.

Used to control fading when turning on and off the special markers.

Reimplemented from StelModule.