Source/Contrib/Manipulators/OSGManipulator.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 _OSGMANIPULATOR_H_
  40 #define _OSGMANIPULATOR_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGConfig.h"
  46
  47 #include "OSGManipulatorBase.h"
  48 #include "OSGExternalUpdateHandler.h"
  49
  50 #include "OSGComponentTransform.h"
  51
  52 OSG_BEGIN_NAMESPACE
  53
  54 /*! \brief Manipulator class. See \ref
  55            PageManipulatorsManipulator for a description.
  56 */
  57
  58 class OSG_CONTRIBGUI_DLLMAPPING Manipulator : public ManipulatorBase
  59 {
  60     /*==========================  PUBLIC  =================================*/
  61   public:
  62
  63     /*---------------------------------------------------------------------*/
  64     /*! \name                      Sync                                    */
  65     /*! \{                                                                 */
  66
  67     virtual void changed(ConstFieldMaskArg whichField,
  68                          UInt32            origin,
  69                          BitVector         detail);
  70
  71     /*! \}                                                                 */
  72     /*---------------------------------------------------------------------*/
  73     /*! \name                     Output                                   */
  74     /*! \{                                                                 */
  75
  76     virtual void dump(      UInt32     uiIndent = 0,
  77                       const BitVector  bvFlags  = 0) const;
  78
  79     virtual void mouseMove(Int16        x,
  80                            Int16        y);
  81
  82     virtual void mouseButtonPress(UInt16        button,
  83                                    Int16        x,
  84                                    Int16        y     );
  85
  86     virtual void mouseButtonRelease(UInt16      button,
  87                                      Int16      x,
  88                                      Int16      y     );
  89
  90     virtual bool hasSubHandle(Node * const n);
  91
  92     void setExternalUpdateHandler(ExternalUpdateHandler* h);
  93
  94     void callExternalUpdateHandler();
  95
  96     /*! \}                                                                 */
  97     /*=========================  PROTECTED  ===============================*/
  98   protected:
  99
 100     typedef ManipulatorBase Inherited;
 101
 102     // Variables should all be in ManipulatorBase.
 103
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                  Constructors                                */
 106     /*! \{                                                                 */
 107
 108     Manipulator(void);
 109     Manipulator(const Manipulator &source);
 110
 111     void onCreate();
 112     void onCreate(const Manipulator* source);
 113
 114
 115     /*! \}                                                                 */
 116     /*---------------------------------------------------------------------*/
 117     /*! \name                   Destructors                                */
 118     /*! \{                                                                 */
 119
 120     virtual ~Manipulator(void);
 121
 122     void    onDestroy();
 123
 124     virtual void resolveLinks(void);
 125
 126     /*! \}                                                                 */
 127     /*---------------------------------------------------------------------*/
 128     /*! \name                        Init                                  */
 129     /*! \{                                                                 */
 130
 131     static void initMethod(InitPhase ePhase);
 132
 133     /*! \}                                                                 */
 134
 135     virtual NodeTransitPtr makeHandleGeo() = 0;
 136     virtual void           addHandleGeo(Node * n);
 137     virtual void           subHandleGeo(Node * n);
 138     void                   updateHandleTransform();
 139
 140     /*---------------------------------------------------------------------*/
 141     /*! \name                       Helpers                                */
 142     /*! \{                                                                 */
 143
 144     virtual void    doMovement(      Transform   *t,
 145                                const Int32        coord,
 146                                const Real32       value,
 147                                const Vec3f        &translation,
 148                                const Quaternion   &rotation,
 149                                const Vec3f        &scaleFactor,
 150                                const Quaternion   &scaleOrientation);
 151
 152     Pnt2f calcScreenProjection(const Pnt3f    &,
 153                                      Viewport * const port);
 154
 155     const Vec3f& getActiveAxis(void) const;
 156
 157     NodeRefPtr              _activeParent;
 158     ExternalUpdateHandler*  _externalUpdateHandler;
 159
 160     /*! \}                                                                 */
 161
 162     /*==========================  PRIVATE  ================================*/
 163   private:
 164     friend class FieldContainer;
 165     friend class ManipulatorBase;
 166
 167     friend class ManipulatorManager;
 168
 169     // prohibit default functions (move to 'public' if you need one)
 170     void operator =(const Manipulator &source);
 171 };
 172
 173 typedef Manipulator *ManipulatorP;
 174
 175 OSG_END_NAMESPACE
 176
 177 #include "OSGManipulatorBase.inl"
 178 #include "OSGManipulator.inl"
 179
 180 #endif /* _OSGMANIPULATOR_H_ */