SoTimerSensor.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-2018 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_TIMER_SENSOR_
#define  _SO_TIMER_SENSOR_
 
#include <Inventor/sensors/SoTimerQueueSensor.h>
 
class  SoTimerSensor : public SoTimerQueueSensor {
 
 public:
  SoTimerSensor();
  SoTimerSensor(SoSensorCB *func, void *data);
 
  virtual ~SoTimerSensor();
 
  void                setBaseTime(const SbTime &base)  { baseTime = base;
  baseTimeSet = TRUE;}
  void                setInterval(const SbTime &intvl) { interval = intvl; }
  const SbTime &      getBaseTime() const              { return baseTime; }
  const SbTime &      getInterval() const              { return interval;  }
 
  // Overrides the regular schedule() method because we have to set
  // up the trigger time first.
  virtual void        schedule();
 
  // Overrides the regular unschedule() because the timer could be
  // in either the timer queue or the waiting-to-be-rescheduled
  // queue, depending on the state of the 'triggering' flag.
  virtual void        unschedule();
 
 private:
 
  // Reschedule this timer relative to the given time
  void                reschedule(const SbTime &);
 
private:
  // Triggers the sensor, calling its callback function. This
  // overrides the method in SoSensor because it has to reschedule
  // itself for the next interval after triggering.
  virtual void        trigger();
 
  SbBool              triggering;     // True if in trigger() code
 
 private:
  SbTime              baseTime;       // Base time for scheduling triggering
  SbTime              interval;       // Interval between triggering
  SbBool              baseTimeSet;    // Whether base time was set by user
 
};
 
#endif  /* _SO_TIMER_SENSOR_ */