Open Inventor Reference
SoOnOff.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * Further, this software is distributed without any warranty that it is
16  * free of the rightful claim of any third person regarding infringement
17  * or the like. Any license provided herein, whether implied or
18  * otherwise, applies only to this software file. Patent licenses, if
19  * any, provided herein do not apply to combinations of this program with
20  * other software, or any other product whatsoever.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27  * Mountain View, CA 94043, or:
28  *
29  * http://www.sgi.com
30  *
31  * For further information regarding this notice, see:
32  *
33  * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34  *
35  */
36 
37 
38 /*
39  * Copyright (C) 1990,91,92 Silicon Graphics, Inc.
40  *
41  _______________________________________________________________________
42  ______________ S I L I C O N G R A P H I C S I N C . ____________
43  |
44  | $Revision: 1.1.1.1 $
45  |
46  | Description:
47  | This file contains the declaration of the OnOff engine
48  |
49  | Classes:
50  | SoOnOff
51  |
52  | Author(s) : Ronen Barzel
53  |
54  ______________ S I L I C O N G R A P H I C S I N C . ____________
55  _______________________________________________________________________
56  */
57 
58 #ifndef _SO_ON_OFF_
59 #define _SO_ON_OFF_
60 
64 
67 
89 
90 class INVENTOR_API SoOnOff : public SoEngine {
91 
93 
94  public:
95 
97 
98 
101 
104 
107 
109 
111 
112 
115 
118 
120 
123 
124  SoINTERNAL public:
125 
126  static void initClass();
127 
128  protected:
129  virtual void inputChanged(SoField *whichInput);
130 
131  private:
132 
134  ~SoOnOff();
135 
137  virtual void evaluate();
138 
139  bool state;
140 };
141 
142 #endif /* _SO_ON_OFF_ */
#define SoINTERNAL
Definition: SbBasic.h:155
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
#define SO_ENGINE_HEADER(className)
Definition: SoSubEngine.h:166
Class for all engine outputs.
Definition: SoEngine.h:228
Base class for all engines.
Definition: SoEngine.h:102
virtual void evaluate()=0
User-written evaluation engine.
Base class for all fields.
Definition: SoField.h:185
Engine that functions as an on/off switch.
Definition: SoOnOff.h:90
SoEngineOutput isOn
Switch value.
Definition: SoOnOff.h:114
SoEngineOutput isOff
The inverse of isOn .
Definition: SoOnOff.h:117
SoOnOff()
Constructor.
virtual void inputChanged(SoField *whichInput)
This is called whenever the value of an input is changed.
SoSFTrigger off
Turn the isOn switch off.
Definition: SoOnOff.h:103
SoSFTrigger on
Turn the isOn switch on.
Definition: SoOnOff.h:100
static void initClass()
SoSFTrigger toggle
Toggle the switch value.
Definition: SoOnOff.h:106
Field used to trigger engines or connection networks.
Definition: SoSFTrigger.h:88