Coin Logo http://www.sim.no
http://www.coin3d.org

Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions

SoOneShot Class Reference

The SoOneShot class is a timer that runs for a configurable time and then stops. More...

#include <Inventor/engines/SoOneShot.h>

Inheritance diagram for SoOneShot:
SoEngine SoFieldContainer SoBase

List of all members.

Public Types

enum  Flags { RETRIGGERABLE = 1, HOLD_FINAL = 2 }

Public Member Functions

 SoOneShot (void)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFTime timeIn
SoSFTime duration
SoSFTrigger trigger
SoSFBitMask flags
SoSFBool disable
SoEngineOutput timeOut
SoEngineOutput isActive
SoEngineOutput ramp

Protected Member Functions

 ~SoOneShot ()

Detailed Description

The SoOneShot class is a timer that runs for a configurable time and then stops.


Member Enumeration Documentation

There are two flags available: RETRIGGERABLE will cause the engine to restart at 0 if the SoOneShot::trigger field is activated during a run (otherwise the trigger is ignored during runs).

HOLD_FINAL will make the engine outputs keep their values after a run, instead of resetting them.


Constructor & Destructor Documentation

SoOneShot::SoOneShot ( void  )
SoOneShot::~SoOneShot ( ) [protected]

Destructor is protected to avoid explicit destruction.


Member Function Documentation

void SoOneShot::initClass ( void  ) [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoEngine.


Member Data Documentation

Input time source. Connected by default to the realTime global field, but the application programmer is free to change this to any other time source.

Referenced by SoOneShot().

The time the engine should run for when it is triggered. Defaults to 1 second.

Referenced by SoOneShot().

A pulse on this input field starts the engine.

Referenced by SoOneShot().

Control flags. See SoOneShot::Flags.

Reimplemented from SoEngine.

Referenced by SoOneShot().

Set to TRUE to disable the engine completely.

Referenced by SoOneShot().

(SoSFTime) Output time. Will run from 0 to the value of SoOneShot::duration.

Referenced by SoOneShot().

(SoSFBool) TRUE while the engine is running, FALSE otherwise.

Referenced by SoOneShot().

(SoSFFloat) Will run from 0 to 1 during the active period.

Referenced by SoOneShot().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:17 for Coin by Doxygen. 1.7.3