StelObjectMgr.hpp

/*
 * Stellarium
 * Copyright (C) 2007 Fabien Chereau
 * Copyright (C) 2016 Marcos Cardinot
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _STELOBJECTMGR_HPP_
#define _STELOBJECTMGR_HPP_

#include "VecMath.hpp"
#include "StelModule.hpp"
#include "StelObject.hpp"

#include <QList>
#include <QString>

class StelObjectModule;
class StelCore;

class StelObjectMgr : public StelModule
{
    Q_OBJECT
public:
    StelObjectMgr();
    virtual ~StelObjectMgr();

    // Methods defined in the StelModule class
    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 listMatchingObjects(const QString& objPrefix, unsigned int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=true) const;

    QStringList listAllModuleObjects(const QString& moduleId, bool inEnglish) const;
    QMap<QString, QString> objectModulesMap() const;

    bool getWasSelected(void) const {return !lastSelectedObjects.empty();}

    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 {return lastSelectedObjects;}

    QList<StelObjectP> getSelectedObject(const QString& type);

    void setFlagSelectedObjectPointer(bool b) {objectPointerVisibility=b;}
    bool getFlagSelectedObjectPointer(void) {return objectPointerVisibility;}

    StelObjectP searchByNameI18n(const QString &name) const;

    StelObjectP searchByName(const QString &name) const;

    void setObjectSearchRadius(float radius) {searchRadiusPixel=radius;}

    void setDistanceWeight(float newDistanceWeight) {distanceWeight=newDistanceWeight;}

    static QVariantMap getObjectInfo(const StelObjectP obj);

signals:
    void selectedObjectChanged(StelModule::StelModuleSelectAction);

private:
    // The list of StelObjectModule that are referenced in Stellarium
    QList<StelObjectModule*> objectsModule;
    // The last selected object in stellarium
    QList<StelObjectP> lastSelectedObjects;
    // Should selected object pointer be drawn
    bool objectPointerVisibility;

    StelObjectP cleverFind(const StelCore* core, const Vec3d& pos) const;

    StelObjectP cleverFind(const StelCore* core, int x, int y) const;

    // Radius in pixel in which objects will be searched when clicking on a point in sky.
    float searchRadiusPixel;

    // Weight of the distance factor when choosing the best object to select.
    float distanceWeight;
};

#endif // _SELECTIONMGR_HPP_