ViewerProperties.hh

Go to the documentation of this file.

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/




//=============================================================================
//
//  Property storage Class for glWidgets
//
//=============================================================================

//
#ifndef VIEWERPROPERTIES_HH
#define VIEWERPROPERTIES_HH


#include <QObject>
#include <QColor>
#include <OpenFlipper/common/GlobalDefines.hh>
#include <ACG/Math/VectorT.hh>
#include <ACG/Scenegraph/SceneGraph.hh>
#include <ACG/Scenegraph/DrawModes.hh>
#include <ACG/GL/GLState.hh>
#include <OpenFlipper/widgets/glWidget/CursorPainter.hh>

// forward declaration
class ViewObjectMarker;

namespace Viewer {

  enum ActionMode {
    ExamineMode,

    PickingMode,

    QuestionMode,

    LightMode
  };

  class DLLEXPORT ViewerProperties : public QObject {

    Q_OBJECT

    public:
      ViewerProperties(int _id);
      ~ViewerProperties();
      
    //===========================================================================
    //===========================================================================      

    public:
      void drawMode(ACG::SceneGraph::DrawModes::DrawMode _mode);
      
      ACG::SceneGraph::DrawModes::DrawMode drawMode();
      
    private:
      
      ACG::SceneGraph::DrawModes::DrawMode currentDrawMode_;

    //===========================================================================
    //===========================================================================

    public slots:
      void snapshotBaseFileName(const QString& _fname);

      void snapshotFileType(const QString& _type);
      
      void snapshotCounter(const int _counter);
      
      QString snapshotFileType();
      
      QString snapshotName();

      int snapshotCounter();

    private:
      QString                      snapshotName_;
      QString                      snapshotFileType_;
      int                          snapshotCounter_;

    //===========================================================================
    //===========================================================================
    //===========================================================================
    //===========================================================================


    public slots:
      double wheelZoomFactor();

      double wheelZoomFactorShift();

      void wheelZoomFactor(double _factor);

      void wheelZoomFactorShift(double _factor);

      bool wheelInvert();

      void wheelInvert(bool _invert);

    private:
      double wZoomFactor_;

      double wZoomFactorShift_;

      bool   wInvert_;

    //===========================================================================
    //===========================================================================
    //===========================================================================
    //===========================================================================

    //===========================================================================
    //===========================================================================
    //===========================================================================
    //===========================================================================

    public slots:
      bool isCCWFront();

      void ccwFront();
      void cwFront();

    private:
      bool CCWFront_;


    //===========================================================================

    public slots:

      ACG::Vec4f backgroundColor();

      QRgb backgroundColorRgb();

      QColor backgroundQColor();

      void backgroundColor( ACG::Vec4f _color );

      void backgroundColor( QRgb _color );

      void backgroundColor( QColor _color );

    private:
      ACG::Vec4f backgroundColor_;


    //===========================================================================

    public slots:
      void lockUpdate();

      void unLockUpdate();

      bool updateLocked();

    private:
      int locked_;


    //===========================================================================

    public slots:
      bool backFaceCulling();

      void backFaceCulling(bool _state );

    private:
      bool backFaceCulling_;

    //===========================================================================

    public slots:
      void twoSidedLighting(bool _state );

      bool twoSidedLighting();

    private:
      bool twoSidedLighting_;
      
    //===========================================================================

    public slots:
      void multisampling(bool _state );

      bool multisampling();

    private:
      bool multisampling_;
      
    //===========================================================================

    public slots:
      void mipmapping(bool _state );

      bool mipmapping();

    private:
      bool mipmapping_;

    //===========================================================================

    public slots:
      void animation(bool _state );

      bool animation();

    private:
      bool animation_;


    //===========================================================================

    public:
      ACG::GLState& glState();
      const ACG::GLState& glState() const;

      void setglState(ACG::GLState* _glState);

    private:
      ACG::GLState* glState_;

    //===========================================================================

    public slots:
      void objectMarker (ViewObjectMarker* _marker);

      ViewObjectMarker* objectMarker();

    private:
      ViewObjectMarker *objectMarker_;

    //===========================================================================

    public:
      int currentViewingDirection();

      void currentViewingDirection(int _dir);

    private:
      int currentViewingDirection_;
      
    //===========================================================================

    public:
      bool rotationLocked();

      void rotationLocked(bool _lock);

    private:
      bool rotationLocked_;

    //===========================================================================

    //===========================================================================
    //===========================================================================
    //===========================================================================
    //===========================================================================

    public:
      
      double orthoWidth();
      
      void orthoWidth(double _width);
      
      
      double nearPlane();
      
      void setPlanes( double _near, double _far  );
      
      double farPlane();
      
      ACG::Vec3d sceneCenter();
      
      void sceneCenter(ACG::Vec3d _center);

      
      double sceneRadius();
      
      void sceneRadius(double _radius );
      
      
      ACG::Vec3d trackballCenter();
      
      void trackballCenter(ACG::Vec3d _center);
      
      
      double trackballRadius();
      
      void trackballRadius(double _radius );
      
    private:
      
      double orthoWidth_;
      
      double nearPlane_;
      
      double farPlane_;
      
      ACG::Vec3d sceneCenter_;
      
      double sceneRadius_;
      
      ACG::Vec3d trackballCenter_;
      
      double trackballRadius_;
      
    //===========================================================================
    //===========================================================================
    //===========================================================================
    //===========================================================================
    
    public:

      void stereo(bool _stereo);
      bool stereo();

    private:
      bool stereo_;


    //===========================================================================
    //===========================================================================
    //===========================================================================
    //===========================================================================

    public:
      CursorPainter* cursorPainter();
      void cursorPainter( CursorPainter* _painter );

      ACG::Vec3d cursorPoint3D();
      void cursorPoint3D(ACG::Vec3d _pos);

      bool cursorPositionValid();
      void cursorPositionValid(bool _valid);

    private:

      // Used to draw the current cursor in the scene
      CursorPainter *cursorPainter_;

      // position of the cursor picked into the scenegraph
      ACG::Vec3d cursorPoint3D_;

      // indicates that we successfully mapped the cursor into the scene
      bool cursorPositionValid_;

    signals:

      void updated();

      void drawModeChanged(int _viewerId );

      void getPickMode(std::string& _mode );
      void setPickMode(const std::string&  _mode );

      void getActionMode(Viewer::ActionMode& _am);
      void setActionMode(const Viewer::ActionMode  _am);

    public:

      std::string pickMode();

      void pickMode(const std::string& _name);

      Viewer::ActionMode actionMode();

      void actionMode(const Viewer::ActionMode _am);

    //===========================================================================
    //===========================================================================
    //===========================================================================
    //===========================================================================

      int viewerId();

      void viewerId(int _id);

    private:

      int viewerId_;

      QString settingsSection_;

  };

}


#endif //VIEWERPROPERTIES_HH