Source/Contrib/ComplexSceneManager/Sensor/OSGKeySensor.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 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 _OSGKEYSENSOR_H_
  40 #define _OSGKEYSENSOR_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGKeySensorBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 struct CSMKeyData
  50 {
  51     static const UInt32 ButtonDown = 0x0000;
  52     static const UInt32 ButtonUp   = 0x0001;
  53 };
  54
  55 /*! \brief KeySensor class. See \ref
  56            PageContribCSMKeySensor for a description.
  57 */
  58
  59 class OSG_CONTRIBCSM_DLLMAPPING KeySensor : public KeySensorBase
  60 {
  61   protected:
  62
  63     /*==========================  PUBLIC  =================================*/
  64
  65   public:
  66
  67     typedef KeySensorBase Inherited;
  68     typedef KeySensor     Self;
  69
  70     /*---------------------------------------------------------------------*/
  71     /*! \name                      Sync                                    */
  72     /*! \{                                                                 */
  73
  74     virtual void changed(ConstFieldMaskArg whichField,
  75                          UInt32            origin,
  76                          BitVector         details    );
  77
  78     /*! \}                                                                 */
  79     /*---------------------------------------------------------------------*/
  80     /*! \name                     Output                                   */
  81     /*! \{                                                                 */
  82
  83     Char8 getKey(void);
  84
  85     /*! \}                                                                 */
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                     Output                                   */
  88     /*! \{                                                                 */
  89
  90     void update(Int32 x,
  91                 Int32 y,
  92                 Int32 iState);
  93
  94     /*! \}                                                                 */
  95     /*---------------------------------------------------------------------*/
  96     /*! \name                     Output                                   */
  97     /*! \{                                                                 */
  98
  99     virtual void dump(      UInt32     uiIndent = 0,
 100                       const BitVector  bvFlags  = 0) const;
 101
 102     /*! \}                                                                 */
 103     /*=========================  PROTECTED  ===============================*/
 104
 105   protected:
 106
 107     // Variables should all be in TimeSensorBase.
 108
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                  Constructors                                */
 111     /*! \{                                                                 */
 112
 113     KeySensor(void);
 114     KeySensor(const KeySensor &source);
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                   Destructors                                */
 119     /*! \{                                                                 */
 120
 121     virtual ~KeySensor(void);
 122
 123     /*! \}                                                                 */
 124     /*---------------------------------------------------------------------*/
 125     /*! \name                      Init                                    */
 126     /*! \{                                                                 */
 127
 128     void onDestroy(UInt32 uiContainerId);
 129
 130     /*! \}                                                                 */
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                      Init                                    */
 133     /*! \{                                                                 */
 134
 135     static void initMethod(InitPhase ePhase);
 136
 137     /*! \}                                                                 */
 138     /*==========================  PRIVATE  ================================*/
 139
 140   private:
 141
 142     friend class FieldContainer;
 143     friend class KeySensorBase;
 144
 145     // prohibit default functions (move to 'public' if you need one)
 146     void operator =(const KeySensor &source);
 147 };
 148
 149 typedef KeySensor *KeySensorP;
 150
 151 OSG_END_NAMESPACE
 152
 153 #include "OSGKeySensorBase.inl"
 154 #include "OSGKeySensor.inl"
 155
 156 #endif /* _OSGKEYSENSOR_H_ */