Rechercher une page de manuel
SoOneShot.3coin2
Langue: en
Version: 374114 (fedora - 01/12/10)
Section: 3 (Bibliothèques de fonctions)
Sommaire
- NAME
- SYNOPSIS
- Detailed Description
- Member Enumeration Documentation
- Constructor & Destructor Documentation
- Member Function Documentation
- Member Data Documentation
- SoSFTime SoOneShot::timeInInput time source. Connected by default to the realTime global field, but the application programmer is free to change this to any other time source.
- SoSFTime SoOneShot::durationThe time the engine should run for when it is triggered. Defaults to 1 second.
- SoSFTrigger SoOneShot::triggerA pulse on this input field starts the engine.
- SoSFBitMask SoOneShot::flagsControl flags. See SoOneShot::Flags.
- SoSFBool SoOneShot::disableSet to TRUE to disable the engine completely.
- SoEngineOutput SoOneShot::timeOut(SoSFTime) Output time. Will run from 0 to the value of SoOneShot::duration.
- SoEngineOutput SoOneShot::isActive(SoSFBool) TRUE while the engine is running, FALSE otherwise.
- SoEngineOutput SoOneShot::ramp(SoSFFloat) Will run from 0 to 1 during the active period.
- Author
NAME
SoOneShot -The SoOneShot class is a timer that runs for a configurable time and then stops.
SYNOPSIS
#include <Inventor/engines/SoOneShot.h>
Inherits SoEngine.
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
enum SoOneShot::FlagsThere 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)Default constructor.
References SoField::connectFrom(), disable, duration, flags, SoDB::getGlobalField(), isActive, ramp, timeIn, timeOut, trigger, and SbTime::zero().
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
SoSFTime SoOneShot::timeInInput 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().
SoSFTime SoOneShot::durationThe time the engine should run for when it is triggered. Defaults to 1 second.
Referenced by SoOneShot().
SoSFTrigger SoOneShot::triggerA pulse on this input field starts the engine.
Referenced by SoOneShot().
SoSFBitMask SoOneShot::flagsControl flags. See SoOneShot::Flags.
Reimplemented from SoEngine.
Referenced by SoOneShot().
SoSFBool SoOneShot::disableSet to TRUE to disable the engine completely.
Referenced by SoOneShot().
SoEngineOutput SoOneShot::timeOut(SoSFTime) Output time. Will run from 0 to the value of SoOneShot::duration.
Referenced by SoOneShot().
SoEngineOutput SoOneShot::isActive(SoSFBool) TRUE while the engine is running, FALSE otherwise.
Referenced by SoOneShot().
SoEngineOutput SoOneShot::ramp(SoSFFloat) Will run from 0 to 1 during the active period.
Referenced by SoOneShot().
Author
Generated automatically by Doxygen for Coin from the source code.
Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre