ConstellationMgr Class Reference

Display and manage the constellations. More...

#include <ConstellationMgr.hpp>

List of all members.

Public Slots
void	setFlagArt (const bool displayed)
	Set whether constellation art will be displayed.
bool	getFlagArt (void) const
	Get whether constellation art is displayed.
void	setArtFadeDuration (const float duration)
	Set constellation art fade duration in second.
float	getArtFadeDuration () const
	Get constellation art fade duration in second.
void	setArtIntensity (const double intensity)
	Set constellation maximum art intensity (between 0 and 1).
double	getArtIntensity () const
	Set constellation maximum art intensity (between 0 and 1).
void	setBoundariesColor (const Vec3f &color)
	Define boundary color.
Vec3f	getBoundariesColor () const
	Get current boundary color.
void	setFlagBoundaries (const bool displayed)
	Set whether constellation boundaries lines will be displayed.
bool	getFlagBoundaries (void) const
	Get whether constellation boundaries lines are displayed.
void	setFlagIsolateSelected (const bool isolate)
	Set whether selected constellation must be displayed alone.
bool	getFlagIsolateSelected (void) const
	Get whether selected constellation is displayed alone.
void	setLinesColor (const Vec3f &color)
	Define line color.
Vec3f	getLinesColor () const
	Get line color.
void	setFlagLines (const bool displayed)
	Set whether constellation path lines will be displayed.
bool	getFlagLines (void) const
	Get whether constellation path lines are displayed.
void	setLabelsColor (const Vec3f &color)
	Set label color for names.
Vec3f	getLabelsColor () const
	Get label color for names.
void	setFlagLabels (bool displayed)
	Set whether constellation names will be displayed.
bool	getFlagLabels (void) const
	Set whether constellation names are displayed.
void	setFontSize (const float newFontSize)
	Set the font size used for constellation names display.
float	getFontSize () const
	Get the font size used for constellation names display.
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
Public Member Functions
	ConstellationMgr (StarMgr *stars)
	Constructor.
virtual	~ConstellationMgr ()
	Destructor.
virtual void	init ()
	Initialize the ConstellationMgr.
virtual void	draw (StelCore *core)
	Draw constellation lines, art, names and boundaries.
virtual void	update (double deltaTime)
	Updates time-varying state for each Constellation.
virtual double	getCallOrder (StelModuleActionName actionName) const
	Return the value defining the order of call for the given action.
virtual QList< StelObjectP >	searchAround (const Vec3d &v, double limitFov, const StelCore *core) const
	Search for StelObject in an area around a specifid point.
virtual StelObjectP	searchByNameI18n (const QString &nameI18n) const
	Return the matching constellation object's pointer if exists or NULL.
virtual StelObjectP	searchByName (const QString &name) const
	Return the matching constellation if exists or NULL.
virtual QStringList	listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5) const
	Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name.
Properties
bool	artDisplayed
bool	artFadeDuration
bool	artIntensity
bool	boundariesColor
bool	boundariesDisplayed
bool	fontSize
bool	isolateSelected
bool	linesColor
bool	linesDisplayed
bool	namesColor
bool	namesDisplayed

---

Detailed Description

Display and manage the constellations.

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

---

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.

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::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 path 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::listMatchingObjectsI18n	(	const QString &	objPrefix,
		int	maxNbItem = 5
	)			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

Returns:

a vector of matching object name by order of relevance, or an empty vector if nothing match

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

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::setFlagIsolateSelected

(

const bool

isolate

)

[slot]

Set whether selected constellation must be displayed alone.

void ConstellationMgr::setFlagLabels

(

bool

displayed

)

[slot]

Set whether constellation names will be displayed.

void ConstellationMgr::setFlagLines

(

const bool

displayed

)

[slot]

Set whether constellation path 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.

void ConstellationMgr::setLinesColor

(

const Vec3f &

color

)

[slot]

Define line color.

virtual void ConstellationMgr::update

(

double

deltaTime

)

[virtual]

Updates time-varying state for each Constellation.

Implements StelModule.