SoElapsedTime(3iv)

1SoElapsedTime(3IV)()                                      SoElapsedTime(3IV)()
2
3
4

NAME

6       SoElapsedTime — basic controllable time source
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoEngine > SoElapsedTime
10

SYNOPSIS

12       #include <Inventor/engines/SoElapsedTime.h>
13
14          Inputs from class SoElapsedTime:
15
16     SoSFTime            timeIn
17     SoSFFloat           speed
18     SoSFBool            on
19     SoSFBool            pause
20     SoSFTrigger         reset
21
22          Outputs from class SoElapsedTime:
23
24     (SoSFTime)          timeOut
25
26          Methods from class SoElapsedTime:
27
28                         SoElapsedTime()
29
30          Methods from class SoEngine:
31
32     static SoType       getClassTypeId()
33     virtual int         getOutputs(SoEngineOutputList &list) const
34     SoEngineOutput *    getOutput(const SbName &outputName) const
35     SbBool              getOutputName(const  SoEngineOutput  *output,  SbName
36                              &outputName) const
37     SoEngine *          copy() const
38     static SoEngine *   getByName(const SbName &name)
39     static int          getByName(const SbName &name, SoEngineList &list)
40
41          Methods from class SoFieldContainer:
42
43     void                setToDefaults()
44     SbBool              hasDefaultValues() const
45     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
46     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
47                              copyConnections = FALSE)
48     SbBool              set(const char *fieldDataString)
49     void                get(SbString &fieldDataString)
50     virtual int         getFields(SoFieldList &resultList) const
51     virtual SoField *   getField(const SbName &fieldName) const
52     SbBool              getFieldName(const SoField *field, SbName &fieldName)
53                              const
54     SbBool              isNotifyEnabled() const
55     SbBool              enableNotify(SbBool flag)
56
57          Methods from class SoBase:
58
59     void                ref()
60     void                unref() const
61     void                unrefNoDelete() const
62     void                touch()
63     virtual SoType      getTypeId() const
64     SbBool              isOfType(SoType type) const
65     virtual void        setName(const SbName &name)
66     virtual SbName      getName() const
67
68

DESCRIPTION

70       This engine functions as a stopwatch; it  outputs  the  time  that  has
71       elapsed  since it started running. By default, the timeIn input is con‐
72       nected to the realTime global field. It can, however, be  connected  to
73       any other time source.
74
75       The ouput from the engine is the time that has elapsed since it started
76       running, or since the reset input was last triggered.  You  can  affect
77       the speed of the output time by setting the speed scale factor. A value
78       greater than 1.0 will speed up the output, and a value  less  than  1.0
79       will slow it down.
80
81       If  you  pause the engine, by setting the pause input to TRUE, it stops
82       updating the timeOut output. When you turn off the pause, it  jumps  to
83       its current position without losing time. Alternatively, if you want to
84       stop the engine for a while, and then restart it  from  where  it  left
85       off, use the on input field.
86

INPUTS

88     SoSFTime            timeIn
89          Running time.
90
91     SoSFFloat           speed
92          Scale factor for time.
93
94     SoSFBool            on
95          TRUE to start running, FALSE to stop.
96
97     SoSFBool            pause
98          TRUE to freeze, FALSE to continue running.
99
100     SoSFTrigger         reset
101          Reset the base time.
102
103

OUTPUTS

105     (SoSFTime)          timeOut
106          Time elapsed, modified by the speed factor.
107
108

METHODS

110                         SoElapsedTime()
111          Constructor.
112
113

FILE FORMAT/DEFAULTS

115       ElapsedTime {
116          timeIn  <current time>
117          speed   1
118          on      TRUE
119          pause   FALSE
120          reset
121     }
122