MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/engines/SoOneShot.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:
 |      This file contains the declaration of the OneShot engine
 |
 |   Classes:
 |      SoOneShot
 |
 |   Author(s)          : Ronen Barzel
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_ONE_SHOT_
#define  _SO_ONE_SHOT_

#include <Inventor/system/SbSystem.h>
#include <Inventor/engines/SoSubEngine.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFTrigger.h>
#include <Inventor/fields/SoSFTime.h>
#include <Inventor/fields/SoSFBitMask.h>




class INVENTOR_API SoOneShot : public SoEngine {

    SO_ENGINE_HEADER(SoOneShot);

  public:
    enum Flags  {
        RETRIGGERABLE   = (1<<0),       
        HOLD_FINAL      = (1<<1)        
    };



    SoSFTime            duration;       

    SoSFTrigger         trigger;        

    SoSFBitMask         flags;

    SoSFBool            disable;        

    SoSFTime            timeIn;




    SoEngineOutput      timeOut;        

    SoEngineOutput      isActive;       

    SoEngineOutput      ramp;           


    SoOneShot();

  SoINTERNAL public:

    static void initClass();

  protected:
    virtual void        inputChanged(SoField *whichInput);

    virtual void        writeInstance(SoOutput *out);

    virtual SbBool      readInstance(SoInput *in, unsigned short flags);

  private:
    enum State {
        DISABLED,               
        OFF,                    
        TRIGGERED,              
        ON,                     
        PEAKED                  
    }                   state;
    SbTime              baseTime;       
    SbTime              timeVal;        
    double              rampVal;        
    SbBool              outputPending;  

    ~SoOneShot();

    virtual void        evaluate();
};

#endif  /* _SO_ONE_SHOT_ */