SoTriggerAny(3)

NAME
SoTriggerAny - The SoTriggerAny class is a fan-in engine for triggers.

When any one of the input triggers are 'pulsed', any field connected as a slave to the engine output will be notified.

SYNOPSIS

#include <Inventor/engines/SoTriggerAny.h>

Inherits SoEngine.

  Public Member Functions
virtual SoType getTypeId (void) const
virtual const SoFieldData * getFieldData (void) const
virtual const SoEngineOutputData * getOutputData (void) const
SoTriggerAny (void)

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

  Public Attributes
SoSFTrigger input0
SoSFTrigger input1
SoSFTrigger input2
SoSFTrigger input3
SoSFTrigger input4
SoSFTrigger input5
SoSFTrigger input6
SoSFTrigger input7
SoSFTrigger input8
SoSFTrigger input9
SoEngineOutput output

  Protected Member Functions
virtual ~SoTriggerAny (void)

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

  Additional Inherited Members

Detailed Description

The SoTriggerAny class is a fan-in engine for triggers.

When any one of the input triggers are 'pulsed', any field connected as a slave to the engine output will be notified.

Constructor & Destructor Documentation

  SoTriggerAny::SoTriggerAny (void)
Default constructor.

  SoTriggerAny::~SoTriggerAny (void) [protected], [virtual]
Destructor is protected because explicit destruction of engines is not allowed.

Member Function Documentation

  SoType SoTriggerAny::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 * SoTriggerAny::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 * SoTriggerAny::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 SoTriggerAny::input0
Input trigger.

  SoSFTrigger SoTriggerAny::input1
Input trigger.

  SoSFTrigger SoTriggerAny::input2
Input trigger.

  SoSFTrigger SoTriggerAny::input3
Input trigger.

  SoSFTrigger SoTriggerAny::input4
Input trigger.

  SoSFTrigger SoTriggerAny::input5
Input trigger.

  SoSFTrigger SoTriggerAny::input6
Input trigger.

  SoSFTrigger SoTriggerAny::input7
Input trigger.

  SoSFTrigger SoTriggerAny::input8
Input trigger.

  SoSFTrigger SoTriggerAny::input9
Input trigger.

  SoEngineOutput SoTriggerAny::output
(SoSFTrigger) Connect to the output with the field(s) you want notified upon any input trigger 'pulses'.

Author

Generated automatically by Doxygen for Coin from the source code.