Manage the selection and queries on one or more StelObjects.
More...
#include <StelObjectMgr.hpp>
List of all members.
Public Member Functions |
virtual void | init () |
virtual void | draw (StelCore *) |
virtual void | update (double) |
void | registerStelObjectMgr (StelObjectModule *mgr) |
bool | findAndSelect (const StelCore *core, const Vec3d &pos, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection) |
bool | findAndSelect (const StelCore *core, int x, int y, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection) |
bool | findAndSelectI18n (const QString &nameI18n, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection) |
bool | findAndSelect (const QString &name, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection) |
QStringList | listMatchingObjectsI18n (const QString &objPrefix, unsigned int maxNbItem=5) const |
bool | getWasSelected (void) const |
void | unSelect (void) |
bool | setSelectedObject (const StelObjectP obj, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection) |
bool | setSelectedObject (const QList< StelObjectP > &objs, StelModule::StelModuleSelectAction action=StelModule::ReplaceSelection) |
const QList< StelObjectP > & | getSelectedObject () const |
QList< StelObjectP > | getSelectedObject (const QString &type) |
void | setFlagSelectedObjectPointer (bool b) |
bool | getFlagSelectedObjectPointer (void) |
StelObjectP | searchByNameI18n (const QString &name) const |
StelObjectP | searchByName (const QString &name) const |
void | setObjectSearchRadius (float radius) |
void | setDistanceWeight (float newDistanceWeight) |
Detailed Description
Manage the selection and queries on one or more StelObjects.
When the user requests selection of an object, the selectedObjectChangeCallBack method of all the StelModule which are registered is called. Each module is then free to manage object selection as it wants.
Member Function Documentation
virtual void StelObjectMgr::draw |
( |
StelCore * |
core |
) |
[inline, virtual] |
Execute all the drawing functions for this module.
- Parameters:
-
| core | the core to use for the drawing |
Reimplemented from StelModule.
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)
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
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)
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
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 |
virtual void StelObjectMgr::init |
( |
|
) |
[inline, virtual] |
Initialize itself.
If the initialization takes significant time, the progress should be displayed on the loading bar.
Implements StelModule.
QStringList StelObjectMgr::listMatchingObjectsI18n |
( |
const QString & |
objPrefix, |
|
|
unsigned int |
maxNbItem = 5 | |
|
) |
| | 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. |
- Returns:
- a list of matching object names by order of relevance, or an empty list if nothing match
Add a new StelObject manager into the list of supported modules.
Registered modules can have selected objects
void StelObjectMgr::setDistanceWeight |
( |
float |
newDistanceWeight |
) |
[inline] |
Set the weight of the distance factor when choosing the best object to select.
Default to 1.
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
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
virtual void StelObjectMgr::update |
( |
double |
deltaTime |
) |
[inline, virtual] |
Update the module with respect to the time.
- Parameters:
-
| deltaTime | the time increment in second since last call. |
Implements StelModule.