Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/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 
40 class SoNotList;
41 class SoFieldContainer;
42 class SoEngine;
43 class SoNodeEngine;
44 
45 class COIN_DLL_API SoEngineOutput {
46 public:
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 
72 private:
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
SoEngine is the base class for Coin engines.
Definition: SoEngine.h:43
The SoFieldContainer class is a base class for all classes that contain fields.
Definition: SoFieldContainer.h:43
SoNodeEngine is the base class for Coin node engines.
Definition: SoNodeEngine.h:42
The SoField class is the top-level abstract base class for fields.
Definition: SoField.h:47
The SoEngineOutput class is the output slots in SoEngine instances.
Definition: SoEngineOutput.h:45
The SoFieldList class is a container for pointers to SoField objects.
Definition: SoFieldList.h:40
The SoNotList class is a list of SoNotRec notification records.
Definition: SoNotification.h:43
The SoType class is the basis for the run-time type system in Coin.
Definition: SoType.h:59