Coin: SoEngineOutput.h Source File

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

SoEngineOutput.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_SOENGINEOUTPUT_H
34#define COIN_SOENGINEOUTPUT_H
35
36#include <Inventor/SoType.h>
37#include <Inventor/lists/SoFieldList.h>
38#include <Inventor/lists/SbList.h>
39
40class SoNotList;
41class SoFieldContainer;
42class SoEngine;
43class SoNodeEngine;
44
45 class COIN_DLL_API SoEngineOutput {
46public:
47 SoEngineOutput(void);
48 virtual ~SoEngineOutput(void);
49
50 SoType getConnectionType(void) const;
51 int getForwardConnections(SoFieldList & fl) const;
52 void enable(const SbBool flag);
53 SbBool isEnabled(void) const;
54 SoEngine * getContainer(void) const;
55 SoNodeEngine * getNodeContainer(void) const;
56 SbBool isNodeEngineOutput(void) const;
57
58 void setContainer(SoEngine * engine);
59 void setNodeContainer(SoNodeEngine * nodeengine);
60 void addConnection(SoField * f);
61 void removeConnection(SoField * f);
62 int getNumConnections(void) const;
63 SoField * operator[](int i) const;
64
65 void prepareToWrite(void) const;
66 void doneWriting(void) const;
67
68 void touchSlaves(SoNotList * nl, SbBool donotify);
69
70 SoFieldContainer * getFieldContainer(void);
71
72private:
73 SbBool enabled;
74 SoEngine * container; // FIXME: change to SoFieldContainer pointer
75 SoFieldList slaves;
76 SbList<SbBool> fieldnotiflist;
77};
78
79#endif // !COIN_SOENGINEOUTPUT_H
SbList
The SbList class is a template container class for lists.
Definition SbList.h:70
SoEngineOutput::isEnabled
SbBool isEnabled(void) const
Definition SoEngineOutput.cpp:161
SoEngineOutput::setContainer
void setContainer(SoEngine *engine)
Definition SoEngineOutput.cpp:230
SoEngineOutput::getForwardConnections
int getForwardConnections(SoFieldList &fl) const
Definition SoEngineOutput.cpp:122
SoEngineOutput::isNodeEngineOutput
SbBool isNodeEngineOutput(void) const
Definition SoEngineOutput.cpp:218
SoEngineOutput::prepareToWrite
void prepareToWrite(void) const
Definition SoEngineOutput.cpp:361
SoEngineOutput::setNodeContainer
void setNodeContainer(SoNodeEngine *nodeengine)
Definition SoEngineOutput.cpp:246
SoEngineOutput::getNumConnections
int getNumConnections(void) const
Definition SoEngineOutput.cpp:333
SoEngineOutput::doneWriting
void doneWriting(void) const
Definition SoEngineOutput.cpp:381
SoEngineOutput::addConnection
void addConnection(SoField *f)
Definition SoEngineOutput.cpp:261
SoEngineOutput::getFieldContainer
SoFieldContainer * getFieldContainer(void)
Definition SoEngineOutput.cpp:439
SoEngineOutput::touchSlaves
void touchSlaves(SoNotList *nl, SbBool donotify)
Definition SoEngineOutput.cpp:409
SoEngineOutput::enable
void enable(const SbBool flag)
Definition SoEngineOutput.cpp:149
SoEngineOutput::getNodeContainer
SoNodeEngine * getNodeContainer(void) const
Definition SoEngineOutput.cpp:197
SoEngineOutput::getContainer
SoEngine * getContainer(void) const
Definition SoEngineOutput.cpp:173
SoEngineOutput::removeConnection
void removeConnection(SoField *f)
Definition SoEngineOutput.cpp:304
SoEngineOutput::operator[]
SoField * operator[](int i) const
Definition SoEngineOutput.cpp:348
SoEngineOutput::getConnectionType
SoType getConnectionType(void) const
Definition SoEngineOutput.cpp:101
SoEngineOutput::SoEngineOutput
SoEngineOutput(void)
Definition SoEngineOutput.cpp:66
SoEngine
SoEngine is the base class for Coin engines.
Definition SoEngine.h:43
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
SoFieldList
The SoFieldList class is a container for pointers to SoField objects.
Definition SoFieldList.h:40
SoField
The SoField class is the top-level abstract base class for fields.
Definition SoField.h:47
SoNodeEngine
SoNodeEngine is the base class for Coin node engines.
Definition SoNodeEngine.h:42
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59