Manage the selection and queries on one or more StelObjects. More...

#include <StelObjectMgr.hpp>

Signals
void	selectedObjectChanged (StelModule::StelModuleSelectAction action)
	Indicate that the selected StelObjects has changed. More...

Public Member Functions
virtual void	init ()
	Initialize itself. More...

virtual void	draw (StelCore , class StelRenderer )
	Execute all the drawing functions for this module. More...

virtual void	update (double)
	Update the module with respect to the time. More...

void	registerStelObjectMgr (StelObjectModule *mgr)
	Add a new StelObject manager into the list of supported modules. More...

bool	findAndSelect (const StelCore *core, const Vec3d &pos, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection)
	Find and select an object near given equatorial J2000 position. More...

bool	findAndSelect (const StelCore *core, int x, int y, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection)
	Find and select an object near given screen position. More...

bool	findAndSelectI18n (const QString &nameI18n, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection)
	Find and select an object from its translated name. More...

bool	findAndSelect (const QString &name, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection)
	Find and select an object from its standard program name. More...

QStringList	listMatchingObjectsI18n (const QString &objPrefix, unsigned 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...

QStringList	listMatchingObjects (const QString &objPrefix, unsigned 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...

QStringList	listAllModuleObjects (const QString &moduleId, bool inEnglish) const

QMap< QString, QString >	objectModulesMap () const

bool	getWasSelected (void) const
	Return whether an object was selected during last selection related event. More...

void	unSelect (void)
	Notify that we want to unselect any object. More...

bool	setSelectedObject (const StelObjectP obj, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection)
	Notify that we want to select the given object. More...

bool	setSelectedObject (const QList< StelObjectP > &objs, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection)
	Notify that we want to select the given objects. More...

const QList< StelObjectP > &	getSelectedObject () const
	Get the list objects which was recently selected by the user. More...

QList< StelObjectP >	getSelectedObject (const QString &type)
	Return the list objects of type "withType" which was recently selected by the user. More...

void	setFlagSelectedObjectPointer (bool b)
	Set whether a pointer is to be drawn over selected object. More...

bool	getFlagSelectedObjectPointer (void)
	Get whether a pointer is to be drawn over selected object. More...

StelObjectP	searchByNameI18n (const QString &name) const
	Find any kind of object by its translated name. More...

StelObjectP	searchByName (const QString &name) const
	Find any kind of object by its standard program name. More...

void	setObjectSearchRadius (float radius)
	Set the radius in pixel in which objects will be searched when clicking on a point in sky. More...

void	setDistanceWeight (float newDistanceWeight)
	Set the weight of the distance factor when choosing the best object to select. More...

Public Member Functions inherited from StelModule
virtual void	deinit ()
	Called before the module will be deleted, and before the renderer is destroyed. More...

virtual bool	drawPartial (StelCore core, class StelRenderer renderer)
	Iterate through the drawing sequence. 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 double	getCallOrder (StelModuleActionName actionName) const
	Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations. More...

virtual bool	configureGui (bool show=true)
	Detect or show the configuration GUI elements for the module. More...

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

Detailed Description

Manage the selection and queries on one or more StelObjects.

Each module is then free to manage object selection as it wants.

Definition at line 35 of file StelObjectMgr.hpp.

Member Function Documentation

virtual void StelObjectMgr::draw	(	StelCore *	core,
		class StelRenderer *	renderer
	)

inlinevirtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing
renderer	Renderer to draw with.

Reimplemented from StelModule.

Definition at line 45 of file StelObjectMgr.hpp.

bool StelObjectMgr::findAndSelect	(	const StelCore *	core,
		const Vec3d &	pos,
		StelModule::StelModuleSelectAction	action = `StelModule::ReplaceSelection`
	)

Find and select an object near given equatorial J2000 position.

Parameters

core	the StelCore instance to use for computations
pos	the direction vector around which to search in equatorial J2000
action	define whether to add to, replace, or remove from the existing selection

Returns: true if a object was found at position (this does not necessarily means it is selected)

bool StelObjectMgr::findAndSelect	(	const StelCore *	core,
		int	x,
		int	y,
		StelModule::StelModuleSelectAction	action = `StelModule::ReplaceSelection`
	)

Find and select an object near given screen position.

Parameters

core	the StelCore instance to use for computations
x	the x screen position in pixel
y	the y screen position in pixel
action	define whether to add to, replace, or remove from the existing selection

Returns: true if a object was found at position (this does not necessarily means it is selected)

bool StelObjectMgr::findAndSelect	(	const QString &	name,
		StelModule::StelModuleSelectAction	action = `StelModule::ReplaceSelection`
	)

Find and select an object from its standard program name.

Parameters

action	define whether to add to, replace, or remove from the existing selection
name	the case sensitive object translated name

Returns: true if a object with the passed name was found

bool StelObjectMgr::findAndSelectI18n	(	const QString &	nameI18n,
		StelModule::StelModuleSelectAction	action = `StelModule::ReplaceSelection`
	)

Find and select an object from its translated name.

Parameters

action	define whether to add to, replace, or remove from the existing selection
nameI18n	the case sensitive object translated name

Returns: true if a object with the passed name was found

bool StelObjectMgr::getFlagSelectedObjectPointer ( void )

inline

Get whether a pointer is to be drawn over selected object.

Definition at line 125 of file StelObjectMgr.hpp.

const QList<StelObjectP>& StelObjectMgr::getSelectedObject ( ) const

inline

Get the list objects which was recently selected by the user.

Definition at line 116 of file StelObjectMgr.hpp.

QList<StelObjectP> StelObjectMgr::getSelectedObject ( const QString & type )

Return the list objects of type "withType" which was recently selected by the user.

Parameters

type	return only objects of the given type

bool StelObjectMgr::getWasSelected ( void ) const

inline

Return whether an object was selected during last selection related event.

Definition at line 98 of file StelObjectMgr.hpp.

virtual void StelObjectMgr::init ( )

inlinevirtual

Initialize itself.

If the initialization takes significant time, the progress should be displayed on the loading bar.

Implements StelModule.

Definition at line 44 of file StelObjectMgr.hpp.

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

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 list of matching object names by order of relevance, or an empty list if nothing match

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

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 list of matching object names by order of relevance, or an empty list if nothing match

void StelObjectMgr::registerStelObjectMgr ( StelObjectModule * mgr )

Add a new StelObject manager into the list of supported modules.

Registered modules can have selected objects

StelObjectP StelObjectMgr::searchByName ( const QString & name ) const

Find any kind of object by its standard program name.

StelObjectP StelObjectMgr::searchByNameI18n ( const QString & name ) const

Find any kind of object by its translated name.

void StelObjectMgr::selectedObjectChanged ( StelModule::StelModuleSelectAction action )

signal

Indicate that the selected StelObjects has changed.

Parameters

action define if the user requested that the objects are added to the selection or just replace it

void StelObjectMgr::setDistanceWeight ( float newDistanceWeight )

inline

Set the weight of the distance factor when choosing the best object to select.

Default to 1.

Definition at line 138 of file StelObjectMgr.hpp.

void StelObjectMgr::setFlagSelectedObjectPointer ( bool b )

inline

Set whether a pointer is to be drawn over selected object.

Definition at line 123 of file StelObjectMgr.hpp.

void StelObjectMgr::setObjectSearchRadius ( float radius )

inline

Set the radius in pixel in which objects will be searched when clicking on a point in sky.

Definition at line 134 of file StelObjectMgr.hpp.

bool StelObjectMgr::setSelectedObject	(	const StelObjectP	obj,
		StelModule::StelModuleSelectAction	action = `StelModule::ReplaceSelection`
	)

Notify that we want to select the given object.

Parameters

obj	the StelObject to select
action	action define whether to add to, replace, or remove from the existing selection

Returns: true if at least 1 object was sucessfully selected

bool StelObjectMgr::setSelectedObject	(	const QList< StelObjectP > &	objs,
		StelModule::StelModuleSelectAction	action = `StelModule::ReplaceSelection`
	)

Notify that we want to select the given objects.

Parameters

objs	a vector of objects to select
action	define whether to add to, replace, or remove from the existing selection

Returns: true if at least 1 object was sucessfully selected

void StelObjectMgr::unSelect ( void )

Notify that we want to unselect any object.

virtual void StelObjectMgr::update ( double deltaTime )

inlinevirtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

Definition at line 46 of file StelObjectMgr.hpp.

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

core/StelObjectMgr.hpp

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation