SoOnOff.3coin2

Langue: en

Version: 382667 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

NAME

SoOnOff -

The SoOnOff engine is a simple on/off switch.

SYNOPSIS


#include <Inventor/engines/SoOnOff.h>

Inherits SoEngine.

Public Member Functions


SoOnOff (void)

Static Public Member Functions


static void initClass (void)

Public Attributes


SoSFTrigger on

SoSFTrigger off

SoSFTrigger toggle

SoEngineOutput isOn

SoEngineOutput isOff

Protected Member Functions


~SoOnOff ()

Detailed Description

The SoOnOff engine is a simple on/off switch.

Constructor & Destructor Documentation

SoOnOff::SoOnOff (void)Default constructor.

References isOff, isOn, off, on, and toggle.

SoOnOff::~SoOnOff () [protected]Destructor is protected because engines are reference counted.

Member Function Documentation

void SoOnOff::initClass (void) [static]Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoEngine.

Member Data Documentation

SoSFTrigger SoOnOff::onAn input signal on this trigger makes the SoOnOff::isOn output become TRUE.

Referenced by SoOnOff().

SoSFTrigger SoOnOff::offAn input signal on this trigger makes the SoOnOff::isOn output become FALSE.

Referenced by SoOnOff().

SoSFTrigger SoOnOff::toggleAn input signal on this trigger toggles the TRUE or FALSE value of the SoOnOff::isOn output.

Referenced by SoOnOff().

SoEngineOutput SoOnOff::isOn(SoSFBool) Whether the engine is 'on' or not.

Referenced by SoOnOff().

SoEngineOutput SoOnOff::isOff(SoSFBool) Always the opposite value of SoOnOff::isOn.

Referenced by SoOnOff().

Author

Generated automatically by Doxygen for Coin from the source code.