Coin: SoTimeCounter.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoTimeCounter.h
1/**************************************************************************\
2 * Copyright (c) Kongsberg Oil & Gas Technologies AS
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31\**************************************************************************/
32
33#ifndef COIN_SOTIMECOUNTER_H
34#define COIN_SOTIMECOUNTER_H
35
36#include <Inventor/engines/SoSubEngine.h>
37#include <Inventor/engines/SoEngineOutput.h>
38#include <Inventor/fields/SoSFTime.h>
39#include <Inventor/fields/SoSFFloat.h>
40#include <Inventor/fields/SoMFFloat.h>
41#include <Inventor/fields/SoSFBool.h>
42#include <Inventor/fields/SoSFTrigger.h>
43#include <Inventor/fields/SoSFShort.h>
44
45 class COIN_DLL_API SoTimeCounter : public SoEngine {
46 typedef SoEngine inherited;
47 SO_ENGINE_HEADER(SoTimeCounter);
48
49public:
50 SoSFTime timeIn;
51 SoSFShort min;
52 SoSFShort max;
53 SoSFShort step;
54 SoSFBool on;
55 SoSFFloat frequency;
56 SoMFFloat duty;
57 SoSFShort reset;
58 SoSFTrigger syncIn;
59
60 SoEngineOutput output; // SoSFShort
61 SoEngineOutput syncOut; // SoSFTrigger
62
63 SoTimeCounter();
64 static void initClass();
65
66protected:
67 virtual ~SoTimeCounter(void);
68
69 virtual void inputChanged(SoField * which);
70 virtual void writeInstance(SoOutput * out);
71
72private:
73 virtual void evaluate(void);
74 void calcStarttime(short value);
75
76 SbBool ispaused;
77 double pausetimeincycle;
78 SbBool firstoutputenable;
79 short outputvalue;
80 int numsteps;
81 int stepnum;
82 double starttime;
83 double cyclelen;
84 short findOutputValue(double timeincycle) const;
85 void calcDutySteps(void);
86 void calcNumSteps(void);
87
88 SbList <double> dutylimits;
89};
90
91#endif // !COIN_SOTIMECOUNTER_H
SoEngine::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoEngine.cpp:162
SoEngine::SoEngine
SoEngine(void)
Definition SoEngine.cpp:101
SoEngine::writeInstance
virtual void writeInstance(SoOutput *out)
Definition SoEngine.cpp:419
SoEngine::evaluate
virtual void evaluate(void)=0
SoEngine::inputChanged
virtual void inputChanged(SoField *which)
Definition SoEngine.cpp:304
SoField
The SoField class is the top-level abstract base class for fields.
Definition SoField.h:47
SoMFFloat
The SoMFFloat class is a container for floating point values.
Definition SoMFFloat.h:39
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoSFBool
The SoSFBool class is a container for an SbBool value.
Definition SoSFBool.h:39
SoSFFloat
The SoSFFloat class is a container for a floating point value.
Definition SoSFFloat.h:39
SoSFShort
The SoSFShort class is a container for a short integer value.
Definition SoSFShort.h:39
SoSFTime
The SoSFTime class is a container for an SbTime value.
Definition SoSFTime.h:40
SoSFTrigger
The SoSFTrigger class is the "void" class used for detecting field changes.
Definition SoSFTrigger.h:41
SoTimeCounter::output
SoEngineOutput output
Definition SoTimeCounter.h:60
SoTimeCounter::max
SoSFShort max
Definition SoTimeCounter.h:52
SoTimeCounter::syncIn
SoSFTrigger syncIn
Definition SoTimeCounter.h:58
SoTimeCounter::frequency
SoSFFloat frequency
Definition SoTimeCounter.h:55
SoTimeCounter::reset
SoSFShort reset
Definition SoTimeCounter.h:57
SoTimeCounter::timeIn
SoSFTime timeIn
Definition SoTimeCounter.h:50
SoTimeCounter::on
SoSFBool on
Definition SoTimeCounter.h:54
SoTimeCounter::SoTimeCounter
SoTimeCounter()
Definition SoTimeCounter.cpp:132
SoTimeCounter::step
SoSFShort step
Definition SoTimeCounter.h:53
SoTimeCounter::min
SoSFShort min
Definition SoTimeCounter.h:51
SoTimeCounter::duty
SoMFFloat duty
Definition SoTimeCounter.h:56
SoTimeCounter::syncOut
SoEngineOutput syncOut
Definition SoTimeCounter.h:61