create/src/Gui/View3DInventor.h

/***************************************************************************
 *   Copyright (c) 2004 Jürgen Riegel <juergen.riegel@web.de>              *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Library General Public           *
 *   License as published by the Free Software Foundation; either          *
 *   version 2 of the License, or (at your option) any later version.      *
 *                                                                         *
 *   This library  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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/

#ifndef GUI_VIEW3DINVENTOR_H
#define GUI_VIEW3DINVENTOR_H

#include <memory>
#include <optional>
#include <QImage>

#include <Base/Parameter.h>

#include "MDIView.h"

#include "Base/Vector3D.h"

class QPrinter;
class QOpenGLWidget;
class QStackedWidget;

namespace Gui {

class Document;
class View3DInventorViewer;
class View3DPy;
class View3DSettings;
class NaviCubeSettings;

struct RayPickInfo
{
    bool isValid;
    Base::Vector3d point;
    std::string document;
    std::string object;
    std::optional<std::string> parentObject;
    std::optional<std::string> component;
    std::optional<std::string> subName;
};
class GuiExport GLOverlayWidget : public QWidget
{
    Q_OBJECT

public:
    explicit GLOverlayWidget(QWidget* parent=nullptr) : QWidget(parent)
    {}
    ~GLOverlayWidget() override = default;
    virtual void setImage(const QImage& img)
    { image = img; }
    void paintEvent(QPaintEvent*) override;

protected:
    QImage image;
};

/** The 3D view window
 *  It consists out of the 3D view
 *  \author Juergen Riegel
 */
class GuiExport View3DInventor : public MDIView
{
    Q_OBJECT

    TYPESYSTEM_HEADER_WITH_OVERRIDE();

public:
    View3DInventor(Gui::Document* pcDocument, QWidget* parent, const QOpenGLWidget* sharewidget = nullptr, Qt::WindowFlags wflags=Qt::WindowFlags());
    ~View3DInventor() override;

    View3DInventor* clone() override;

    /// Message handler
    bool onMsg(const char* pMsg, const char** ppReturn) override;
    bool onHasMsg(const char* pMsg) const override;
    void deleteSelf() override;
    /// get called when the document is updated
    void onRename(Gui::Document *pDoc) override;
    void onUpdate() override;
    void viewAll() override;
    const char *getName() const override;

    /// print function of the view
    void print() override;
    void printPdf() override;
    void printPreview() override;
    void print(QPrinter*) override;

    PyObject *getPyObject() override;
    /**
     * If \a b is set to \a FullScreen the MDI view is displayed in full screen mode, if \a b
     * is set to \a TopLevel then it is displayed as an own top-level window, otherwise (\a Normal)
     * as tabbed window.
     * This method is reimplemented from MDIView to set the this widget as the proxy of the embedded
     * GL widget to get all key events in \a TopLevel or \a Fullscreen mode.
     */
    void setCurrentViewMode(ViewMode b) override;
    RayPickInfo getObjInfoRay(Base::Vector3d* startvec,
                                 Base::Vector3d* dirvec);
    bool setCamera(const char* pCamera);
    void toggleClippingPlane();
    bool hasClippingPlane() const;

    void setOverlayWidget(QWidget*);
    void removeOverlayWidget();

    View3DInventorViewer *getViewer() const {return _viewer;}
    bool containsViewProvider(const ViewProvider*) const override;

public Q_SLOTS:
    /// override the cursor in this view
    void setOverrideCursor(const QCursor&) override;
    void restoreOverrideCursor() override;

    void dump(const char* filename, bool onlyVisible=false);

protected Q_SLOTS:
    void stopAnimating();

private:
    void applySettings();

protected:
    void windowStateChanged(QWidget* view) override;
    void dropEvent        (QDropEvent      * e) override;
    void dragEnterEvent   (QDragEnterEvent * e) override;
    void keyPressEvent    (QKeyEvent       * e) override;
    void keyReleaseEvent  (QKeyEvent       * e) override;
    void focusInEvent     (QFocusEvent     * e) override;
    void customEvent      (QEvent          * e) override;
    void contextMenuEvent (QContextMenuEvent*e) override;

private:
    View3DInventorViewer * _viewer;
    PyObject *_viewerPy;
    QTimer * stopSpinTimer;
    QStackedWidget* stack;
    std::unique_ptr<View3DSettings> viewSettings;
    std::unique_ptr<NaviCubeSettings> naviSettings;

    // friends
    friend class View3DPy;
};

} // namespace Gui

#endif  // GUI_VIEW3DINVENTOR_H