Display and manage the constellations. More...

#include <ConstellationMgr.hpp>

Public Types
enum	ConstellationDisplayStyle { constellationsAbbreviated = 0, constellationsNative = 1, constellationsTranslated = 2, constellationsEnglish = 3 }
	Describes how to display constellation labels. The viewDialog GUI has a combobox which corresponds to these values. More...

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

Public Slots
void	setFlagArt (const bool displayed)
	Set whether constellation art will be displayed. More...

bool	getFlagArt (void) const
	Get whether constellation art is displayed. More...

void	setArtFadeDuration (const float duration)
	Set constellation art fade duration in second. More...

float	getArtFadeDuration () const
	Get constellation art fade duration in second. More...

void	setArtIntensity (const double intensity)
	Set constellation maximum art intensity (between 0 and 1) More...

double	getArtIntensity () const
	Set constellation maximum art intensity (between 0 and 1) More...

void	setBoundariesColor (const Vec3f &color)
	Define boundary color. More...

Vec3f	getBoundariesColor () const
	Get current boundary color. More...

void	setFlagBoundaries (const bool displayed)
	Set whether constellation boundaries lines will be displayed. More...

bool	getFlagBoundaries (void) const
	Get whether constellation boundaries lines are displayed. More...

void	setFlagIsolateSelected (const bool isolate)
	Set whether selected constellation must be displayed alone. More...

bool	getFlagIsolateSelected (void) const
	Get whether selected constellation is displayed alone. More...

void	setFlagConstellationPick (const bool mode)
	Set whether only one selected constellation must be displayed. More...

bool	getFlagConstellationPick (void) const
	Get whether only one selected constellation is displayed. More...

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

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

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

bool	getFlagLines (void) const
	Get whether constellation lines 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 constellation names will be displayed. More...

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

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

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

void	setConstellationDisplayStyle (int style)
	Set the way how contellation names are displayed: abbbreviated/as-given/translated. More...

ConstellationDisplayStyle	getConstellationDisplayStyle ()
	get the way how contellation names are displayed: abbbreviated/as-given/translated More...

QString	getConstellationDisplayStyleString ()

void	setConstellationLineThickness (const double thickness)
	Set the thickness of lines of the constellations. More...

double	getConstellationLineThickness () const
	Get the thickness of lines of the constellations. More...

Signals
void	artDisplayedChanged (const bool displayed) const

void	artFadeDurationChanged (const float duration) const

void	artIntensityChanged (const double intensity) const

void	boundariesColorChanged (const Vec3f &color) const

void	boundariesDisplayedChanged (const bool displayed) const

void	fontSizeChanged (const float newSize) const

void	isolateSelectedChanged (const bool isolate) 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	constellationsDisplayStyleChanged (const ConstellationDisplayStyle style) const

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

virtual	~ConstellationMgr ()
	Destructor. More...

virtual void	init ()
	Initialize the ConstellationMgr. 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 constellation object's pointer if exists or NULL. More...

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

virtual QStringList	listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const
	Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name. More...

virtual QStringList	listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const
	Find and return the list of at most maxNbItem objects auto-completing the passed object English name. More...

virtual QStringList	listAllObjects (bool inEnglish) const

virtual QStringList	listAllObjectsByType (const QString &objType, bool inEnglish) const

virtual QString	getName () const

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
Vec3f	boundariesColor

float	fontSize

Vec3f	linesColor

Vec3f	namesColor

loadNames():

Load constellation line shapes, art textures and boundaries shapes from data files.

Parameters

fileName	The name of the constellation data file
artFileName	The name of the constellation art data file
cultureName	A string ID of the current skyculture

Note: The abbreviation used in

Parameters

filename is required for cross-identifying translatable names in

bool artDisplayed

float artFadeDuration

float artIntensity

bool boundariesDisplayed

bool isolateSelected

bool linesDisplayed

bool namesDisplayed

ConstellationDisplayStyle

constellationDisplayStyle

this controls how constellations (and also star names) are printed: Abbreviated/as-given/translated More...

Additional Inherited Members
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 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 to the StelActionMgr object. More...

Detailed Description

Display and manage the constellations.

It can display constellations lines, names, art textures and boundaries. It also supports several different sky cultures.

Definition at line 43 of file ConstellationMgr.hpp.

Member Enumeration Documentation

enum ConstellationMgr::ConstellationDisplayStyle

Describes how to display constellation labels. The viewDialog GUI has a combobox which corresponds to these values.

Definition at line 150 of file ConstellationMgr.hpp.

Constructor & Destructor Documentation

ConstellationMgr::ConstellationMgr ( StarMgr * stars )

Constructor.

virtual ConstellationMgr::~ConstellationMgr ( )

virtual

Destructor.

Member Function Documentation

virtual void ConstellationMgr::draw ( StelCore * core )

virtual

Draw constellation lines, art, names and boundaries.

Reimplemented from StelModule.

float ConstellationMgr::getArtFadeDuration ( ) const

slot

Get constellation art fade duration in second.

double ConstellationMgr::getArtIntensity ( ) const

slot

Set constellation maximum art intensity (between 0 and 1)

Vec3f ConstellationMgr::getBoundariesColor ( ) const

slot

Get current boundary color.

virtual double ConstellationMgr::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.

ConstellationDisplayStyle ConstellationMgr::getConstellationDisplayStyle ( )

slot

get the way how contellation names are displayed: abbbreviated/as-given/translated

double ConstellationMgr::getConstellationLineThickness ( ) const

inlineslot

Get the thickness of lines of the constellations.

Definition at line 248 of file ConstellationMgr.hpp.

bool ConstellationMgr::getFlagArt ( void ) const

slot

Get whether constellation art is displayed.

bool ConstellationMgr::getFlagBoundaries ( void ) const

slot

Get whether constellation boundaries lines are displayed.

bool ConstellationMgr::getFlagConstellationPick ( void ) const

slot

Get whether only one selected constellation is displayed.

bool ConstellationMgr::getFlagIsolateSelected ( void ) const

slot

Get whether selected constellation is displayed alone.

bool ConstellationMgr::getFlagLabels ( void ) const

slot

Set whether constellation names are displayed.

bool ConstellationMgr::getFlagLines ( void ) const

slot

Get whether constellation lines are displayed.

float ConstellationMgr::getFontSize ( ) const

slot

Get the font size used for constellation names display.

Vec3f ConstellationMgr::getLabelsColor ( ) const

slot

Get label color for names.

Vec3f ConstellationMgr::getLinesColor ( ) const

slot

Get line color.

virtual void ConstellationMgr::init ( )

virtual

Initialize the ConstellationMgr.

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

Implements StelModule.

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

virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object English 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

Implements StelObjectModule.

virtual QStringList ConstellationMgr::listMatchingObjectsI18n	(	const QString &	objPrefix,
		int	maxNbItem = `5`,
		bool	useStartOfWords = `false`
	)		const

virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object I18n 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

Implements StelObjectModule.

virtual QList<StelObjectP> ConstellationMgr::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 ConstellationMgr::searchByName ( const QString & name ) const

virtual

Return the matching constellation if exists or NULL.

Parameters

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

Implements StelObjectModule.

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

virtual

Return the matching constellation object's pointer if exists or NULL.

Parameters

nameI18n The case in-sensistive constellation name

Implements StelObjectModule.

void ConstellationMgr::setArtFadeDuration ( const float duration )

slot

Set constellation art fade duration in second.

void ConstellationMgr::setArtIntensity ( const double intensity )

slot

Set constellation maximum art intensity (between 0 and 1)

void ConstellationMgr::setBoundariesColor ( const Vec3f & color )

slot

Define boundary color.

Parameters

color

The color of boundaries

// example of usage in scripts

ConstellationMgr.setBoundariesColor(Vec3f(1.0,0.0,0.0));

void ConstellationMgr::setConstellationDisplayStyle ( int style )

slot

Set the way how contellation names are displayed: abbbreviated/as-given/translated.

Parameters

style acceptable values 0=abbreviated, 1=untranslated, 2=translated.

Note: Will be cast to enum'ed value, but usually receives value from a QComboBox in the GUI.

void ConstellationMgr::setConstellationLineThickness ( const double thickness )

slot

Set the thickness of lines of the constellations.

Parameters

thickness of line in pixels

void ConstellationMgr::setFlagArt ( const bool displayed )

slot

Set whether constellation art will be displayed.

void ConstellationMgr::setFlagBoundaries ( const bool displayed )

slot

Set whether constellation boundaries lines will be displayed.

void ConstellationMgr::setFlagConstellationPick ( const bool mode )

slot

Set whether only one selected constellation must be displayed.

void ConstellationMgr::setFlagIsolateSelected ( const bool isolate )

slot

Set whether selected constellation must be displayed alone.

void ConstellationMgr::setFlagLabels ( const bool displayed )

slot

Set whether constellation names will be displayed.

void ConstellationMgr::setFlagLines ( const bool displayed )

slot

Set whether constellation lines will be displayed.

void ConstellationMgr::setFontSize ( const float newFontSize )

slot

Set the font size used for constellation names display.

void ConstellationMgr::setLabelsColor ( const Vec3f & color )

slot

Set label color for names.

Parameters

color

The color of labels

// example of usage in scripts

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

void ConstellationMgr::setLinesColor ( const Vec3f & color )

slot

Define line color.

Parameters

color

The color of lines

// example of usage in scripts

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

virtual void ConstellationMgr::update ( double deltaTime )

virtual

Updates time-varying state for each Constellation.

Implements StelModule.

Property Documentation

ConstellationDisplayStyle ConstellationMgr::constellationDisplayStyle

readwrite

this controls how constellations (and also star names) are printed: Abbreviated/as-given/translated

Definition at line 93 of file ConstellationMgr.hpp.

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

ConstellationMgr.hpp

Public Types

Public Slots

Signals

Public Member Functions

Properties

loadNames():

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation