Coin: SoOnOff.h Source File

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

SoOnOff.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_SOONOFF_H
34#define COIN_SOONOFF_H
35
36#include <Inventor/engines/SoSubEngine.h>
37#include <Inventor/engines/SoEngineOutput.h>
38#include <Inventor/fields/SoSFTrigger.h>
39
40
41 class COIN_DLL_API SoOnOff : public SoEngine {
42 typedef SoEngine inherited;
43
44 SO_ENGINE_HEADER(SoOnOff);
45
46public:
47 static void initClass(void);
48 SoOnOff(void);
49
50 SoSFTrigger on;
51 SoSFTrigger off;
52 SoSFTrigger toggle;
53
54 SoEngineOutput isOn; // SoSFBool
55 SoEngineOutput isOff; // SoSFBool
56
57protected:
58 virtual ~SoOnOff(void);
59
60private:
61 virtual void evaluate(void);
62 virtual void inputChanged(SoField * which);
63
64 SbBool state;
65};
66
67#endif // !COIN_SOONOFF_H
SoEngineOutput
The SoEngineOutput class is the output slots in SoEngine instances.
Definition SoEngineOutput.h:45
SoEngine
SoEngine is the base class for Coin engines.
Definition SoEngine.h:43
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::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
SoOnOff
The SoOnOff engine is a simple on/off switch.
Definition SoOnOff.h:41
SoOnOff::isOn
SoEngineOutput isOn
Definition SoOnOff.h:54
SoOnOff::isOff
SoEngineOutput isOff
Definition SoOnOff.h:55
SoOnOff::off
SoSFTrigger off
Definition SoOnOff.h:51
SoOnOff::on
SoSFTrigger on
Definition SoOnOff.h:50
SoOnOff::toggle
SoSFTrigger toggle
Definition SoOnOff.h:52
SoSFTrigger
The SoSFTrigger class is the "void" class used for detecting field changes.
Definition SoSFTrigger.h:41