X3DTimeDependentNode.h

Go to the documentation of this file.

//    Copyright 2004, 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 __X3DTIMEDEPENDENTNODE_H__
#define __X3DTIMEDEPENDENTNODE_H__

#include "X3DChildNode.h"
#include "SFTime.h"
#include "SFBool.h"

namespace H3D {

  class H3DAPI_API X3DTimeDependentNode : public X3DChildNode {
  public:
    
    class H3DAPI_API TimeHandler: public AutoUpdate< SFTime > {
    public:

      virtual void activate( H3DDouble time );

      virtual void deactivate( H3DDouble time );

    protected:
      virtual void update();
    };

    class StartTime: public SFTime {
    public:
      virtual void setValue( const H3DDouble &time, int id = 0 ) {
        X3DTimeDependentNode *time_node = 
          static_cast< X3DTimeDependentNode * >( getOwner() );
        if( !time_node->isActive->getValue() ) {
          SFTime::setValue( time, id );
        }
      } 

    protected:
      virtual void propagateEvent( Event e ) {
        X3DTimeDependentNode *time_node = 
          static_cast< X3DTimeDependentNode * >( getOwner() );
        if( !time_node->isActive->getValue() ) {
          SFTime::propagateEvent( e );
        }
      }
    };


    class StopTime: public SFTime {
    public:
      virtual void setValue( const H3DDouble &time, int id = 0 ) {
        X3DTimeDependentNode *time_node = 
          static_cast< X3DTimeDependentNode * >( getOwner() );
        if( !time_node->isActive->getValue() ||
            time > 
            time_node->startTime->getValue()) {
          SFTime::setValue( time, id );
          // Setting the time to the current time on an active time node
          // will cause it to deactivate.
          if( time_node->isActive->getValue() &&
              time_node->timeHandler->getValue() == time ) {
            time_node->timeHandler->deactivate( time );
          } 
        }
      }

    protected:
      virtual void propagateEvent( Event e ) {
        X3DTimeDependentNode *time_node = 
          static_cast< X3DTimeDependentNode * >( getOwner() );
        if( !time_node->isActive->getValue() ||
            time_node->stopTime->getValue() > time_node->startTime->getValue()) {
          SFTime::propagateEvent( e );
        }
      }

      virtual void update() {
        SFTime::update();
        X3DTimeDependentNode *time_node = 
          static_cast< X3DTimeDependentNode * >( getOwner() );
        if( time_node->isActive->getValue() &&
            time_node->timeHandler->getValue() == value ) {
          time_node->timeHandler->deactivate( value );
        } 
      }
    };

    X3DTimeDependentNode( Inst< SFNode > _metadata    = 0,
                          Inst< SFBool > _loop        = 0,
                          Inst< SFTime > _pauseTime   = 0,
                          Inst< SFTime > _resumeTime  = 0,
                          Inst< StartTime > _startTime   = 0,
                          Inst< StopTime  > _stopTime    = 0,
                          Inst< SFTime > _elapsedTime = 0,
                          Inst< SFBool > _isActive    = 0,
                          Inst< SFBool > _isPaused    = 0,
                          Inst< TimeHandler > _timeHandler = 0 );
    
    virtual void initialize();

    virtual void onPause() {}

    virtual void onResume() {}

    virtual void onStart() {}

    virtual void onStop() {}

    auto_ptr< SFBool > loop;

    auto_ptr< SFTime > pauseTime;

    auto_ptr< SFTime > resumeTime;

    auto_ptr< StartTime > startTime;

    auto_ptr< StopTime > stopTime;

    auto_ptr< SFTime > elapsedTime;

    auto_ptr< SFBool > isActive;

    auto_ptr< SFBool > isPaused;

    static H3DNodeDatabase database;

  protected:
    auto_ptr< TimeHandler > timeHandler;
  };
}

#endif

---