Coin: SoOutputData.h Source File

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

SoOutputData.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_OUTPUTDATA_H
34#define COIN_OUTPUTDATA_H
35
36#include <Inventor/SbBasic.h>
37#include <Inventor/lists/SbList.h>
38
39class SoEngine;
40class SoNodeEngine;
41class SoFieldContainer;
42class SoEngineOutput;
43class SbName;
44class SoInput;
45class SoOutput;
46class SoOutputDataEntry;
47class SoType;
48
49 class COIN_DLL_API SoEngineOutputData {
50public:
51 SoEngineOutputData(void);
52 SoEngineOutputData(const SoEngineOutputData * data);
53 SoEngineOutputData(int approxnum);
54 ~SoEngineOutputData(void);
55
56 void addOutput(const SoEngine * base, const char *name,
57 const SoEngineOutput * output, SoType type);
58 void addOutput(const SoNodeEngine * base, const char *name,
59 const SoEngineOutput * output, SoType type);
60
61 int getNumOutputs(void) const;
62 const SbName & getOutputName(int index) const;
63 SoEngineOutput * getOutput(const SoEngine * engine, int index) const;
64 SoEngineOutput * getOutput(const SoNodeEngine * engine, int index) const;
65 int getIndex(const SoEngine * engine, const SoEngineOutput * output) const;
66 int getIndex(const SoNodeEngine * engine, const SoEngineOutput * output) const;
67 const SoType & getType(int index) const;
68 SbBool readDescriptions(SoInput * input, SoEngine * engine) const;
69 void writeDescriptions(SoOutput * out, SoEngine * engine) const;
70
71private:
72 SbBool hasOutput(const char * name) const;
73 void addOutputInternal(const SoFieldContainer * base, const char *name,
74 const SoEngineOutput * output, SoType type);
75 SoEngineOutput * getOutputInternal(const SoFieldContainer * base, int index) const;
76 int getIndexInternal(const SoFieldContainer * base, const SoEngineOutput * output) const;
77
78 SbList <SoOutputDataEntry*> outputlist;
79};
80
81#endif // !COIN_OUTPUTDATA_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
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
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
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
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