Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoDelayQueueSensor.h
Go to the documentation of this file.
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-2017 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_DELAY_QUEUE_SENSOR_
53#define _SO_DELAY_QUEUE_SENSOR_
54
56//
57// Class: SoDelayQueueSensor
58//
59//
61
63
107
108 public:
117 SoDelayQueueSensor(SoSensorCB *func, void *data);
118
119 // Destructor
120#ifndef HIDDEN_FROM_DOC
121 virtual ~SoDelayQueueSensor();
122#endif // HIDDEN_FROM_DOC
123
130 void setPriority(uint32_t pri);
135 uint32_t getPriority() const { return priority; }
136
141 static uint32_t getDefaultPriority() { return 100; }
142
154 virtual void schedule();
159 virtual void unschedule();
160
161 // This method is overriden by IdleSensors to tell sensor manager
162 // that they should only be processed when there really is idle
163 // time (and not when the delay queue timeout expires).
164 virtual SbBool isIdleOnly() const;
165 private:
166 // Set/inquire counter when sensor was last triggered. This allows
167 // the sensor manager to avoid triggering a sensor more than once
168 // during the same call to processDelayQueue().
169 void setCounter(uint32_t c) { counter = c; }
170 uint32_t getCounter() const { return counter; }
171 void setPreserveOrder(bool preserveOrder);
172
173 private:
174 uint32_t priority; // Sensor priority
175 uint32_t counter; // Used by sensor manager
176
177 typedef SbBool (*OrderingFunction)(uint32_t, uint32_t);
178 OrderingFunction m_orderingFn;
179
180 // Returns TRUE if this sensor should precede sensor s in the delay
181 // queue: it must have a lower priority number than s.
182 virtual SbBool isBefore(const SoSensor *s) const;
183 static SbBool strictOrder(uint32_t p1, uint32_t p2);
184 static SbBool looseOrder(uint32_t p1, uint32_t p2);
185};
186
187#endif /* _SO_DELAY_QUEUE_SENSOR_ */
188
void SoSensorCB(void *data, SoSensor *sensor)
This typedef defines the calling sequence for all callbacks from sensors.
Definition SoSensor.h:65
Abstract base class for sensors not dependent on time.
SoDelayQueueSensor()
Constructor.
virtual void schedule()
If this sensor's priority is non-zero, adds this sensor to the list of delay queue sensors ready to b...
uint32_t getPriority() const
Gets the priority of the sensor.
static uint32_t getDefaultPriority()
Returns the default delay queue sensor priority, which is 100.
virtual SbBool isIdleOnly() const
void setPriority(uint32_t pri)
Sets the priority of the sensor.
virtual void unschedule()
If this sensor is scheduled, removes it from the delay queue so that it will not be triggered.
SoDelayQueueSensor(SoSensorCB *func, void *data)
Constructor that takes standard callback and data.
Abstract base class for Open Inventor sensors.
Definition SoSensor.h:97
int SbBool
Boolean type.
Definition SbBase.h:87