Coin: SoNodeEngine.h Source File

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

SoNodeEngine.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_SONODEENGINE_H
34#define COIN_SONODEENGINE_H
35
36#include <Inventor/nodes/SoNode.h>
37
38class SoEngineOutput;
39class SoEngineOutputList;
40class SoEngineOutputData;
41
42 class COIN_DLL_API SoNodeEngine : public SoNode {
43 typedef SoNode inherited;
44
45public:
46 static void initClass(void);
47 static SoType getClassTypeId(void);
48
49 void evaluateWrapper(void);
50
51 virtual int getOutputs(SoEngineOutputList & l) const;
52 SoEngineOutput * getOutput(const SbName & outputname) const;
53 SbBool getOutputName(const SoEngineOutput * output, SbName & outputname) const;
54 virtual const SoEngineOutputData * getOutputData(void) const = 0;
55
56 SbBool isNotifying(void) const;
57 virtual void notify(SoNotList * nl);
58
59 virtual void writeInstance(SoOutput * out);
60
61protected:
62 SoNodeEngine(void);
63 virtual ~SoNodeEngine(void);
64 virtual void evaluate(void) = 0;
65
66 virtual SbBool readInstance(SoInput * in, unsigned short flags);
67 virtual void inputChanged(SoField * which);
68
69 static const SoFieldData ** getFieldDataPtr(void);
70 static const SoEngineOutputData ** getOutputDataPtr(void);
71
72 void writeOutputTypes(SoOutput * out);
73
74private:
75 virtual void destroy(void); // overrides SoBase::destroy()
76
77 static SoType classTypeId;
78 unsigned int flags;
79};
80
81#endif // !COIN_SONODEENGINE_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SoBase::destroy
virtual void destroy(void)
Definition SoBase.cpp:299
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
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
SoNodeEngine
SoNodeEngine is the base class for Coin node engines.
Definition SoNodeEngine.h:42
SoNodeEngine::evaluate
virtual void evaluate(void)=0
SoNodeEngine::getOutputData
virtual const SoEngineOutputData * getOutputData(void) const =0
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoNode::notify
virtual void notify(SoNotList *l)
Definition SoNode.cpp:506
SoNode::writeInstance
virtual void writeInstance(SoOutput *out)
Definition SoNode.cpp:1412
SoNode::getClassTypeId
static SoType getClassTypeId(void)
Definition SoNode.cpp:361
SoNode::getFieldDataPtr
static const SoFieldData ** getFieldDataPtr(void)
Definition SoNode.cpp:1535
SoNode::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoNode.cpp:1542
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
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