Coin: SoEngine.h Source File

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

SoEngine.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_SOENGINE_H
34#define COIN_SOENGINE_H
35
36#include <Inventor/fields/SoFieldContainer.h>
37
38class SoEngineList;
39class SoEngineOutput;
40class SoEngineOutputList;
41class SoEngineOutputData;
42
43 class COIN_DLL_API SoEngine : public SoFieldContainer {
44 typedef SoFieldContainer inherited;
45
46public:
47 static void initClass(void);
48 static void initClasses(void);
49 static SoType getClassTypeId(void);
50
51 void evaluateWrapper(void);
52
53 virtual int getOutputs(SoEngineOutputList & l) const;
54 SoEngineOutput * getOutput(const SbName & outputname) const;
55 SbBool getOutputName(const SoEngineOutput * output, SbName & outputname) const;
56 virtual const SoEngineOutputData * getOutputData(void) const = 0;
57 static SoEngine * getByName(const SbName & name);
58 static int getByName(const SbName & name, SoEngineList & el);
59
60 SbBool isNotifying(void) const;
61 virtual void notify(SoNotList * nl);
62
63 SoEngine * copy(void) const;
64 virtual SoFieldContainer * copyThroughConnection(void) const;
65 SbBool shouldCopy(void) const;
66
67 virtual void writeInstance(SoOutput * out);
68
69
70protected:
71 SoEngine(void);
72 virtual ~SoEngine(void);
73 virtual void evaluate(void) = 0;
74
75 virtual SbBool readInstance(SoInput * in, unsigned short flags);
76 virtual void inputChanged(SoField * which);
77
78 static const SoFieldData ** getInputDataPtr(void);
79 static const SoEngineOutputData ** getOutputDataPtr(void);
80
81 void writeOutputTypes(SoOutput * out);
82
83private:
84 virtual void destroy(void); // overrides SoBase::destroy()
85
86 static SoType classTypeId;
87
88 enum InternalEngineFlags {
89 FLAG_ISNOTIFYING = (1 << 0),
90 FLAG_ISDIRTY = (1 << 1)
91 };
92
93 unsigned int flags;
94
95 // needed for handling connections from SoEngineOutput
96 friend class SoEngineOutput;
97 void setDirty(void);
98};
99
100#if !defined(COIN_INTERNAL)
101#include <Inventor/engines/SoEngineOutput.h>
102#endif // COIN_INTERNAL
103
104#endif // !COIN_SOENGINE_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SoBase::destroy
virtual void destroy(void)
Definition SoBase.cpp:299
SoEngineList
The SoEngineList class is a container for SoEngine objects.
Definition SoEngineList.h:40
SoEngineOutputData
The SoEngineOutputData class is a container for a prototype set of outputs.
Definition SoOutputData.h:49
SoEngineOutputList
The SoEngineOutputList class is a container for SoEngineOutput objects.
Definition SoEngineOutputList.h:40
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::evaluate
virtual void evaluate(void)=0
SoEngine::getOutputData
virtual const SoEngineOutputData * getOutputData(void) const =0
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
SoFieldContainer::writeInstance
virtual void writeInstance(SoOutput *out)
Definition SoFieldContainer.cpp:733
SoFieldContainer::getClassTypeId
static SoType getClassTypeId(void)
This static method returns the SoType object associated with objects of this class.
Definition SoFieldContainer.cpp:283
SoFieldContainer::notify
virtual void notify(SoNotList *l)
Definition SoFieldContainer.cpp:654
SoFieldContainer::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoFieldContainer.cpp:241
SoFieldContainer::copyThroughConnection
virtual SoFieldContainer * copyThroughConnection(void) const
Definition SoFieldContainer.cpp:822
SoFieldContainer::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoFieldContainer.cpp:1049
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
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59