Source/Contrib/ComplexSceneManager/Sensor/InterfaceSensors/OSGMouseDataDeviceInterface.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 _OSGMOUSEDATADEVICEINTERFACE_H_
  40 #define _OSGMOUSEDATADEVICEINTERFACE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGMouseData.h"
  46 #include "OSGDeviceInterface.h"
  47
  48 #include <boost/circular_buffer.hpp>
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 class OSG_CONTRIBCSM_DLLMAPPING MouseDataDeviceInterface :
  53     public DeviceInterface
  54 {
  55
  56     /*==========================  PUBLIC  =================================*/
  57
  58   public:
  59
  60     typedef boost::circular_buffer<MouseData> MouseDataBuffer;
  61
  62     /*---------------------------------------------------------------------*/
  63     /*! \name                 Reference Counting                           */
  64     /*! \{                                                                 */
  65
  66     /*---------------------------------------------------------------------*/
  67     /*! \name                 Reference Counting                           */
  68     /*! \{                                                                 */
  69
  70     const MouseDataBuffer &getDataBuffer(void) const;
  71
  72     /*! \}                                                                 */
  73     /*---------------------------------------------------------------------*/
  74     /*! \name                   Constructors                               */
  75     /*! \{                                                                 */
  76
  77     virtual void clearNewData(void);
  78
  79     /*! \}                                                                 */
  80     /*=========================  PROTECTED  ===============================*/
  81
  82   protected:
  83
  84     typedef DeviceInterface Inherited;
  85
  86     MouseDataBuffer _cbMouseData;
  87
  88     /*---------------------------------------------------------------------*/
  89     /*! \name                 Reference Counting                           */
  90     /*! \{                                                                 */
  91
  92     /*! \}                                                                 */
  93     /*---------------------------------------------------------------------*/
  94     /*! \name                   Constructors                               */
  95     /*! \{                                                                 */
  96
  97     MouseDataDeviceInterface(const Char8 *szName, UInt32 uiId, bool bGlobal);
  98
  99     /*! \}                                                                 */
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                   Destructor                                 */
 102     /*! \{                                                                 */
 103
 104     virtual ~MouseDataDeviceInterface(void);
 105
 106     /*! \}                                                                 */
 107     /*---------------------------------------------------------------------*/
 108     /*! \name                   Destructor                                 */
 109     /*! \{                                                                 */
 110
 111     /*! \}                                                                 */
 112     /*---------------------------------------------------------------------*/
 113     /*! \name                   Constructors                               */
 114     /*! \{                                                                 */
 115
 116     /*! \}                                                                 */
 117    /*==========================  PRIVATE  ================================*/
 118
 119   private:
 120
 121     /*!\brief prohibit default function (move to 'public' if needed) */
 122     MouseDataDeviceInterface(const MouseDataDeviceInterface &source);
 123     void operator =(const MouseDataDeviceInterface &source);
 124 };
 125
 126 OSG_END_NAMESPACE
 127
 128 #include "OSGMouseDataDeviceInterface.inl"
 129
 130 #endif //_OSGMOUSEDATADEVICEINTERFACE_H_