Open Inventor Reference
SoOnOff Class Reference

Engine that functions as an on/off switch. More...

#include <Inventor/engines/SoOnOff.h>

Inheritance diagram for SoOnOff:
SoEngine SoFieldContainer SoBase

List of all members.

Public Member Functions

 SoOnOff ()
 Constructor.

Static Public Member Functions

static void initClass ()
 Initializes base engine class.

Public Attributes

Inputs
SoSFTrigger on
 Turn the isOn switch on.
SoSFTrigger off
 Turn the isOn switch off.
SoSFTrigger toggle
 Toggle the switch value.
Outputs
SoEngineOutput isOn
 Switch value.
SoEngineOutput isOff
 The inverse of isOn .

Protected Member Functions

virtual void inputChanged (SoField *whichInput)
 This is called whenever the value of an input is changed.

Detailed Description

This engine has three triggers as input and two Boolean values as output. The isOn output is a switch that can be turned on or off by triggering the corresponding input. You can toggle the value by triggering the toggle input. By default isOn is FALSE. The isOff output value is the inverse of isOn

File Format/Default
OnOff {
}
See Also
SoEngineOutput

Definition at line 90 of file SoOnOff.h.


Constructor & Destructor Documentation

SoOnOff::SoOnOff ( )

Member Function Documentation

static void SoOnOff::initClass ( ) [static]

Reimplemented from SoEngine.

virtual void SoOnOff::inputChanged ( SoField whichField) [protected, virtual]

The default method does nothing. Subclasses can override this to detect when a specific field is changed.

Reimplemented from SoEngine.


Member Data Documentation

Definition at line 117 of file SoOnOff.h.

Definition at line 114 of file SoOnOff.h.

Definition at line 103 of file SoOnOff.h.

Definition at line 100 of file SoOnOff.h.

Definition at line 106 of file SoOnOff.h.


The documentation for this class was generated from the following file: