Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoGate.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 : Ronen Barzel (MMM yyyy)
25** Modified by : Gavin Bell (MMM yyyy)
26**=======================================================================*/
27/*=======================================================================
28 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
29 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
30 *** ***
31 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
32 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
33 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
34 *** ***
35 *** RESTRICTED RIGHTS LEGEND ***
36 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
37 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
38 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
39 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
40 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
41 *** ***
42 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
43 *** BORDEAUX, FRANCE ***
44 *** ALL RIGHTS RESERVED ***
45**=======================================================================*/
46/*=======================================================================
47** Modified by : VSG (MMM YYYY)
48**=======================================================================*/
49
50
51#ifndef _SO_GATE_
52#define _SO_GATE_
53
54#include <Inventor/SoDB.h>
55#include <Inventor/engines/SoSubEngine.h>
56#include <Inventor/fields/SoSFBool.h>
57#include <Inventor/fields/SoSFName.h>
58#include <Inventor/fields/SoSFTrigger.h>
59
61//
62// Class: SoGate
63//
64// Gate engine class. A gate engine copies its input to its output,
65// when the "enable" field is true. It will also do a one-time copy
66// when the trigger field is touched.
67//
69
70
111class SoGate : public SoEngine {
112
113 SO_ENGINE_HEADER(SoGate);
114
115 public:
119 SoGate(SoType mfInputType);
120
129
134
139
140 private:
141 static void initClass();
142 static void exitClass();
143
144 // Copies an instance that is encountered through a field connection
145 virtual SoFieldContainer *copyThroughConnection() const;
146
147 private:
148 ~SoGate();
149 virtual void inputChanged(SoField *whichInput);
150
151 // Copies the contents of the given node into this instance
152 virtual void copyContents(const SoFieldContainer *fromFC,
153 SbBool copyConnections);
154
156 virtual void evaluate();
157
158 private:
159 SoGate();
160
161 // gate engines must write out their input type before writing
162 // their fields, so these are overridden:
163 virtual SbBool readInstance(SoInput *in, unsigned short flags);
164 virtual void writeInstance(SoOutput *out);
165
166 void setup(SoType);
167
168 int conversionCase;
169
170 SoFieldData *myInputData;
171 SoEngineOutputData *myOutputData;
172
173 SoSFName typeField; // Used when reading/writing
174};
175
176#endif /* _SO_GATE_ */
177
Base class for all engines.
Definition SoEngine.h:133
Class for all engine outputs.
Definition SoEngine.h:282
Abstract base class for objects that contain fields.
Base class for all fields.
Definition SoField.h:234
Selectively copies its input to its output.
Definition SoGate.h:111
SoSFBool enable
Enable continous flow-through.
Definition SoGate.h:124
SoEngineOutput * output
( lt ) Contains a copy of the input value if the gate is open.
Definition SoGate.h:138
SoSFTrigger trigger
Copy a single value.
Definition SoGate.h:128
SoGate(SoType mfInputType)
Constructor.
SoMField * input
The value that is copied to the output when the gate is open.
Definition SoGate.h:133
Used to read Open Inventor data files.
Definition SoInput.h:363
Base class for all multiple-valued fields.
Definition SoMField.h:134
Used to write Open Inventor data files.
Definition SoOutput.h:186
Field containing a single Boolean value.
Definition SoSFBool.h:79
Field containing a name.
Definition SoSFName.h:84
Field used to trigger engines or connection networks.
Definition SoSFTrigger.h:85
Stores runtime type information.
Definition SoType.h:98
int SbBool
Boolean type.
Definition SbBase.h:87