RendererWidget.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2024 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 RENDERERWIDGET_H
#define RENDERERWIDGET_H
 
#ifdef CAMITK_ERROR
#error "Header Error: headers reordering required. Please include Log.h after including RendererWidget.h and InteractiveViewer.h or any OpenGL window based class."
#endif
 
// -- Core stuff
#include "CamiTKAPI.h"
#include "ScreenshotFormatInfo.h"
 
// -- VTK stuff
#include <vtkVersion.h>
// disable warning generated by clang about the surrounded headers
#include <CamiTKDisableWarnings>
#include <QVTKInteractor.h>
#include <CamiTKReEnableWarnings>
 
#if VTK_MAJOR_VERSION == 6
#include <QVTKWidget2.h>
// additional needed headers for QVTKWidget2
#include <vtkGenericOpenGLRenderWindow.h>
 
#elif VTK_MAJOR_VERSION == 7
// Silence depreciation warning on VTK7 in QVTKWidget constructor
// due to Qt::WindowFlags initialized to 0
// -Wno-deprecated-declarations
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
#ifdef QT_WARNING_DISABLE_DEPRECATED
QT_WARNING_PUSH QT_WARNING_DISABLE_DEPRECATED
#endif
 
#include <QVTKWidget.h>
 
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic pop
#endif
#ifdef QT_WARNING_DISABLE_DEPRECATED
QT_WARNING_POP
#endif
 
#include <vtkSmartPointer.h>
 
 
#elif VTK_MAJOR_VERSION == 8
#include <QVTKOpenGLWidget.h>
#include <vtkSmartPointer.h>
 
#elif VTK_MAJOR_VERSION == 9
#include <QVTKOpenGLStereoWidget.h>
 
#else
#error "Invalid VTK version: not (yet) supported."
 
#endif
 
// -- VTK stuff classes
class vtkInteractorStyle;
class vtkRenderer;
class vtkPicker;
class vtkProp;
class vtkActor;
class vtkActor2D;
class vtkScalarBarActor;
class vtkEventQtSlotConnect;
class vtkCallbackCommand;
class vtkCamera;
class vtkAxesActor;
class vtkAnnotatedCubeActor;
class vtkScalarBarWidget;
class vtkTextMapper;
class vtkAbstractPropPicker;
class vtkLogoWidget;
 
namespace camitk {
 
class vtkInteractorStylePick;
 
#if VTK_MAJOR_VERSION == 6
class CAMITK_API RendererWidget : public QVTKWidget2 {
 
#elif VTK_MAJOR_VERSION == 7
class CAMITK_API RendererWidget : public QVTKWidget {
 
#elif VTK_MAJOR_VERSION == 8
class CAMITK_API RendererWidget : public QVTKOpenGLWidget {
 
#elif VTK_MAJOR_VERSION == 9
class CAMITK_API RendererWidget : public QVTKOpenGLStereoWidget {
 
#else
#error "Invalid VTK version: not (yet) supported."
#endif
    Q_OBJECT
 
public :
 
    enum CameraOrientation {
        RIGHT_DOWN,  
        LEFT_UP,     
        RIGHT_UP,    
        LEFT_BACK,   
        BACK_DOWN,   
    };
    Q_ENUM(CameraOrientation) // so that it can be used in property editor
 
    
    enum ControlMode {
        JOYSTICK,       
        TRACKBALL,      
        TRACKBALL_2D,   
        NONE
    };
    Q_ENUM(ControlMode)
 
    
    enum MouseButtonState {
        NO_BUTTON,      
        LEFT_BUTTON,    
        MIDDLE_BUTTON,  
        RIGHT_BUTTON    
    };
 
    RendererWidget(QWidget* parent = nullptr, ControlMode mode = RendererWidget::TRACKBALL);
 
    ~RendererWidget() override;
 
 
    void setAreaPicking(bool areaPicking);
 
    ControlMode getControlMode() const;
 
    void setControlMode(ControlMode mode);
 
    void setPicker(vtkSmartPointer<vtkAbstractPropPicker> woodyWood);
 
    void pick();
 
    void pickActor(int, int);
 
    void keyPressEvent(QKeyEvent* e) override;
 
    void screenshot(QString filename);
 
    void refresh();
 
    void setBackfaceCulling(bool);
 
    bool getBackfaceCulling() const;
 
    void setFxaaAntialiasing(bool);
 
    bool getFxaaAntialiasing() const;
 
    void setCameraOrientation(RendererWidget::CameraOrientation);
 
    RendererWidget::CameraOrientation getCameraOrientation() const;
 
    void setLightFollowCamera(bool);
 
    bool getLightFollowCamera() const;
 
    void setPointSize(double size);
 
    double getPointSize() const;
 
    void rotateCamera(double angle, int axe);
 
    void resetCamera();
 
    void resetCamera(double* bounds);
 
    void getCameraSettings(double* position, double* focalPoint, double* viewUp);
 
    void setActiveCamera(vtkCamera* cam);
 
    vtkCamera* getActiveCamera();
 
    void getMouse3DCoordinates(double& x, double& y, double& z);
 
    void setBackgroundColor(double, double, double);
 
    void getBackgroundColor(double&, double&, double&);
 
    bool getGradientBackground();
 
    void setGradientBackground(bool);
 
    void toogle3DRedBlue();
 
    void toggleLogo(bool);
 
    void toggleAxes(bool);
 
    void updateAxes();
 
    void toggleOrientationDecorations(bool);
 
    void setOrientationDecorationsLetters(QString letters[4]);
 
    void setColorScale(bool);
 
    bool getColorScale() const;
 
    void setColorScaleMinMax(double m, double M);
 
    void setColorScaleTitle(QString t);
 
    void computeVisiblePropBounds(double* bounds);
 
    void resetClippingPlanes(double* bounds = nullptr);
 
 
    void addProp(vtkSmartPointer<vtkProp> p, bool refresh = false);
 
    bool containsProp(vtkSmartPointer<vtkProp>);
 
    void removeProp(vtkSmartPointer<vtkProp> p, bool refresh = false);
 
    void actorTransform(vtkSmartPointer<vtkActor>, double*, int, double**, double*, double*);
 
protected slots:
    void startPicking();
 
    void endPicking();
 
 
signals :
 
    void actorPicked(vtkSmartPointer<vtkPicker>);
 
    void rightButtonPressed();
 
protected:
 
    void mousePressEvent(QMouseEvent* event) override;
 
    void mouseReleaseEvent(QMouseEvent* event) override;
 
    void mouseMoveEvent(QMouseEvent* event) override;
 
protected :
 
    vtkSmartPointer<QVTKInteractor> renderWindowInteractor;
 
    vtkSmartPointer<vtkInteractorStyle> controlInteractorStyle;
 
    ControlMode controlMode;
 
 
    void resetCameraSettings();
 
    vtkSmartPointer<vtkRenderer> renderer;
 
    bool backfaceCulling;
 
    // Is FXAA antialiasing on?
    bool fxaaAntialiasing;
 
    CameraOrientation cameraOrientation;
 
    bool lightFollowCamera;
 
    double pointSize;
 
    bool rendering3DRedBlue;
 
    //vtkSmartPointer<vtkEventQtSlotConnect> connector;
 
    static void divertionCallback(vtkObject*, unsigned long, void*, void*) {};
 
    vtkSmartPointer<vtkCallbackCommand> pickingButtonDiverter;
 
    bool pickingDiverter;
 
    vtkSmartPointer<vtkInteractorStylePick> pickInteractorStyle;
 
 
    bool displayGradient;
 
    bool displayLogo;
 
    vtkSmartPointer<vtkLogoWidget> logoWidget;
 
    bool displayColorScale;
 
    vtkSmartPointer<vtkScalarBarActor> colorScale;
 
    vtkSmartPointer<vtkScalarBarWidget> colorBarWidget;
 
    vtkSmartPointer<vtkAxesActor> axes;
 
    vtkSmartPointer<vtkAnnotatedCubeActor> annotatedCube;
 
    vtkSmartPointer<vtkActor2D> orientationDecorationActors[4];
 
    vtkSmartPointer<vtkTextMapper> orientationDecorationsTextMapper[4];
 
 
};
 
}
 
#endif //RENDERERWIDGET_H