NAME

       SoOnOff -

       The SoOnOff engine is a simple on/off switch.

SYNOPSIS

       #include <Inventor/engines/SoOnOff.h>

       Inherits SoEngine.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       virtual const SoFieldData * getFieldData (void) const
       virtual const SoEngineOutputData * getOutputData (void) const
       SoOnOff (void)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void * createInstance (void)
       static void initClass (void)

   Public Attributes
       SoSFTrigger on
       SoSFTrigger off
       SoSFTrigger toggle
       SoEngineOutput isOn
       SoEngineOutput isOff

   Protected Member Functions
       virtual ~SoOnOff (void)

   Static Protected Member Functions
       static const SoFieldData ** getInputDataPtr (void)
       static const SoEngineOutputData ** getOutputDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoOnOff engine is a simple on/off switch.

Constructor & Destructor Documentation

   SoOnOff::SoOnOff (void)
       Default constructor.

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

Member Function Documentation

   SoType SoOnOff::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This
       is used for run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines,
       nodekits, draggers or others: this method needs to be overridden in all subclasses. This
       is typically done as part of setting up the full type system for extension classes, which
       is usually accomplished by using the pre-defined macros available through for instance
       Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes),
       Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the
       toplevel superclasses for the various class groups.

       Implements SoBase.

   const SoFieldData * SoOnOff::getFieldData (void) const [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented from SoFieldContainer.

   const SoEngineOutputData * SoOnOff::getOutputData (void) const [virtual]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

       Implements SoEngine.

Member Data Documentation

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

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

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

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

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

Author

       Generated automatically by Doxygen for Coin from the source code.