Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
SoOneShot.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**=======================================================================*/
26/*=======================================================================
27 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
28 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
29 *** ***
30 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
31 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
32 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
33 *** ***
34 *** RESTRICTED RIGHTS LEGEND ***
35 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
36 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
37 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
38 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
39 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
40 *** ***
41 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
42 *** BORDEAUX, FRANCE ***
43 *** ALL RIGHTS RESERVED ***
44**=======================================================================*/
45/*=======================================================================
46** Modified by : VSG (MMM YYYY)
47**=======================================================================*/
48
49
50#ifndef _SO_ONE_SHOT_
51#define _SO_ONE_SHOT_
52
53#include <Inventor/engines/SoSubEngine.h>
54#include <Inventor/fields/SoSFBool.h>
55#include <Inventor/fields/SoSFTrigger.h>
56#include <Inventor/fields/SoSFTime.h>
57#include <Inventor/fields/SoSFBitMask.h>
58
101class SoOneShot : public SoEngine {
102
103 SO_ENGINE_HEADER(SoOneShot);
104
105 public:
106
108 enum Flags {
110 RETRIGGERABLE = (1<<0),
112 HOLD_FINAL = (1<<1)
113 };
114
136
149
154
155 private:
156
157 static void initClass();
158 static void exitClass();
159
160 // Writes instance to SoOutput. Takes care of not writing out
161 // connection to realTime that is created in constructor.
162 virtual void writeInstance(SoOutput *out);
163
164 private:
165 virtual void inputChanged(SoField *whichInput);
166
167 // Evaluation method
168 virtual void evaluate();
169
170 // Reads stuff into instance. Works around a problem with old
171 // files that contain explicit references to the default
172 // connection to realTime.
173 virtual SbBool readInstance(SoInput *in, unsigned short flags);
174
175 // Destructor
176 ~SoOneShot();
177 private:
178 enum State {
179 DISABLED, // everything clamped at 0 (via disable input)
180 OFF, // normal idle state
181 TRIGGERED, // has been triggered, need to start running
182 ON, // running, watching the time
183 PEAKED // have reached the end, need to reset
184 } state;
185 SbTime baseTime; // Starting time for elapsed time
186 SbTime timeVal; // holds output time value
187 double rampVal; // holds ramp value
188 SbBool outputPending; // keeps outputs enabled until data is read
189
190
191
193 //
194 // #unfound enum Flags
195 //
197
198};
199
200#endif /* _SO_ONE_SHOT_ */
201
Class for representation of a time.
Definition SbTime.h:91
Base class for all engines.
Definition SoEngine.h:133
Class for all engine outputs.
Definition SoEngine.h:279
Base class for all fields.
Definition SoField.h:234
Used to read Open Inventor data files.
Definition SoInput.h:363
Timer that runs for a pre-set amount of time.
Definition SoOneShot.h:101
SoEngineOutput timeOut
( SoSFTime ) Elapsed time from the start.
Definition SoOneShot.h:140
SoSFBitMask flags
Control flags.
Definition SoOneShot.h:127
SoSFTime timeIn
Running time.
Definition SoOneShot.h:135
SoSFTime duration
Duration of the active cycle.
Definition SoOneShot.h:118
SoOneShot()
Constructor.
SoEngineOutput ramp
( SoSFFloat ) Ramps linearly from 0.0 to 1.0.
Definition SoOneShot.h:148
SoSFTrigger trigger
Start the cycle.
Definition SoOneShot.h:123
SoEngineOutput isActive
( SoSFBool ) Is TRUE during the active cycle.
Definition SoOneShot.h:144
SoSFBool disable
If TRUE, the timer is disabled.
Definition SoOneShot.h:131
Flags
Flags.
Definition SoOneShot.h:108
@ HOLD_FINAL
Output values stay high after cycle.
Definition SoOneShot.h:112
@ RETRIGGERABLE
Can start over during the cycle.
Definition SoOneShot.h:110
Used to write Open Inventor data files.
Definition SoOutput.h:186
Single-value field containing a set of bit flags.
Field containing a single Boolean value.
Definition SoSFBool.h:79
Field containing an SbTime.
Definition SoSFTime.h:82
Field used to trigger engines or connection networks.
Definition SoSFTrigger.h:85
int SbBool
Boolean type.
Definition SbBase.h:87