Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
SoOutputData.h
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : Paul S. Strauss (MMM yyyy)
25** Modified by : Nick Thompson (MMM yyyy)
26** Modified by : Gavin Bell (MMM yyyy)
27**=======================================================================*/
28/*=======================================================================
29 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
30 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
31 *** ***
32 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
33 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
34 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
35 *** ***
36 *** RESTRICTED RIGHTS LEGEND ***
37 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
38 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
39 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
40 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
41 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
42 *** ***
43 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
44 *** BORDEAUX, FRANCE ***
45 *** ALL RIGHTS RESERVED ***
46**=======================================================================*/
47/*=======================================================================
48** Modified by : VSG (MMM YYYY)
49**=======================================================================*/
50
51
52
53#ifndef _SO_OUTPUT_DATA_
54#define _SO_OUTPUT_DATA_
55
56#include <Inventor/misc/SoBasic.h>
57#include <Inventor/SbPList.h>
58#include <Inventor/SbString.h>
59#include <Inventor/SoType.h>
60
61class SoEngine;
63class SoInput;
64class SoOutput;
65class SoEngineOutput;
66
68//
69// Class: SoEngineOutputData
70//
71// The SoEngineOutputData class holds data about engine outputs: the
72// number of outputs the engine has, the names of the outputs.
73//
74// All engines of a given class share the same output data. Therefore,
75// to get information about a particular output in a particular engine
76// instance, it is necessary to pass that instance to the appropriate
77// method.
78//
80
81{
82 public:
83 // Default constructor
84 SoEngineOutputData() { }
85
86 SoEngineOutputData(const SoEngineOutputData *);
87
88 // Constructor that takes number of fields as a hint
89 SoEngineOutputData(int numOutputs) : outputs(numOutputs)
90 { }
91
92 // Destructor
93 ~SoEngineOutputData();
94
95 // Adds an output to current data, given name of output,
96 // a pointer to field within the engine, and the type of output.
97 void addOutput(const SoEngine *defEngine,
98 const char *outputName,
99 const SoEngineOutput *output,
100 SoType type);
101
102 // Returns number of outputs
103 int getNumOutputs() const { return outputs.getLength(); }
104
105 // Returns name of output with given index
106 const SbName & getOutputName(int index) const;
107
108 // Returns pointer to output with given index within given object instance
109 SoEngineOutput * getOutput(const SoEngine *engine,
110 int index) const;
111
112 // Returns index of output, given the output and the engine it
113 // is in.
114 int getIndex(const SoEngine *engine,
115 const SoEngineOutput *output) const;
116
117 // Returns type of output with given index
118 const SoType & getType(int index) const;
119
120 // Methods to read and write the output descriptions
121 SbBool readDescriptions(SoInput *in,
122 SoEngine *engine) const;
123 void writeDescriptions(SoOutput *out,
124 SoEngine *engine) const;
125 private:
126 SbPList outputs; // List of outputs (SoOutputEntry)
127};
128
129#endif /* _SO_OUTPUT_DATA_ */
130
131
Character string stored in a hash table.
Definition SbName.h:162
List of generic (void *) pointers.
Definition SbPList.h:77
int getLength() const
Returns number of pointers in list.
Definition SbPList.h:125
Base class for all engines.
Definition SoEngine.h:133
Class for all engine outputs.
Definition SoEngine.h:279
Abstract base class for objects that contain fields.
Used to read Open Inventor data files.
Definition SoInput.h:363
Used to write Open Inventor data files.
Definition SoOutput.h:186
Stores runtime type information.
Definition SoType.h:98
int SbBool
Boolean type.
Definition SbBase.h:87