ViewerProperties.hh 8.27 KB
Newer Older
Jan Möbius's avatar
 
Jan Möbius committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
//=============================================================================
//
//                               OpenFlipper
//        Copyright (C) 2008 by Computer Graphics Group, RWTH Aachen
//                           www.openflipper.org
//
//-----------------------------------------------------------------------------
//
//                                License
//
//  OpenFlipper is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  OpenFlipper 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 for more details.
//
//  You should have received a copy of the GNU Lesser General Public License
//  along with OpenFlipper.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
//
//   $Revision: 4482 $
//   $Author: moebius $
//   $Date: 2009-01-28 11:12:14 +0100 (Mi, 28. Jan 2009) $
//
//=============================================================================




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

/**
 * \file ViewerProperties.hh
 * This file contains a class for managing all viewer settings
 */

//
#ifndef VIEWERPROPERTIES_HH
#define VIEWERPROPERTIES_HH

#include <QObject>
51
#include <ACG/Math/VectorT.hh>
52
#include <ACG/Scenegraph/SceneGraph.hh>
53
#include <ACG/GL/GLState.hh>
Jan Möbius's avatar
 
Jan Möbius committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

namespace Viewer {

  /// How to react on mouse events?
  enum ActionMode {
    // examine geometry, get transformations from mouse events
    ExamineMode,
    /** Picking mode. Actually no pick()ing is performed (!) but events are
        forwarded to the application via signalMouseEvent().
      */
    PickingMode,
    // same as picking, but emit signalMouseEventIdentify()
    QuestionMode,
    // Ligh rotation mode
    LightMode
  };

  class ViewerProperties : public QObject {

    Q_OBJECT

    public:
      ViewerProperties();
      ~ViewerProperties();

    //===========================================================================
    /** @name Action Mode States
    * @{ */
    //===========================================================================

    public slots:

      bool examineMode() { return(actionMode_ == Viewer::ExamineMode  ); };
      bool pickingMode() { return(actionMode_ == Viewer::PickingMode  ); };
      bool lightMode()   { return(actionMode_ == Viewer::LightMode    ); };
      bool questionMode(){ return(actionMode_ == Viewer::QuestionMode ); };

      /** Set action mode.
        The ActionMode determines the type of reaction on mouse events.
      */
      void setExamineMode() { actionMode(Viewer::ExamineMode  ); };
      void setPickingMode() { actionMode(Viewer::PickingMode  ); };
      void setLightMode()   { actionMode(Viewer::LightMode    ); };
      void setQuestionMode(){ actionMode(Viewer::QuestionMode ); };

    public:
      void               actionMode(Viewer::ActionMode _am);
      Viewer::ActionMode actionMode() { return actionMode_; };
      Viewer::ActionMode lastActionMode() { return lastActionMode_; };

    private :
      Viewer::ActionMode actionMode_, lastActionMode_;

    /** @} */


    //===========================================================================
111
    /** @name Snapshot settings
Jan Möbius's avatar
 
Jan Möbius committed
112 113 114
    * @{ */
    //===========================================================================

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
    public slots:
      /** Set the base file name and reset the counter for snapshots.

        The image file format is determined from the file name extension,
        the \a QImageIO formats are supported (e.g. ".ppm" [raw], ".png").

        The current snapshot counter will be added in front of the last "."
        in the filename.

        \a Note: Calling snapshotBaseFileName() will always reset the snapshot
        counter to 0.
      */
      void snapshotBaseFileName(const QString& _fname);

      /** Get the name for the current snapshot */
      QString snapshotName() { return snapshotName_; };

      /** Get the counter for the current snapshot and increases the counter */
      int snapshotCounter() { return snapshotCounter_++; };
Jan Möbius's avatar
 
Jan Möbius committed
134

135 136 137
    private:
      QString                      snapshotName_;
      int                          snapshotCounter_;
Jan Möbius's avatar
 
Jan Möbius committed
138 139 140

    /** @} */

141
    //===========================================================================
142 143 144 145
    //===========================================================================
    /** @name Rendering Settings
    * @{ */
    //===========================================================================
146 147
    //===========================================================================

148 149 150 151 152 153 154 155 156 157 158 159 160
    public slots:
      /** true if counter clockwise orientation should be used to define front facing orientation.
       */
      bool isCCWFront(){ return CCWFront_; };

      /// Set counter clockwise orientation as front
      void ccwFront() { CCWFront_ = true; emit updated(); };
      /// Set clockwise orientation as front
      void cwFront() { CCWFront_ = false; emit updated(); };

    private:
      bool CCWFront_;

161 162 163

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

164 165 166 167 168 169 170 171 172 173 174 175
    public slots:

      /// Get current background color
      ACG::Vec4f backgroundColor() { return backgroundColor_; }

      /** Set background color.
      */
      void backgroundColor( ACG::Vec4f _color ) { backgroundColor_ = _color; emit updated(); };

    private:
      ACG::Vec4f backgroundColor_;

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
    //===========================================================================

    public slots:

      /// Render picking or not
      bool renderPicking() { return renderPicking_; };

      /// Mode used for the picking renderer
      ACG::SceneGraph::PickTarget renderPickingMode() { return pickRendererMode_; };

      void renderPickin(bool _mode ) { renderPicking_ = _mode; emit updated(); };

      /** Use this function to switch the viewer to visualize picking.
      * When you set this function to true the renderer will render the picking
      * elements rather then the scene
      */
      void renderPicking(bool _renderPicking, ACG::SceneGraph::PickTarget _mode) {
        pickRendererMode_ = _mode ; renderPicking_ = _renderPicking; emit updated();
      }

    private:
      /** This variable controls if the scene is rendered in normal or in picking mode
      */
      bool renderPicking_;

      /** If rendering is in picking mode, this variable controls which picking targets
      * will be rendered. ( see renderPicking_ , renderPicking(bool _renderPicking, PickRendererMode _mode) ,
      * and ACG::SceneGraph::PickTarget
      */
      ACG::SceneGraph::PickTarget pickRendererMode_;

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

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

    public slots:
      /** Lock update of display.
      If locked (isUpdateLocked()) then all calls to updateDisplayList()
      and updateGL() will have no effect! This is true until the display is
      unlockUpdate()'ed.
      */
      void lockUpdate()  { locked_++; };

      /// Unlock display locked by updateLock().
      void unLockUpdate(){
        locked_-- ;
        if ( locked_ <0 ) {
          std::cerr << "More unlocks then locks" << std::endl;
          locked_ = 0;
        }
      };

      /** Are updateDisplayList() and updateGL() locked?
      (c.f. lockUpdate()) */
      bool updateLocked() { return (locked_ != 0); };

    private:
      int locked_;

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

    public:
      /// Get the glState of the Viewer
      ACG::GLState& glState() { return (*glState_); };

      void setglState(ACG::GLState* _glState) { glState_ = _glState; };

    private:
      /// Pointer to the glState of the Viewer
      ACG::GLState* glState_;


247
    /** @} */
Jan Möbius's avatar
 
Jan Möbius committed
248 249 250 251 252 253 254

    signals:
      /** \brief This signal is emitted when the configuration has been changed
      */
      void updated();

      void actionModeChanged( Viewer::ActionMode );
255 256


Jan Möbius's avatar
 
Jan Möbius committed
257 258 259 260 261 262
  };

}


#endif //VIEWERPROPERTIES_HH