MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/sensors/SoTimerSensor.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */


/*
 * Copyright (C) 1990,91,92   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Timer sensors trigger repeatedly at regular
 |      intervals, starting at a given base time. By default, the base
 |      time is the current time (at the time the sensor is scheduled or
 |      rescheduled) and the interval is 1/30 of a second; both of these
 |      values may be changed.  If more than one interval passes while
 |      sensors are being triggered, then the extra intervals will be lost
 |      (timers always reschedule themselves to occur in the future).
 |      If more than one timer has expired (and therefore more than one
 |      needs to be rescheduled), all of them are first triggered, and are
 |      then rescheduled relative to the current time.  The reschedule()
 |      method is called by the sensor manager to accomplish this (see the
 |      comments there about saturating the timer queue).
 |
 |   Author(s)          : Nick Thompson, Paul Strauss, Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_TIMER_SENSOR_
#define  _SO_TIMER_SENSOR_

#include <Inventor/sensors/SoTimerQueueSensor.h>




class INVENTOR_API 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;  }

    virtual void        schedule();

    virtual void        unschedule();

  SoINTERNAL public:

    void                reschedule(const SbTime &);

  private:
    SbTime              baseTime;       
    SbTime              interval;       
    SbBool              baseTimeSet;    

    SbBool              triggering;     

    virtual void        trigger();
};

#endif  /* _SO_TIMER_SENSOR_ */