SoDelayQueueSensor.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Nick Thompson (MMM yyyy)
** Modified by : Paul Strauss (MMM yyyy)
** Modified by : Gavin Bell (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_DELAY_QUEUE_SENSOR_
#define  _SO_DELAY_QUEUE_SENSOR_
 
//
//  Class: SoDelayQueueSensor
//
//
 
#include <Inventor/sensors/SoSensor.h>
 
class  SoDelayQueueSensor : public SoSensor {
 
 public:
  SoDelayQueueSensor();
  SoDelayQueueSensor(SoSensorCB *func, void *data);
 
  // Destructor
#ifndef HIDDEN_FROM_DOC
  virtual ~SoDelayQueueSensor();
#endif // HIDDEN_FROM_DOC
 
  void                setPriority(uint32_t pri);
  uint32_t            getPriority() const             { return priority; }
 
  static uint32_t getDefaultPriority()                { return 100; }
 
  virtual void        schedule();
  virtual void        unschedule();
 
  // This method is overriden by IdleSensors to tell sensor manager
  // that they should only be processed when there really is idle
  // time (and not when the delay queue timeout expires).
  virtual SbBool      isIdleOnly() const;
 private:
  // Set/inquire counter when sensor was last triggered. This allows
  // the sensor manager to avoid triggering a sensor more than once
  // during the same call to processDelayQueue().
  void                setCounter(uint32_t c)          { counter = c;  }
  uint32_t            getCounter() const              { return counter; }
  void                setPreserveOrder(bool preserveOrder);
 
 private:
  uint32_t            priority;       // Sensor priority
  uint32_t            counter;        // Used by sensor manager
 
  typedef  SbBool (*OrderingFunction)(uint32_t, uint32_t);
  OrderingFunction m_orderingFn;
 
  // Returns TRUE if this sensor should precede sensor s in the delay
  // queue: it must have a lower priority number than s.
  virtual SbBool      isBefore(const SoSensor *s) const;
  static  SbBool      strictOrder(uint32_t p1, uint32_t p2);
  static  SbBool      looseOrder(uint32_t p1, uint32_t p2);
};
 
#endif  /* _SO_DELAY_QUEUE_SENSOR_ */