Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoTimerSensor.h
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : Nick Thompson (MMM yyyy)
25** Modified by : Paul Strauss (MMM yyyy)
26** Modified by : Gavin Bell (MMM yyyy)
27**=======================================================================*/
28/*=======================================================================
29 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
30 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
31 *** ***
32 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
33 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
34 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
35 *** ***
36 *** RESTRICTED RIGHTS LEGEND ***
37 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
38 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
39 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
40 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
41 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
42 *** ***
43 *** COPYRIGHT (C) 1996-2018 BY FEI S.A.S, ***
44 *** BORDEAUX, FRANCE ***
45 *** ALL RIGHTS RESERVED ***
46**=======================================================================*/
47/*=======================================================================
48** Modified by : VSG (MMM YYYY)
49**=======================================================================*/
50
51
52#ifndef _SO_TIMER_SENSOR_
53#define _SO_TIMER_SENSOR_
54
55#include <Inventor/sensors/SoTimerQueueSensor.h>
56
92
93 public:
103 SoTimerSensor(SoSensorCB *func, void *data);
104
109 virtual ~SoTimerSensor();
110
115 void setBaseTime(const SbTime &base) { baseTime = base;
116 baseTimeSet = TRUE;}
121 void setInterval(const SbTime &intvl) { interval = intvl; }
125 const SbTime & getBaseTime() const { return baseTime; }
129 const SbTime & getInterval() const { return interval; }
130
131 // Overrides the regular schedule() method because we have to set
132 // up the trigger time first.
133 virtual void schedule();
134
135 // Overrides the regular unschedule() because the timer could be
136 // in either the timer queue or the waiting-to-be-rescheduled
137 // queue, depending on the state of the 'triggering' flag.
138 virtual void unschedule();
139
140 private:
141
142 // Reschedule this timer relative to the given time
143 void reschedule(const SbTime &);
144
145private:
146 // Triggers the sensor, calling its callback function. This
147 // overrides the method in SoSensor because it has to reschedule
148 // itself for the next interval after triggering.
149 virtual void trigger();
150
151 SbBool triggering; // True if in trigger() code
152
153 private:
154 SbTime baseTime; // Base time for scheduling triggering
155 SbTime interval; // Interval between triggering
156 SbBool baseTimeSet; // Whether base time was set by user
157
158};
159
160#endif /* _SO_TIMER_SENSOR_ */
161
Class for representation of a time.
Definition SbTime.h:91
void SoSensorCB(void *data, SoSensor *sensor)
This typedef defines the calling sequence for all callbacks from sensors.
Definition SoSensor.h:68
Abstract base class for sensors dependent on time.
Sensor that triggers repeatedly at regular intervals.
void setBaseTime(const SbTime &base)
Sets the base time.
virtual void schedule()
Adds this sensor to the timer queue.
const SbTime & getBaseTime() const
Gets the base time.
virtual void unschedule()
If this sensor is scheduled, removes it from the timer queue so that it will not be triggered.
virtual ~SoTimerSensor()
Destroys the sensor, freeing up any memory associated with it after unscheduling it.
SoTimerSensor(SoSensorCB *func, void *data)
Constructor that takes the function and data to be called when the sensor is triggered.
void setInterval(const SbTime &intvl)
Sets the interval.
const SbTime & getInterval() const
Gets the interval.
SoTimerSensor()
Default constructor.
int SbBool
Boolean type.
Definition SbBase.h:87