Coin: SoOneShot.h Source File

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

SoOneShot.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_SOONESHOT_H
34#define COIN_SOONESHOT_H
35
36#include <Inventor/engines/SoSubEngine.h>
37#include <Inventor/engines/SoEngineOutput.h>
38#include <Inventor/fields/SoSFTime.h>
39#include <Inventor/fields/SoSFBool.h>
40#include <Inventor/fields/SoSFTrigger.h>
41#include <Inventor/fields/SoSFBitMask.h>
42
43
44 class COIN_DLL_API SoOneShot : public SoEngine {
45 typedef SoEngine inherited;
46
47 SO_ENGINE_HEADER(SoOneShot);
48
49public:
50 static void initClass(void);
51 SoOneShot(void);
52
53 enum Flags {RETRIGGERABLE=1, HOLD_FINAL=2};
54
55 SoSFTime timeIn;
56 SoSFTime duration;
57 SoSFTrigger trigger;
58 SoSFBitMask flags;
59 SoSFBool disable;
60
61 SoEngineOutput timeOut; // SoSFTime
62 SoEngineOutput isActive; // SoSFBool
63 SoEngineOutput ramp; // SoSFFloat
64
65protected:
66 virtual ~SoOneShot(void);
67
68private:
69 virtual void evaluate(void);
70 virtual void inputChanged(SoField * which);
71 virtual void writeInstance(SoOutput * out);
72
73 SbTime holdduration;
74 float holdramp;
75 SbTime starttime;
76 SbBool running;
77};
78
79#endif // !COIN_SOONESHOT_H
SbTime
The SbTime class instances represents time values.
Definition SbTime.h:50
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
SoOneShot::timeOut
SoEngineOutput timeOut
Definition SoOneShot.h:61
SoOneShot::flags
SoSFBitMask flags
Definition SoOneShot.h:58
SoOneShot::timeIn
SoSFTime timeIn
Definition SoOneShot.h:55
SoOneShot::duration
SoSFTime duration
Definition SoOneShot.h:56
SoOneShot::ramp
SoEngineOutput ramp
Definition SoOneShot.h:63
SoOneShot::trigger
SoSFTrigger trigger
Definition SoOneShot.h:57
SoOneShot::isActive
SoEngineOutput isActive
Definition SoOneShot.h:62
SoOneShot::disable
SoSFBool disable
Definition SoOneShot.h:59
SoOneShot::Flags
Flags
Definition SoOneShot.h:53
SoOneShot::SoOneShot
SoOneShot(void)
Definition SoOneShot.cpp:121
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoSFBitMask
The SoSFBitMask class is a container for a set of bit flags.
Definition SoSFBitMask.h:38
SoSFBool
The SoSFBool class is a container for an SbBool value.
Definition SoSFBool.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