Display and manage the asterisms. More...

#include <AsterismMgr.hpp>

Inheritance diagram for AsterismMgr:

Collaboration diagram for AsterismMgr:

Public Slots
void	setLinesColor (const Vec3f &color)
	Define line color. More...

Vec3f	getLinesColor () const
	Get line color. More...

void	setFlagLines (const bool displayed)
	Set whether asterism lines will be displayed. More...

bool	getFlagLines (void) const
	Get whether asterism lines are displayed. More...

void	setRayHelpersColor (const Vec3f &color)
	Define ray helper color. More...

Vec3f	getRayHelpersColor () const
	Get ray helper color. More...

void	setFlagRayHelpers (const bool displayed)
	Set whether ray helpers will be displayed. More...

bool	getFlagRayHelpers (void) const
	Get whether ray helpers are displayed. More...

void	setLabelsColor (const Vec3f &color)
	Set label color for names. More...

Vec3f	getLabelsColor () const
	Get label color for names. More...

void	setFlagLabels (const bool displayed)
	Set whether asterism names will be displayed. More...

bool	getFlagLabels (void) const
	Set whether asterism names are displayed. More...

void	setFontSize (const float newFontSize)
	Set the font size used for asterism names display. More...

float	getFontSize () const
	Get the font size used for asterism names display. More...

void	setAsterismLineThickness (const int thickness)
	Set the thickness of lines of the asterisms. More...

int	getAsterismLineThickness () const
	Get the thickness of lines of the asterisms. More...

void	setRayHelperThickness (const int thickness)
	Set the thickness of ray helpers of the asterisms. More...

int	getRayHelperThickness () const
	Get the thickness of ray helper of the asterisms. More...

Signals
void	fontSizeChanged (const float newSize) const

void	linesColorChanged (const Vec3f &color) const

void	linesDisplayedChanged (const bool displayed) const

void	namesColorChanged (const Vec3f &color) const

void	namesDisplayedChanged (const bool displayed) const

void	asterismLineThicknessChanged (int thickness) const

void	rayHelpersColorChanged (const Vec3f &color) const

void	rayHelpersDisplayedChanged (const bool displayed) const

void	rayHelperThicknessChanged (int thickness) const

Public Member Functions
	AsterismMgr (StarMgr *stars)
	Constructor. More...

virtual	~AsterismMgr ()
	Destructor. More...

virtual void	init ()
	Initialize the AsterismMgr. More...

virtual void	draw (StelCore *core)
	Draw constellation lines, art, names and boundaries. More...

virtual void	update (double deltaTime)
	Updates time-varying state for each Constellation. More...

virtual double	getCallOrder (StelModuleActionName actionName) const
	Return the value defining the order of call for the given action. More...

virtual QList< StelObjectP >	searchAround (const Vec3d &v, double limitFov, const StelCore *core) const
	Search for StelObject in an area around a specifid point. More...

virtual StelObjectP	searchByNameI18n (const QString &nameI18n) const
	Return the matching asterism object's pointer if exists or Q_NULLPTR. More...

virtual StelObjectP	searchByName (const QString &name) const
	Return the matching asterism if exists or Q_NULLPTR. More...

virtual StelObjectP	searchByID (const QString &id) const
	Return the StelObject with the given ID if exists or the empty StelObject if not found. More...

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. More...

virtual QStringList	listAllObjects (bool inEnglish) const
	List all StelObjects. More...

virtual QString	getName () const
	Gets a user-displayable name of the object category. More...

virtual QString	getStelObjectType () const
	Returns the name that will be returned by StelObject::getType() for the objects this module manages. More...

Public Member Functions inherited from StelObjectModule
virtual QStringList	listAllObjectsByType (const QString &objType, bool inEnglish) const
	List all StelObjects by type. More...

bool	matchObjectName (const QString &objName, const QString &objPrefix, bool useStartOfWords) const
	Auxiliary method of listMatchingObjects() More...

Public Member Functions inherited from StelModule
virtual void	deinit ()
	Called before the module will be delete, and before the openGL context is suppressed. More...

virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version. More...

virtual QString	getAuthorName () const
	Get the name of the module author. More...

virtual QString	getAuthorEmail () const
	Get the email adress of the module author. More...

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
float	fontSize

Vec3f	linesColor

Vec3f	rayHelpersColor

Vec3f	namesColor

loadNames():

Load asterism line shapes from data files.

Parameters

fileName The name of the asterism data file

Note: The abbreviation used in

Parameters

filename is required for cross-identifying translatable names in

bool linesDisplayed

bool rayHelpersDisplayed

bool namesDisplayed

int asterismLineThickness

int rayHelperThickness

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 StelAction *	addAction (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 StelAction *	addAction (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...

Detailed Description

Display and manage the asterisms.

It can display asterisms lines and names. It also supports several different sky cultures.

Definition at line 42 of file AsterismMgr.hpp.

Constructor & Destructor Documentation

AsterismMgr::AsterismMgr ( StarMgr * stars )

Constructor.

virtual AsterismMgr::~AsterismMgr ( )

virtual

Destructor.

Member Function Documentation

virtual void AsterismMgr::draw ( StelCore * core )

virtual

Draw constellation lines, art, names and boundaries.

Reimplemented from StelModule.

int AsterismMgr::getAsterismLineThickness ( ) const

inlineslot

Get the thickness of lines of the asterisms.

Definition at line 187 of file AsterismMgr.hpp.

virtual double AsterismMgr::getCallOrder ( StelModuleActionName actionName ) const

virtual

Return the value defining the order of call for the given action.

Parameters

actionName the name of the action for which we want the call order

Returns: the value defining the order. The closer to 0 the earlier the module's action will be called

Reimplemented from StelModule.

bool AsterismMgr::getFlagLabels ( void ) const

slot

Set whether asterism names are displayed.

bool AsterismMgr::getFlagLines ( void ) const

slot

Get whether asterism lines are displayed.

bool AsterismMgr::getFlagRayHelpers ( void ) const

slot

Get whether ray helpers are displayed.

float AsterismMgr::getFontSize ( ) const

slot

Get the font size used for asterism names display.

Vec3f AsterismMgr::getLabelsColor ( ) const

slot

Get label color for names.

Vec3f AsterismMgr::getLinesColor ( ) const

slot

Get line color.

virtual QString AsterismMgr::getName ( ) const

inlinevirtual

Gets a user-displayable name of the object category.

Implements StelObjectModule.

Definition at line 127 of file AsterismMgr.hpp.

Vec3f AsterismMgr::getRayHelpersColor ( ) const

slot

Get ray helper color.

int AsterismMgr::getRayHelperThickness ( ) const

inlineslot

Get the thickness of ray helper of the asterisms.

Definition at line 193 of file AsterismMgr.hpp.

virtual QString AsterismMgr::getStelObjectType ( ) const

virtual

Returns the name that will be returned by StelObject::getType() for the objects this module manages.

Implements StelObjectModule.

virtual void AsterismMgr::init ( )

virtual

Initialize the AsterismMgr.

Reads from the asterism parser object and updates the loading bar as constellation objects are loaded for the required sky culture.

Implements StelModule.

virtual QStringList AsterismMgr::listAllObjects ( bool inEnglish ) const

virtual

List all StelObjects.

Parameters

inEnglish list names in English (true) or translated (false)

Returns: a list of matching object name by order of relevance, or an empty list if nothing matches

Implements StelObjectModule.

virtual QStringList AsterismMgr::listMatchingObjects	(	const QString &	objPrefix,
		int	maxNbItem = `5`,
		bool	useStartOfWords = `false`,
		bool	inEnglish = `false`
	)		const

virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object name.

Parameters

objPrefix	the case insensitive first letters of the searched object
maxNbItem	the maximum number of returned object names
useStartOfWords	the autofill mode for returned objects names

Returns: a vector of matching object name by order of relevance, or an empty vector if nothing matches

Reimplemented from StelObjectModule.

virtual QList<StelObjectP> AsterismMgr::searchAround	(	const Vec3d &	v,
		double	limitFov,
		const StelCore *	core
	)		const

virtual

Search for StelObject in an area around a specifid point.

The function searches in a disk of diameter limitFov centered on v. Only visible objects (i.e curretly displayed on screen) should be returned.

Parameters

v	equatorial position at epoch J2000.
limitFov	angular diameter of the searching zone in degree.
core	the core instance to use.

Returns: the list of all the displayed objects contained in the defined zone.

Implements StelObjectModule.

virtual StelObjectP AsterismMgr::searchByID ( const QString & id ) const

virtual

Return the StelObject with the given ID if exists or the empty StelObject if not found.

Parameters

name	the english object name

Implements StelObjectModule.

virtual StelObjectP AsterismMgr::searchByName ( const QString & name ) const

virtual

Return the matching asterism if exists or Q_NULLPTR.

Parameters

name	The case in-sensitive standard program name (three letter abbreviation)

Implements StelObjectModule.

virtual StelObjectP AsterismMgr::searchByNameI18n ( const QString & nameI18n ) const

virtual

Return the matching asterism object's pointer if exists or Q_NULLPTR.

Parameters

nameI18n The case in-sensistive asterism name

Implements StelObjectModule.

void AsterismMgr::setAsterismLineThickness ( const int thickness )

slot

Set the thickness of lines of the asterisms.

Parameters

thickness of line in pixels

void AsterismMgr::setFlagLabels ( const bool displayed )

slot

Set whether asterism names will be displayed.

void AsterismMgr::setFlagLines ( const bool displayed )

slot

Set whether asterism lines will be displayed.

void AsterismMgr::setFlagRayHelpers ( const bool displayed )

slot

Set whether ray helpers will be displayed.

void AsterismMgr::setFontSize ( const float newFontSize )

slot

Set the font size used for asterism names display.

void AsterismMgr::setLabelsColor ( const Vec3f & color )

slot

Set label color for names.

Parameters

color

The color of labels

// example of usage in scripts

AsterismMgr.setLabelsColor(Vec3f(1.0,0.0,0.0));

void AsterismMgr::setLinesColor ( const Vec3f & color )

slot

Define line color.

Parameters

color

The color of lines

// example of usage in scripts

AsterismMgr.setLinesColor(Vec3f(1.0,0.0,0.0));

void AsterismMgr::setRayHelpersColor ( const Vec3f & color )

slot

Define ray helper color.

Parameters

color

The color of ray helpers

// example of usage in scripts

AsterismMgr.setRayHelpersColor(Vec3f(1.0,0.0,0.0));

void AsterismMgr::setRayHelperThickness ( const int thickness )

slot

Set the thickness of ray helpers of the asterisms.

Parameters

thickness of ray helper in pixels

virtual void AsterismMgr::update ( double deltaTime )

virtual

Updates time-varying state for each Constellation.

Implements StelModule.

The documentation for this class was generated from the following file:

/home/aw/devel/stellarium/0.16/src/core/modules/AsterismMgr.hpp

Public Slots

Signals

Public Member Functions

Properties

loadNames():

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation