Coin: SoGate.h Source File

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

SoGate.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_SOGATE_H
34#define COIN_SOGATE_H
35
36#include <Inventor/engines/SoSubEngine.h>
37#include <Inventor/fields/SoMField.h>
38#include <Inventor/fields/SoSFBool.h>
39#include <Inventor/fields/SoSFTrigger.h>
40
41class SoEngineOutput;
42
43
44 class COIN_DLL_API SoGate : public SoEngine {
45 typedef SoEngine inherited;
46
47 SO_ENGINE_HEADER(SoGate);
48
49public:
50 static void initClass(void);
51 SoGate(SoType type);
52
53 SoSFBool enable;
54 SoSFTrigger trigger;
55 SoMField * input;
56
57 SoEngineOutput * output;
58
59protected:
60 virtual void inputChanged(SoField * which);
61
62private:
63 SoGate(void);
64 virtual ~SoGate(void);
65
66 virtual void evaluate(void);
67
68 virtual SbBool readInstance(SoInput * in, unsigned short flags);
69 virtual void writeInstance(SoOutput * out);
70
71 void initialize(const SoType inputfieldtype);
72
73 virtual void copyContents(const SoFieldContainer * from,
74 SbBool copyconnections);
75
76 // SoGate instances uses a dynamic set of inputs and outputs, as
77 // they are not common for all instances of the class (like for most
78 // of the other engines).
79 SoFieldData * dynamicinput;
80 SoEngineOutputData * dynamicoutput;
81
82 // Avoid a g++/egcs warning due to the private default constructor.
83 friend class dummy;
84};
85
86#endif // !COIN_SOGATE_H
SoEngineOutputData
The SoEngineOutputData class is a container for a prototype set of outputs.
Definition SoOutputData.h:49
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::writeInstance
virtual void writeInstance(SoOutput *out)
Definition SoEngine.cpp:419
SoEngine::evaluate
virtual void evaluate(void)=0
SoEngine::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoEngine.cpp:408
SoEngine::inputChanged
virtual void inputChanged(SoField *which)
Definition SoEngine.cpp:304
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
SoFieldContainer::copyContents
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition SoFieldContainer.cpp:804
SoFieldData
The SoFieldData class is a container for a prototype set of fields.
Definition SoFieldData.h:48
SoField
The SoField class is the top-level abstract base class for fields.
Definition SoField.h:47
SoGate
The SoGate class is used to selectively copy values from input to output.
Definition SoGate.h:44
SoGate::enable
SoSFBool enable
Definition SoGate.h:53
SoGate::output
SoEngineOutput * output
Definition SoGate.h:57
SoGate::trigger
SoSFTrigger trigger
Definition SoGate.h:54
SoGate::input
SoMField * input
Definition SoGate.h:55
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoMField
The SoMField class is the base class for fields which can contain multiple values.
Definition SoMField.h:41
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
SoSFTrigger
The SoSFTrigger class is the "void" class used for detecting field changes.
Definition SoSFTrigger.h:41
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59