SoOneShot.h Source File

| http://www.sim.no/ http://www.coin3d.org/

- Main Page
- Related Pages
- Modules
- Classes
- Files

- File List
- File Members

SoOneShot.h
1 /**************************************************************************\
2 *
3 * This file is part of the Coin 3D visualization library.
4 * Copyright (C) by Kongsberg Oil & Gas Technologies.
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * ("GPL") version 2 as published by the Free Software Foundation.
9 * See the file LICENSE.GPL at the root directory of this source
10 * distribution for additional information about the GNU GPL.
11 *
12 * For using Coin with software that can not be combined with the GNU
13 * GPL, and for taking advantage of the additional benefits of our
14 * support services, please contact Kongsberg Oil & Gas Technologies
15 * about acquiring a Coin Professional Edition License.
16 *
17 * See http://www.coin3d.org/ for more information.
18 *
19 * Kongsberg Oil & Gas Technologies, Bygdoy Alle 5, 0257 Oslo, NORWAY.
20 * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
21 *
22 \**************************************************************************/
23
24 #ifndef COIN_SOONESHOT_H
25 #define COIN_SOONESHOT_H
26
27 #include <Inventor/engines/SoSubEngine.h>
28 #include <Inventor/engines/SoEngineOutput.h>
29 #include <Inventor/fields/SoSFTime.h>
30 #include <Inventor/fields/SoSFBool.h>
31 #include <Inventor/fields/SoSFTrigger.h>
32 #include <Inventor/fields/SoSFBitMask.h>
33
34
35 class COIN_DLL_API SoOneShot : public SoEngine {
36 typedef SoEngine inherited;
37
38 SO_ENGINE_HEADER(SoOneShot);
39
40 public:
41 static void initClass(void);
42 SoOneShot(void);
43
44 enum Flags {RETRIGGERABLE=1, HOLD_FINAL=2};
45
46 SoSFTime timeIn;
47 SoSFTime duration;
48 SoSFTrigger trigger;
49 SoSFBitMask flags;
50 SoSFBool disable;
51
52 SoEngineOutput timeOut; // SoSFTime
53 SoEngineOutput isActive; // SoSFBool
54 SoEngineOutput ramp; // SoSFFloat
55
56 protected:
57 virtual ~SoOneShot(void);
58
59 private:
60 virtual void evaluate(void);
61 virtual void inputChanged(SoField * which);
62 virtual void writeInstance(SoOutput * out);
63
64 SbTime holdduration;
65 float holdramp;
66 SbTime starttime;
67 SbBool running;
68 };
69
70 #endif // !COIN_SOONESHOT_H
SoOutput
The SoOutput class is an abstraction of an output stream.SoOutput offers the ability to write basic t...
Definition: SoOutput.h:42
SoEngine::writeInstance
virtual void writeInstance(SoOutput *out)
Definition: SoEngine.cpp:405
SoOneShot::duration
SoSFTime duration
Definition: SoOneShot.h:47
SoEngine
SoEngine is the base class for Coin engines.Engines enables the application programmers to make compl...
Definition: SoEngine.h:34
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.The classes containing...
Definition: SoFieldContainer.h:34
SoSFTrigger
The SoSFTrigger class is the "void" class used for detecting field changes.Connect this field to a ma...
Definition: SoSFTrigger.h:32
SoField
The SoField class is the top-level abstract base class for fields.Fields is the mechanism used throug...
Definition: SoField.h:38
SoOneShot::trigger
SoSFTrigger trigger
Definition: SoOneShot.h:48
SoSFBool
The SoSFBool class is a container for an SbBool value.This field is used where nodes, engines or other field containers needs to store a boolean on/off or TRUE/FALSE value, like for instance as the "on" field of the SoPointLight, SoSpotLight and SoDirectionalLight node classes.
Definition: SoSFBool.h:30
SoOneShot::flags
SoSFBitMask flags
Definition: SoOneShot.h:49
SoEngine::inputChanged
virtual void inputChanged(SoField *which)
Definition: SoEngine.cpp:290
SoOneShot
The SoOneShot class is a timer that runs for a configurable time and then stops.
Definition: SoOneShot.h:35
SoOneShot::timeIn
SoSFTime timeIn
Definition: SoOneShot.h:46
SoOneShot::disable
SoSFBool disable
Definition: SoOneShot.h:50
SbTime
The SbTime class instances represents time values.SbTime is a convenient way of doing system independ...
Definition: SbTime.h:41
SoOneShot::ramp
SoEngineOutput ramp
Definition: SoOneShot.h:54
SoEngineOutput
The SoEngineOutput class is the output slots in SoEngine instances.SoEngineOutput has methods for con...
Definition: SoEngineOutput.h:36
SoOneShot::timeOut
SoEngineOutput timeOut
Definition: SoOneShot.h:52
SoSFTime
The SoSFTime class is a container for an SbTime value.This field is used where nodes, engines or other field containers needs to store a single time representation.
Definition: SoSFTime.h:31
SoEngine::evaluate
virtual void evaluate(void)=0
SoOneShot::Flags
Flags
Definition: SoOneShot.h:44
SoSFBitMask
The SoSFBitMask class is a container for a set of bit flags.This field is used where nodes...
Definition: SoSFBitMask.h:29
SoOneShot::isActive
SoEngineOutput isActive
Definition: SoOneShot.h:53

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.