PeriodicUpdate.h

Go to the documentation of this file.

//    Copyright 2004-2019, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    H3D API 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 General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
//
#ifndef __PERIODIC_UPDATE_H__
#define __PERIODIC_UPDATE_H__
 
#include <H3D/Scene.h>
 
namespace H3D {
 
  class H3DAPI_API PeriodicUpdateField { 
  public:
    virtual ~PeriodicUpdateField() {}
 
    virtual bool timeToUpdate() = 0;
  };
 
 
  template< class BaseFieldType >
  class PeriodicUpdate: public BaseFieldType,
                        public PeriodicUpdateField {
  public:
    typedef enum {
      TIME, 
      COUNT 
    } PeriodType;
    
    PeriodicUpdate( H3DFloat _period = 0, PeriodType _period_type = COUNT ):
      period_type( _period_type ),
      period( _period ),
      last_up_to_date( TimeStamp() ),
      counter( 0 ) {
      this->route( Scene::eventSink );
    }
    
    ~PeriodicUpdate() {
      this->unroute( Scene::eventSink );
    }
 
    virtual bool timeToUpdate() {
      if( period_type == TIME ) {
        return (TimeStamp() - last_up_to_date ) >= period;
      } else {
        if( counter >= period ) {
          counter = 0;
          return true;
        } else {
          ++counter;
          return false;
        }
      }
    }
 
    void setPeriodType( PeriodType type ) {
      period_type = type;
    }
 
    void setPeriod( H3DFloat _period ) {
      period = _period;
    }
 
    virtual void upToDate() {
      BaseFieldType::upToDate();
      last_up_to_date = TimeStamp();
    }
 
  protected:
    
    PeriodType period_type;
    H3DFloat period;
    TimeStamp last_up_to_date;
    unsigned int counter;
  };
}
 
#endif