GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOONESHOT (3)

NAME

SoOneShot — timer that runs for a pre-set amount of time

CONTENTS

Inherits From
Synopsis
Description
Inputs
Outputs
Methods
File Format/defaults
See Also

INHERITS FROM

SoBase > SoFieldContainer > SoEngine > SoOneShot

SYNOPSIS

#include <Inventor/engines/SoOneShot.h>

enum Flags {     SoOneShot::RETRIGGERABLE    
                           SoOneShot::RETRIGGERABLE   Can start over during the cycle    
SoOneShot::HOLD_FINAL    
                           SoOneShot::HOLD_FINAL      Output values stay high after cycle
}

Inputs from class SoOneShot:

    SoSFTime    
                    
SoSFTime             timeIn    
SoSFTime    
                    
SoSFTime             duration    
SoSFTrigger    
                    
SoSFTrigger          trigger    
SoSFBitMask    
                    
SoSFBitMask          flags    
SoSFBool    
                    
SoSFBool             disable

Outputs from class SoOneShot:

    (SoSFTime)    
                    
(SoSFTime)           timeOut    
(SoSFBool)    
                    
(SoSFBool)           isActive    
(SoSFFloat)    
                    
(SoSFFloat)          ramp

Methods from class SoOneShot:

       
                    
                     SoOneShot()

Methods from class SoEngine:

    static SoType    
                    
static SoType        getClassTypeId()    
virtual int    
                    
virtual int          getOutputs(SoEngineOutputList &list) const    
SoEngineOutput *    
                    
SoEngineOutput *     getOutput(const SbName &outputName) const    
SbBool    
                    
SbBool               getOutputName(const SoEngineOutput *output, SbName &outputName) const    
SoEngine *    
                    
SoEngine *           copy() const    
static SoEngine *    
                    
static SoEngine *    getByName(const SbName &name)    
static int    
                    
static int           getByName(const SbName &name, SoEngineList &list)

Methods from class SoFieldContainer:

    void    
                    
void                 setToDefaults()    
SbBool    
                    
SbBool               hasDefaultValues() const    
SbBool    
                    
SbBool               fieldsAreEqual(const SoFieldContainer *fc) const    
void    
                    
void                 copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)    
SbBool    
                    
SbBool               set(const char *fieldDataString)    
void    
                    
void                 get(SbString &fieldDataString)    
virtual int    
                    
virtual int          getFields(SoFieldList &resultList) const    
virtual SoField *    
                    
virtual SoField *    getField(const SbName &fieldName) const    
SbBool    
                    
SbBool               getFieldName(const SoField *field, SbName &fieldName) const    
SbBool    
                    
SbBool               isNotifyEnabled() const    
SbBool    
                    
SbBool               enableNotify(SbBool flag)

Methods from class SoBase:

    void    
                    
void                 ref()    
void    
                    
void                 unref() const    
void    
                    
void                 unrefNoDelete() const    
void    
                    
void                 touch()    
virtual SoType    
                    
virtual SoType       getTypeId() const    
SbBool    
                    
SbBool               isOfType(SoType type) const    
virtual void    
                    
virtual void         setName(const SbName &name)    
virtual SbName    
                    
virtual SbName       getName() const

DESCRIPTION

This engine is a timer that runs for a pre-set amount of time and then stops. By default, the timeIn input is connected to the realTime global field. It can, however, by connected to any other time source.

The timer is started when the trigger input is touched. It then runs for the specified duration, and updates the timeOut output with the time that has elapsed. During that time, the ramp output is also updated. The ramp output starts at 0.0 at the beginning of the cycle, and linearly increases until it reaches 1.0 at the end of the cycle.

You can disable the timer by setting the disable input to TRUE. The output value remains 0.0 while the timer is disabled. If the timer is disabled in the middle of a cycle the output values will be set to 0.0.

The flags input contains control flags. Using the flags you can set the timer to be retriggerable in the middle of a cycle, and set the output values to stay high after the cycle has been completed. By default, these flags are not set.

INPUTS

    SoSFTime    
                    
SoSFTime             timeIn
Running time.

    SoSFTime    
                    
SoSFTime             duration
Duration of the active cycle.

    SoSFTrigger    
                    
SoSFTrigger          trigger
Start the cycle. The trigger will be ignored if it is touched in the middle of a cycle and the RETRIGGERABLE flag is not set.

    SoSFBitMask    
                    
SoSFBitMask          flags
Control flags.

    SoSFBool    
                    
SoSFBool             disable
If TRUE, the timer is disabled.

OUTPUTS

    (SoSFTime)    
                    
(SoSFTime)           timeOut
Elapsed time from the start.

    (SoSFBool)    
                    
(SoSFBool)           isActive
Is TRUE during the active cycle.

    (SoSFFloat)    
                    
(SoSFFloat)          ramp
Ramps linearly from 0.0 to 1.0.

METHODS

       
                    
                     SoOneShot()
Constructor

FILE FORMAT/DEFAULTS

OneShot {



duration  1
trigger   
flags     ()
disable   FALSE
timeIn    <current time>


}

SEE ALSO

SoElapsedTime, SoEngineOutput

Search for    or go to Top of page |  Section 3 |  Main Index


SOONESHOT(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.