Coin: SoTimerQueueSensor.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoTimerQueueSensor.h
1#ifndef COIN_SOTIMERQUEUESENSOR_H
2#define COIN_SOTIMERQUEUESENSOR_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/sensors/SoSensor.h>
37#include <Inventor/SbTime.h>
38
39 class COIN_DLL_API SoTimerQueueSensor : public SoSensor {
40 typedef SoSensor inherited;
41
42public:
43 SoTimerQueueSensor(void);
44 SoTimerQueueSensor(SoSensorCB * func, void * data);
45 virtual ~SoTimerQueueSensor(void);
46
47 const SbTime & getTriggerTime(void) const;
48 virtual void schedule(void);
49 virtual void unschedule(void);
50 virtual SbBool isScheduled(void) const;
51 virtual void trigger(void);
52
53protected:
54 void setTriggerTime(const SbTime & time);
55 SbBool scheduled;
56
57private:
58 virtual SbBool isBefore(const SoSensor * s) const;
59 SbTime triggertime;
60};
61
62#endif // !COIN_SOTIMERQUEUESENSOR_H
SbTime
The SbTime class instances represents time values.
Definition SbTime.h:50
SoSensor::schedule
virtual void schedule(void)=0
SoSensor::func
SoSensorCB * func
Definition SoSensor.h:67
SoSensor::unschedule
virtual void unschedule(void)=0
SoSensor::isScheduled
virtual SbBool isScheduled(void) const =0
SoSensor::trigger
virtual void trigger(void)
Definition SoSensor.cpp:195
SoSensor::isBefore
virtual SbBool isBefore(const SoSensor *s) const =0
SoSensor::SoSensor
SoSensor(void)
Definition SoSensor.cpp:121
SoTimerQueueSensor::scheduled
SbBool scheduled
Definition SoTimerQueueSensor.h:55
SoTimerQueueSensor::getTriggerTime
const SbTime & getTriggerTime(void) const
Definition SoTimerQueueSensor.cpp:148
SoTimerQueueSensor::setTriggerTime
void setTriggerTime(const SbTime &time)
Definition SoTimerQueueSensor.cpp:159
SoTimerQueueSensor::SoTimerQueueSensor
SoTimerQueueSensor(void)
Definition SoTimerQueueSensor.cpp:115