Viewer.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK 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 Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifndef VIEWER_H
#define VIEWER_H
 
// -- Core stuff
#include "CamiTKAPI.h"
 
// -- QT stuff
#include <QObject>
#include <QPixmap>
#include <QUuid>
 
// -- QT stuff classes
class QToolBar;
class QMenu;
class QPixMap;
class QWidget;
class QDockWidget;
class QLayout;
 
namespace camitk {
class Component;
class ViewerExtension;
class Property;
class PropertyObject;
class ViewerDockStyle;

class CAMITK_API Viewer : public QObject {
    Q_OBJECT
 
public:

    enum ViewerType {
        EMBEDDED,    
        DOCKED,      
    };
 
    Q_ENUM(ViewerType)
 
    
    Viewer(QString name, ViewerType type = EMBEDDED);

    virtual ~Viewer() override;

    QString getName() const {
        return name;
    };

    void setDescription(QString);

    QString getDescription() const {
        return description;
    };

    bool setUuid(QUuid id) {
        if (uuid.isNull()) {
            uuid = id;
            return true;
        }
        else {
            return false;
        }
    }

    QUuid getUuid() const {
        return uuid;
    }

    void setType(ViewerType);

    ViewerType getType() const;

    virtual bool setDockWidget(QDockWidget*);

    virtual QDockWidget* getDockWidget() const;

    virtual bool setEmbedder(QLayout*);

    virtual QLayout* getEmbedder() const;

    virtual void refresh(Viewer* whoIsAsking = nullptr) = 0;

    virtual PropertyObject* getPropertyObject() {
        return nullptr;
    };

    virtual QMenu* getMenu() {
        return nullptr;
    };

    virtual QToolBar* getToolBar() {
        return nullptr;
    };

    virtual void setVisible(bool);

    virtual void setToolBarVisibility(bool);

    virtual bool getToolBarVisibility() const;

    virtual QPixmap getIcon() const;

    QStringList getComponentClassNames() const;
 
signals:

    void selectionChanged();
 
protected:
    virtual QWidget* getWidget() = 0;

    void selectionChanged(ComponentList& compSet);

    void selectionChanged(Component* comp);

    void clearSelection();

    void setIcon(QPixmap icon);

    void setComponentClassNames(QStringList);
 
private:
    QString name;

    QString description;

    bool toolbarVisibility;

    QPixmap icon;

    ViewerDockStyle* dockWidgetStyle;

    QStringList componentClassNames;

    ViewerType type;

    QDockWidget* dockWidget;

    QLayout* embedder;

    QUuid uuid;
};
 
}
 
#endif // VIEWER_H