Source/System/Window/Utilities/OSGFlyEngine.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 #include "OSGConfig.h"
  40 #include "OSGBaseTypes.h"
  41 #include "OSGMatrix.h"
  42 #include "OSGMatrixUtility.h"
  43
  44 #include "OSGFlyEngine.h"
  45 #include "OSGNavigator.h"
  46 #include "OSGNode.h"
  47 #include "OSGCamera.h"
  48 #include "OSGBackground.h"
  49
  50 OSG_USING_NAMESPACE
  51
  52 /***************************************************************************\
  53  *                            Description                                  *
  54 \***************************************************************************/
  55
  56 /*! \class OSG::FlyEngine
  57     \ingroup GrpSystemWindowNavigators
  58
  59 The FlyEngine models a simple flying navigation model, see \ref
  60 PageSystemWindowNavigatorsFly for a description.
  61
  62 */
  63
  64 /*! \var OSG::FlyEngine::_rFrom
  65
  66     The from point, i.e. the viewer position.
  67 */
  68
  69 /*! \var OSG::FlyEngine::_rAt
  70
  71     The at point, i.e. the target position.
  72 */
  73
  74 /*! \var OSG::FlyEngine::_vUp
  75
  76     The up vector.
  77 */
  78
  79 /*! \var OSG::FlyEngine::_tMatrix
  80
  81     The transformation matrix for this navigator.
  82 */
  83
  84 /*------------------------- constructors ----------------------------------*/
  85
  86 FlyEngineTransitPtr FlyEngine::create(void)
  87 {
  88     return FlyEngineTransitPtr(new FlyEngine);
  89 }
  90
  91 /*------------------------------ get --------------------------------------*/
  92
  93 /*! Get the from point.
  94 */
  95 const Pnt3f &FlyEngine::getFrom(void)
  96 {
  97     return _rFrom;
  98 }
  99
 100 /*! Get the at point.
 101 */
 102 const Pnt3f &FlyEngine::getAt(void)
 103 {
 104     return _rAt;
 105 }
 106
 107 /*! Get the up vector.
 108 */
 109 const Vec3f &FlyEngine::getUp(void)
 110 {
 111     return _vUp;
 112 }
 113
 114 /*! Get the current transformation matrix.
 115 */
 116 const Matrix &FlyEngine::getMatrix(void)
 117 {
 118     MatrixLookAt(_tMatrix, _rFrom, _rAt, _vUp);
 119
 120     return _tMatrix;
 121 }
 122
 123 /*! Not needed by FlyEngine!!!
 124 */
 125 // FIXME: remove getDistance() from NavigatorEngine???
 126 Real32 FlyEngine::getDistance(void)
 127 {
 128     return 0.0f;
 129 }
 130
 131 /*------------------------------ set --------------------------------------*/
 132
 133 /*! Set the from point, the point where the viewer is (i.e the center
 134     of all transformations).
 135 */
 136 void FlyEngine::setFrom(Pnt3f new_from)
 137 {
 138     _rFrom = new_from;
 139 }
 140
 141 /*! Sets the target point at which the viewer is looking.
 142 */
 143 void FlyEngine::setAt(Pnt3f new_At)
 144 {
 145     _rAt = new_At;
 146 }
 147
 148 /*! Sets the up vector, i.e. the direction that point up on the screen.
 149 */
 150 void FlyEngine::setUp(Vec3f new_up)
 151 {
 152     _vUp = new_up;
 153 }
 154
 155 /*! Set the position and the orientation at once.
 156 */
 157 void FlyEngine::set(Pnt3f new_from,Pnt3f new_At,Vec3f new_up)
 158 {
 159     _rFrom = new_from;
 160     _rAt   = new_At;
 161     _vUp   = new_up;
 162 }
 163
 164 /*! Set the position and the orientation at once using a matrix.
 165 */
 166 void FlyEngine::set(const Matrix &new_matrix)
 167 {
 168     _rFrom = Pnt3f(new_matrix[3]);
 169     _rAt   = Pnt3f(new_matrix[3] - new_matrix[2]);
 170     _vUp   = Vec3f(new_matrix[1]);
 171
 172     set(_rFrom, _rAt, _vUp);
 173 }
 174
 175 /*! Moves dist steps forward
 176 */
 177 void FlyEngine::setDistance(Real32 dist)
 178 {
 179     forward(dist);
 180 }
 181
 182 /*---------------------- navigator engine callbacks ------------------------*/
 183
 184 void FlyEngine::buttonPress(Int16 button, Int16 x, Int16 y, Navigator* nav)
 185 {
 186     switch (button)
 187     {
 188         case Navigator::LEFT_MOUSE:
 189             _currentState = Navigator::TRANSLATING_ZPLUS;
 190             break;
 191
 192         case Navigator::MIDDLE_MOUSE:
 193             _currentState = Navigator::ROTATING;
 194             break;
 195
 196         case Navigator::RIGHT_MOUSE:
 197             _currentState = Navigator::TRANSLATING_ZMINUS;
 198             break;
 199
 200         case Navigator::UP_MOUSE:
 201             _currentState = Navigator::IDLE;
 202
 203             forward(-nav->getMotionFactor());
 204
 205             break;
 206
 207         case Navigator::DOWN_MOUSE:
 208             _currentState = Navigator::IDLE;
 209
 210             forward(nav->getMotionFactor());
 211
 212             break;
 213
 214         default:
 215             FNOTICE(("FlyEngine: buttonPress, unknown button\n"));
 216             break;
 217     }
 218 }
 219
 220 void FlyEngine::buttonRelease(Int16 button, Int16 x,Int16 y,Navigator* nav)
 221 {
 222     _currentState = Navigator::IDLE;
 223 }
 224
 225 void FlyEngine::keyPress(Int16 key, Int16 x,Int16 y,Navigator* nav)
 226 {
 227     switch (key)
 228     {
 229         case Navigator::LEFTROT:
 230             rotate(-nav->getRotationAngle(), 0);
 231             break;
 232         case Navigator::RIGHTROT:
 233             rotate(nav->getRotationAngle(), 0);
 234             break;
 235         case Navigator::LEFT:
 236             right(nav->getMotionFactor());
 237             break;
 238         case Navigator::RIGHT:
 239             right(-nav->getMotionFactor());
 240             break;
 241         case Navigator::FORWARDS:
 242             forward(-nav->getMotionFactor());
 243             break;
 244         case Navigator::BACKWARDS:
 245             forward( nav->getMotionFactor());
 246             break;
 247         default:
 248             FNOTICE(("FlyEngine: keyPress, unknown key\n"));
 249             break;
 250     }
 251 }
 252
 253 void FlyEngine::moveTo(Int16 x, Int16 y, Navigator *nav)
 254 {
 255     Real32 fromX, fromY, toX, toY;
 256
 257     nav->calcFromTo(x,y, fromX,fromY, toX,toY);
 258
 259     Real32 distanceX = -(fromX - toX);
 260     Real32 distanceY =  (fromY - toY);
 261
 262     rotate(distanceX, distanceY);
 263
 264     switch(_currentState)
 265     {
 266         case Navigator::TRANSLATING_ZPLUS:
 267             forward(-nav->getMotionFactor());
 268             break;
 269         case Navigator::TRANSLATING_ZMINUS:
 270             forward(nav->getMotionFactor());
 271             break;
 272         case Navigator::ROTATING:
 273             break;
 274         default:
 275             //IDLE
 276             break;
 277     }
 278 }
 279
 280 void FlyEngine::idle(Int16 buttons, Int16 x, Int16 y, Navigator *nav)
 281 {
 282 }
 283
 284 /*---------------------- Flyer Transformations ----------------------------*/
 285
 286 /*! Rotate the viewer \a deltaX around the up axis and deltaY around the
 287     left/right axis. \a deltaX and \a deltaY should be between -Pi and Pi.
 288 */
 289
 290 void FlyEngine::rotate(Real32 deltaX, Real32 deltaY)
 291 {
 292     // rotate around the up vector
 293     Matrix final,temp;
 294     Quaternion q;
 295
 296     q.setValueAsAxisRad(_vUp,-deltaX);
 297     q.getValue(temp);
 298
 299     final.setIdentity();
 300     final.setTranslate(_rFrom);
 301     final.mult(temp);
 302
 303     temp.setIdentity();
 304     temp.setTranslate(-_rFrom[0],-_rFrom[1],-_rFrom[2]);
 305
 306     final.mult(temp      );
 307     final.mult(_rAt, _rAt);
 308
 309     // rotate around the side vector
 310
 311     Vec3f lv = _rAt-_rFrom;
 312     lv.normalize();
 313
 314     Vec3f sv = lv;
 315     sv.crossThis(_vUp);
 316     sv.normalize();
 317     q.setValueAsAxisRad(sv,-deltaY);
 318     q.getValue(temp);
 319
 320     final.setIdentity();
 321     final.setTranslate(_rFrom);
 322     final.mult(temp);
 323
 324     temp.setIdentity();
 325     temp.setTranslate(-_rFrom[0],-_rFrom[1],-_rFrom[2]);
 326
 327     final.mult(temp);
 328     final.mult(_rAt, _rAt);
 329 }
 330
 331 /*! Flies forward, i.e. translation \a step units along the view vector.
 332 */
 333 Real32 FlyEngine::forward(Real32 step)
 334 {
 335     Vec3f lv;
 336
 337     lv = _rFrom - _rAt;
 338     lv.normalize();
 339
 340     lv *= (step);
 341
 342     Matrix transl;
 343     transl.setIdentity();
 344     transl.setTranslate(lv);
 345
 346     transl.mult(_rAt,   _rAt  );
 347     transl.mult(_rFrom, _rFrom);
 348
 349     return 0.0;
 350 }
 351
 352 /*! Strafes to the right, i.e. translates along the side vector.
 353 */
 354 Real32 FlyEngine::right(Real32 step)
 355 {
 356     Vec3f sv;
 357     sv = _rFrom-_rAt;
 358     sv.crossThis(_vUp);
 359     sv.normalize();
 360     sv *= (step);
 361     Matrix transl;
 362     transl.setIdentity();
 363     transl.setTranslate(sv);
 364     transl.mult(_rAt,   _rAt  );
 365     transl.mult(_rFrom, _rFrom);
 366     return 0.0;
 367 }
 368
 369 /*-------------------------- constructors ---------------------------------*/
 370
 371 FlyEngine::FlyEngine(void) :
 372      Inherited(),
 373     _rFrom    (),
 374     _rAt      (),
 375     _vUp      (),
 376     _tMatrix  ()
 377 {
 378     _rFrom  .setValues(0, 0, 0);
 379     _rAt    .setValues(0, 0, 1);
 380     _vUp    .setValues(0, 1, 0);
 381
 382     _tMatrix.setIdentity();
 383 }
 384
 385 /*-------------------------- destructors ----------------------------------*/
 386
 387 FlyEngine::~FlyEngine()
 388 {
 389 }