Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
SoSensor.h
Go to the documentation of this file.
1 #ifndef COIN_SOSENSOR_H
2 #define COIN_SOSENSOR_H
3 
4 /**************************************************************************\
5  * Copyright (c) Kongsberg Oil & Gas Technologies AS
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  *
19  * Neither the name of the copyright holder nor the names of its
20  * contributors may be used to endorse or promote products derived from
21  * this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 \**************************************************************************/
35 
36 #include <Inventor/SbBasic.h>
37 
38 class SoSensor;
39 
40 typedef void SoSensorCB(void * data, SoSensor * sensor);
41 typedef SoSensorCB * SoSensorCBPtr;
42 
43 class COIN_DLL_API SoSensor {
44 public:
45  SoSensor(void);
46  SoSensor(SoSensorCB * func, void * data);
47  virtual ~SoSensor(void);
48 
49  void setFunction(SoSensorCB * callbackfunction);
50  SoSensorCBPtr getFunction(void) const;
51  void setData(void * callbackdata);
52  void * getData(void) const;
53 
54  virtual void schedule(void) = 0;
55  virtual void unschedule(void) = 0;
56  virtual SbBool isScheduled(void) const = 0;
57 
58  virtual void trigger(void);
59 
60  virtual SbBool isBefore(const SoSensor * s) const = 0;
61  void setNextInQueue(SoSensor * next);
62  SoSensor * getNextInQueue(void) const;
63 
64  static void initClass(void);
65 
66 protected:
68  void * funcData;
69 };
70 
71 #endif // !COIN_SOSENSOR_H
void SoSensorCB(void *data, SoSensor *sensor)
Definition: SoSensor.h:40
The SoSensor class is the abstract base class for all sensors.
Definition: SoSensor.h:43
SoSensorCB * func
Definition: SoSensor.h:67
void * funcData
Definition: SoSensor.h:68