Source/System/Window/Utilities/OSGNavballEngine.h

   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 #ifndef _OSG_NAVBALLENGINE_H_
  40 #define _OSG_NAVBALLENGINE_H_
  41
  42 #include "OSGNavigatorEngine.h"
  43
  44 OSG_BEGIN_NAMESPACE
  45
  46 class Navigator;
  47
  48 /*! \brief NavballEngine provides the trackball navigator functionality.
  49 */
  50 class OSG_UTIL_DLLMAPPING NavballEngine : public NavigatorEngine
  51 {
  52     typedef NavigatorEngine Inherited;
  53     typedef NavballEngine   Self;
  54
  55     /*==========================  PUBLIC  =================================*/
  56
  57   public:
  58
  59     /*---------------------------------------------------------------------*/
  60     /*! \name                      Types                                   */
  61     /*! \{                                                                 */
  62
  63     OSG_GEN_INTERNAL_MEMOBJPTR(NavballEngine);
  64
  65     /*! \}                                                                 */
  66     /*---------------------------------------------------------------------*/
  67     /*! \name                    Construction                              */
  68     /*! \{                                                                 */
  69
  70     static ObjTransitPtr create(Real32 rSize = 0.8f);
  71
  72     /*! \}                                                                 */
  73     /*---------------------------------------------------------------------*/
  74     /*! \name                    Class Get                                 */
  75     /*! \{                                                                 */
  76
  77     const char *getClassname(void) { return "NavballEngine"; }
  78
  79     /*! \}                                                                 */
  80     /*---------------------------------------------------------------------*/
  81     /*! \name                        Get                                   */
  82     /*! \{                                                                 */
  83
  84     virtual const Pnt3f  &getFrom    (void);
  85     virtual const Pnt3f  &getAt      (void);
  86     virtual const Vec3f  &getUp      (void);
  87     virtual const Matrix &getMatrix  (void);
  88     virtual       Real32  getDistance(void);
  89
  90     /*! \}                                                                 */
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                        Set                                   */
  93     /*! \{                                                                 */
  94
  95     virtual void setFrom    (      Pnt3f   new_from    );
  96     virtual void setAt      (      Pnt3f   new_at      );
  97     virtual void setUp      (      Vec3f   new_up      );
  98     virtual void set        (      Pnt3f   new_from,
  99                                    Pnt3f   new_at,
 100                                    Vec3f   new_up      );
 101     virtual void set        (const Matrix &new_matrix  );
 102     virtual void setDistance(      Real32  new_distance);
 103
 104     /*! \}                                                                 */
 105     /*---------------------------------------------------------------------*/
 106     /*! \name             navigator engine callbacks                       */
 107     /*! \{                                                                 */
 108
 109     virtual void buttonPress  (Int16      button,
 110                                Int16      x,
 111                                Int16      y,
 112                                Navigator *nav    );
 113     virtual void buttonRelease(Int16      button,
 114                                Int16      x,
 115                                Int16      y,
 116                                Navigator *nav    );
 117     virtual void keyPress     (Int16      key,
 118                                Int16      x,
 119                                Int16      y,
 120                                Navigator *nav    );
 121     virtual void moveTo       (Int16      x,
 122                                Int16      y,
 123                                Navigator *nav    );
 124     virtual void idle         (Int16      buttons,
 125                                Int16      x,
 126                                Int16      y,
 127                                Navigator *nav    );
 128
 129     /*! \}                                                                 */
 130     /*---------------------------------------------------------------------*/
 131     /*! \name              Navball Transformations                       */
 132     /*! \{                                                                 */
 133
 134     void rotate     (Real32 fromX,
 135                      Real32 fromY,
 136                      Real32 toX,
 137                      Real32 toY      );
 138     void translateXY(Real32 distanceX,
 139                      Real32 distanceY);
 140     void translateZ (Real32 distance );
 141
 142
 143     /*! \}                                                                 */
 144     /*==========================  PROTECTED  ==============================*/
 145
 146   protected:
 147
 148     /*---------------------------------------------------------------------*/
 149     /*! \name            Constructors/Destructor                           */
 150     /*! \{                                                                 */
 151
 152              NavballEngine(Real32 rSize = 0.8f);
 153     virtual ~NavballEngine(void               );
 154
 155     /*! \}                                                                 */
 156     /*---------------------------------------------------------------------*/
 157     /*! \name                     Members                                  */
 158     /*! \{                                                                 */
 159
 160     Real32 _rDistance;
 161     Matrix _finalMatrix;
 162     Pnt3f  _pFrom;
 163     Pnt3f  _pAt;
 164     Vec3f  _vUp;
 165
 166     /* temporary values */
 167     Pnt3f  _ip;
 168     Vec3f  _dir;
 169
 170     /*! \}                                                                 */
 171     /*---------------------------------------------------------------------*/
 172
 173     void updateFinalMatrix   (void                );
 174     void calcDeltas          (Int16,
 175                               Int16,
 176                               Int16      toX,
 177                               Int16      toY,
 178                               Real32    &distanceX,
 179                               Real32    &distanceY,
 180                               Navigator *nav      );
 181     void getIntersectionPoint(Int16      x,
 182                               Int16      y,
 183                               Navigator *nav      );
 184
 185   private:
 186
 187     /* Not implemented */
 188     NavballEngine(const NavballEngine &other);
 189     NavballEngine &operator =(const NavballEngine &other);
 190 };
 191
 192 OSG_GEN_MEMOBJPTR(NavballEngine);
 193
 194 OSG_END_NAMESPACE
 195
 196 #endif