Source/System/Window/Utilities/OSGNavigationManager.cpp

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 //---------------------------------------------------------------------------
  40 //  Includes
  41 //---------------------------------------------------------------------------
  42
  43 #include <cstdlib>
  44 #include <cstdio>
  45
  46 #include "OSGConfig.h"
  47 #include "OSGBaseFunctions.h"
  48 #include "OSGImageFileType.h"
  49 #include "OSGSolidBackground.h"
  50 #include "OSGViewport.h"
  51 #include "OSGDrawable.h"
  52 #include "OSGTransform.h"
  53
  54 #include "OSGNavigationManager.h"
  55
  56 #if defined(OSG_WIN32_ICL) && !defined(OSG_CHECK_FIELDSETARG)
  57 #pragma warning (disable : 383)
  58 #endif
  59
  60
  61 OSG_USING_NAMESPACE
  62
  63 /***************************************************************************\
  64  *                            Description                                  *
  65 \***************************************************************************/
  66
  67 /*! \class OSG::NavigationManager
  68     \ingroup GrpSystemWindow
  69
  70     The NavigationManager manages a navigator that is needed to do a
  71     basic navigation within a subscene of a scenegraph (specified by the
  72     beacon). It also takes care of creating the necessary additional OpenSG
  73     objects, like a viewport for the window (if not already present).
  74  */
  75
  76 /*! \var NavigationManager::MouseLeft
  77     The constant for the left mouse button.
  78  */
  79
  80 /*! \var NavigationManager::MouseMiddle
  81     The constant for the middle mouse button.
  82  */
  83
  84 /*! \var NavigationManager::MouseRight
  85     The constant for the right mouse button.
  86  */
  87
  88 /*! \var NavigationManager::MouseUp
  89     The constant for the mouse wheel up (away from the hand) motion.
  90  */
  91
  92 /*! \var NavigationManager::MouseDown
  93     The constant for the mouse wheel down (towards the hand) motion.
  94  */
  95
  96 /*! \var NavigationManager::_win
  97     The managed window. Has to be set by the user.
  98  */
  99
 100 /*! \var NavigationManager::_navigator
 101     The navigator for viewer manipulation.
 102  */
 103
 104 /*! \var NavigationManager::_lastx
 105     The x position of the last mouse event, needed by the navigator.
 106  */
 107
 108 /*! \var NavigationManager::_lasty
 109     The y position of the last mouse event, needed by the navigator.
 110  */
 111
 112 /*! \var NavigationManager::_mousebuttons
 113     Storage for the actively pressed mouse buttons. Needed to do the right
 114     thing for mouse motions, as mouseMove() doesn't get them.
 115  */
 116
 117 /*-------------------------------------------------------------------------*/
 118 /*                            Constructors                                 */
 119
 120 /*! Constructor
 121  */
 122
 123 NavigationManager::NavigationManager(void) :
 124      Inherited   (                           ),
 125     _win         (NULL                       ),
 126     _navigator   (                           ),
 127     _lastx       (TypeTraits<Int16>::getMax()),
 128     _lasty       (TypeTraits<Int16>::getMax()),
 129     _mousebuttons(0                          )
 130 {
 131     _navigator.setMode(Navigator::TRACKBALL);
 132 }
 133
 134
 135 /*! pseudo constructor. Standard interface for OpenSG object creation.
 136  */
 137
 138 NavigationManager::ObjTransitPtr NavigationManager::create(void)
 139 {
 140     return ObjTransitPtr(new NavigationManager);
 141 }
 142
 143 /*! Destructor
 144  */
 145
 146 NavigationManager::~NavigationManager(void)
 147 {
 148     _win = NULL;
 149
 150 }
 151
 152 /*-------------------------------------------------------------------------*/
 153 /*                               Get                                       */
 154
 155 /*! get the window to be used for display
 156  */
 157 Window *NavigationManager::getWindow(void)
 158 {
 159     return _win;
 160 }
 161
 162 /*! get the navigator
 163  */
 164 Navigator *NavigationManager::getNavigator(void)
 165 {
 166     return &_navigator;
 167 }
 168
 169 /*-------------------------------------------------------------------------*/
 170 /*                               Set                                       */
 171
 172 /*! set the window to be used for display
 173  */
 174 void NavigationManager::setWindow(Window *win)
 175 {
 176     if(win == NULL)
 177     {
 178         FWARNING(("NavigationManager::setWindow: new window is NULL, "
 179                   "ignoring!\n"));
 180         return;
 181     }
 182
 183     _win = win;
 184
 185     if(_win->getMFPort()->size() > 0 && _win->getPort(0) != NULL)
 186         _navigator.setViewport(_win->getPort(0));
 187 }
 188
 189 /*! Sets the navigator's camera transformation
 190     If newBeacon is null, a dummy beacon will be added instead.
 191  */
 192 void NavigationManager::setBeacon(Node * const newBeacon)
 193 {
 194     if(newBeacon == NULL)
 195     {
 196         setNavigationMode(Navigator::NONE);
 197
 198         TransformNodeRefPtr xnode = TransformNodeRefPtr::create();
 199
 200         _navigator.setCameraTransformation(xnode);
 201     }
 202     else
 203     {
 204         _navigator.setCameraTransformation(newBeacon);
 205     }
 206 }
 207
 208 /*! Sets the navigation mode
 209  */
 210 void NavigationManager::setNavigationMode (Navigator::Mode new_mode)
 211 {
 212     Matrix m = _navigator.getMatrix();
 213
 214     _navigator.setMode(new_mode);
 215     _navigator.set    (m       );
 216 }
 217
 218 /*-------------------------------------------------------------------------*/
 219 /*                         Interaction handling                            */
 220
 221 /*! resize
 222  */
 223 void NavigationManager::resize(UInt16 width, UInt16 height)
 224 {
 225     _win->resize(width, height);
 226 }
 227
 228 /*! motion
 229  */
 230 void NavigationManager::mouseMove(Int16 x, Int16 y)
 231 {
 232     if(_mousebuttons)
 233         _navigator.moveTo(x,y);
 234
 235     _lastx = x;
 236     _lasty = y;
 237 }
 238
 239 /*! call when a mouse button is pressed. button is the number of the pressed
 240     button, starting at 0, ordered from left to right. A wheel should be
 241     mapped to buttons 3 and 4. The position is in pixel, starting at the
 242     upper left corner.
 243  */
 244
 245 void NavigationManager::mouseButtonPress(UInt16 button, Int16 x, Int16 y)
 246 {
 247     switch (button)
 248     {
 249         case MouseLeft:
 250             _navigator.buttonPress(Navigator::LEFT_MOUSE, x, y);
 251             break;
 252
 253         case MouseMiddle:
 254             _navigator.buttonPress(Navigator::MIDDLE_MOUSE, x, y);
 255             break;
 256
 257         case MouseRight:
 258             _navigator.buttonPress(Navigator::RIGHT_MOUSE, x, y);
 259             break;
 260
 261         case MouseUp:
 262             _navigator.buttonPress(Navigator::UP_MOUSE, x, y);
 263             break;
 264
 265         case MouseDown:
 266             _navigator.buttonPress(Navigator::DOWN_MOUSE, x, y);
 267             break;
 268     }
 269
 270     updateMouseButtonPress(button, x, y);
 271 }
 272
 273
 274 /*! call when a mouse button is released. button is the number of the pressed
 275     button, starting at 0, ordered from left to right. A wheel should be
 276     mapped to buttons 3 and 4. The position is in pixel, starting at the
 277     upper left corner.
 278  */
 279 void NavigationManager::mouseButtonRelease(UInt16 button, Int16 x, Int16 y)
 280 {
 281     switch (button)
 282     {
 283         case MouseLeft:
 284             _navigator.buttonRelease(Navigator::LEFT_MOUSE, x, y);
 285             break;
 286
 287         case MouseMiddle:
 288             _navigator.buttonRelease(Navigator::MIDDLE_MOUSE, x, y);
 289             break;
 290
 291         case MouseRight:
 292             _navigator.buttonRelease(Navigator::RIGHT_MOUSE, x, y);
 293             break;
 294
 295         case MouseUp:
 296             _navigator.buttonRelease(Navigator::UP_MOUSE, x, y);
 297             break;
 298
 299         case MouseDown:
 300             _navigator.buttonRelease(Navigator::DOWN_MOUSE, x, y);
 301             break;
 302     }
 303
 304     updateMouseButtonRelease(button, x, y);
 305 }
 306
 307 void NavigationManager::key(UChar8 key, Int16 x, Int16 y)
 308 {
 309     switch ( key )
 310     {
 311         case 'j':
 312             _navigator.keyPress(Navigator::LEFT, x, y);
 313             break;
 314
 315         case 'g':
 316             _navigator.keyPress(Navigator::RIGHT, x, y);
 317             break;
 318
 319         case 'u':
 320             _navigator.keyPress(Navigator::LEFTROT, x, y);
 321             break;
 322
 323         case 't':
 324             _navigator.keyPress(Navigator::RIGHTROT, x, y);
 325             break;
 326
 327         case 'y':
 328             _navigator.keyPress(Navigator::FORWARDS, x, y);
 329             break;
 330
 331         case 'h':
 332             _navigator.keyPress(Navigator::BACKWARDS, x, y);
 333             break;
 334     }
 335 }
 336
 337 /*-------------------------------------------------------------------------*/
 338 /*                                Actions                                  */
 339
 340 /*! Draw the next frame, update if needed.
 341  */
 342 void NavigationManager::idle(void)
 343 {
 344     _navigator.idle(_mousebuttons, _lastx, _lasty);
 345 }
 346
 347 /*! Update data needed for rendering.
 348  */
 349 void NavigationManager::update(void)
 350 {
 351     // Check necessary stuff
 352     if(_win == NULL)
 353     {
 354         FWARNING(("NavigationManager::update: window not set, "
 355                   "ignoring!\n"));
 356         return;
 357     }
 358
 359     // need a viewport?
 360     if(_win->getMFPort()->size() == 0)
 361     {
 362         SolidBackgroundUnrecPtr bg = SolidBackground::create();
 363
 364         bg->setColor(Color3f(0.2f, 0.2f, 0.2f));
 365
 366         ViewportUnrecPtr vp = Viewport::create();
 367
 368         vp->setSize      (0,0, 1,1);
 369         vp->setBackground(bg);
 370
 371         _win->addPort(vp);
 372         _navigator.setViewport(_win->getPort(0));
 373     }
 374
 375     _navigator.updateCameraTransformation();
 376 }
 377
 378 /*! Draw the next frame, update if needed.
 379  */
 380 void NavigationManager::redraw(void)
 381 {
 382     update();
 383 }
 384
 385 /*-------------------------------------------------------------------------*/
 386 /*                               Updates                                   */
 387
 388 /*! called internally by mouseButtonRelease() to keep track of the
 389     current status of _mousebuttons, _lastx and _lasty
 390  */
 391 void NavigationManager::updateMouseButtonPress(UInt16 button,
 392                                                Int16  x,
 393                                                Int16  y     )
 394 {
 395     _mousebuttons |= 1 << button;
 396
 397     _lastx = x;
 398     _lasty = y;
 399 }
 400
 401
 402 /*! called internally by mouseButtonRelease() to keep track of the
 403     current status of _mousebuttons, _lastx and _lasty
 404  */
 405 void NavigationManager::updateMouseButtonRelease(UInt16 button,
 406                                                  Int16  x,
 407                                                  Int16  y     )
 408 {
 409     _mousebuttons &= ~(1 << button);
 410
 411     _lastx = x;
 412     _lasty = y;
 413 }
 414
 415 /*------------------------------ access -----------------------------------*/
 416
 417 /*---------------------------- properties ---------------------------------*/
 418
 419 /*-------------------------- your_category---------------------------------*/
 420
 421 /*-------------------------- assignment -----------------------------------*/
 422
 423 /*-------------------------- comparison -----------------------------------*/
 424
 425 /*! less
 426  */
 427
 428 bool NavigationManager::operator < (const NavigationManager &other) const
 429 {
 430     return this < &other;
 431 }
 432