Source/Contrib/ComplexSceneManager/Sensor/InterfaceSensors/OSGDeviceInterfaceSensor.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 _OSGDEVICEINTERFACESENSOR_H_
  40 #define _OSGDEVICEINTERFACESENSOR_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGInterfaceOptions.h"
  46 #include "OSGDeviceInterfaceSensorBase.h"
  47 #include "OSGDeviceInterface.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief DeviceInterfaceSensor class. See \ref
  52            PageContribCSMDeviceInterfaceSensor for a description.
  53 */
  54
  55 class OSG_CONTRIBCSM_DLLMAPPING DeviceInterfaceSensor :
  56     public DeviceInterfaceSensorBase
  57 {
  58   protected:
  59
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     typedef DeviceInterfaceSensorBase Inherited;
  65     typedef DeviceInterfaceSensor     Self;
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name                      Sync                                    */
  69     /*! \{                                                                 */
  70
  71     virtual void changed(ConstFieldMaskArg whichField,
  72                          UInt32            origin,
  73                          BitVector         details    );
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                     Output                                   */
  78     /*! \{                                                                 */
  79
  80     virtual bool init    (void);
  81     virtual void shutdown(void);
  82
  83     /*! \}                                                                 */
  84     /*---------------------------------------------------------------------*/
  85     /*! \name                     Output                                   */
  86     /*! \{                                                                 */
  87
  88     virtual void dump(      UInt32     uiIndent = 0,
  89                       const BitVector  bvFlags  = 0) const;
  90
  91     /*! \}                                                                 */
  92     /*=========================  PROTECTED  ===============================*/
  93
  94   protected:
  95
  96     // Variables should all be in TimeSensorBase.
  97
  98     DeviceInterfaceRefPtr _pDevice;
  99
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                  Constructors                                */
 102     /*! \{                                                                 */
 103
 104     DeviceInterfaceSensor(void);
 105     DeviceInterfaceSensor(const DeviceInterfaceSensor &source);
 106
 107     /*! \}                                                                 */
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                   Destructors                                */
 110     /*! \{                                                                 */
 111
 112     virtual ~DeviceInterfaceSensor(void);
 113
 114     /*! \}                                                                 */
 115     /*---------------------------------------------------------------------*/
 116     /*! \name                      Init                                    */
 117     /*! \{                                                                 */
 118
 119     static void initMethod(InitPhase ePhase);
 120
 121     /*! \}                                                                 */
 122     /*==========================  PRIVATE  ================================*/
 123
 124   private:
 125
 126     friend class FieldContainer;
 127     friend class DeviceInterfaceSensorBase;
 128
 129     // prohibit default functions (move to 'public' if you need one)
 130     void operator =(const DeviceInterfaceSensor &source);
 131 };
 132
 133 typedef DeviceInterfaceSensor *DeviceInterfaceSensorP;
 134
 135 OSG_END_NAMESPACE
 136
 137 #include "OSGDeviceInterfaceSensorBase.inl"
 138 #include "OSGDeviceInterfaceSensor.inl"
 139
 140 #endif /* _OSGDEVICEINTERFACESENSOR_H_ */