00001 /*=======================================================================
00002  * Copyright 1991-1996, Silicon Graphics, Inc.
00003  * ALL RIGHTS RESERVED
00004  *
00005  * UNPUBLISHED -- Rights reserved under the copyright laws of the United
00006  * States.   Use of a copyright notice is precautionary only and does not
00007  * imply publication or disclosure.
00008  *
00009  * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
00010  * Use, duplication or disclosure by the Government is subject to restrictions
00011  * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
00012  * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
00013  * in similar or successor clauses in the FAR, or the DOD or NASA FAR
00014  * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
00015  * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
00016  *
00017  * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
00018  * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
00019  * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
00020  * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
00021  * GRAPHICS, INC.
00022 **=======================================================================*/
00023 /*=======================================================================
00024 ** Author      : Nick Thompson (MMM yyyy)
00025 ** Modified by : Paul Strauss (MMM yyyy)
00026 ** Modified by : Gavin Bell (MMM yyyy)
00027 **=======================================================================*/
00028 /*=======================================================================
00029  *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
00030  ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
00031  ***                                                                                ***
00032  ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
00033  ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
00034  ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
00035  ***                                                                                ***
00036  ***                        RESTRICTED RIGHTS LEGEND                                ***
00037  ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
00038  ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
00039  ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
00040  ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
00041  ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
00042  ***                                                                                ***
00043  ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
00044  ***                        BORDEAUX, FRANCE                                        ***
00045  ***                      ALL RIGHTS RESERVED                                       ***
00046 **=======================================================================*/
00047 /*=======================================================================
00048 ** Modified by : VSG (MMM YYYY)
00049 **=======================================================================*/
00050 
00051 
00052 #ifndef  _SO_DELAY_QUEUE_SENSOR_
00053 #define  _SO_DELAY_QUEUE_SENSOR_
00054 
00056 //
00057 //  Class: SoDelayQueueSensor
00058 //
00059 //
00061 
00062 #include <Inventor/sensors/SoSensor.h>
00063 
00107 class  SoDelayQueueSensor : public SoSensor {
00108 
00109  public:
00113   SoDelayQueueSensor();
00118   SoDelayQueueSensor(SoSensorCB *func, void *data);
00119 
00120   // Destructor
00121 #ifndef HIDDEN_FROM_DOC
00122   virtual ~SoDelayQueueSensor();
00123 #endif // HIDDEN_FROM_DOC
00124 
00131   void                setPriority(uint32_t pri);
00136   uint32_t            getPriority() const             { return priority; }
00137 
00142   static uint32_t getDefaultPriority()                { return 100; }
00143 
00155   virtual void        schedule();
00160   virtual void        unschedule();
00161 
00162   // This method is overriden by IdleSensors to tell sensor manager
00163   // that they should only be processed when there really is idle
00164   // time (and not when the delay queue timeout expires).
00165   virtual SbBool      isIdleOnly() const;
00166  private:
00167   // Set/inquire counter when sensor was last triggered. This allows
00168   // the sensor manager to avoid triggering a sensor more than once
00169   // during the same call to processDelayQueue().
00170   void                setCounter(uint32_t c)          { counter = c;  }
00171   uint32_t            getCounter() const              { return counter; }
00172   void                setPreserveOrder(bool preserveOrder);
00173 
00174  private:
00175   uint32_t            priority;       // Sensor priority
00176   uint32_t            counter;        // Used by sensor manager
00177 
00178   typedef  SbBool (*OrderingFunction)(uint32_t, uint32_t);
00179   OrderingFunction m_orderingFn;
00180 
00181   // Returns TRUE if this sensor should precede sensor s in the delay
00182   // queue: it must have a lower priority number than s.
00183   virtual SbBool      isBefore(const SoSensor *s) const;
00184   static  SbBool      strictOrder(uint32_t p1, uint32_t p2);
00185   static  SbBool      looseOrder(uint32_t p1, uint32_t p2);
00186 };
00187 
00188 #endif  /* _SO_DELAY_QUEUE_SENSOR_ */
00189 
00190
Inventor/sensors/SoDelayQueueSensor.h
