SoTriggerAny.3coin2

Langue: en

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

Section: 3 (Bibliothèques de fonctions)

Sommaire

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


~SoTriggerAny ()

Static Protected Member Functions


static const SoFieldData ** getInputDataPtr (void)

static const SoEngineOutputData ** getOutputDataPtr (void)

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.

References input0, input1, input2, input3, input4, input5, input6, input7, input8, input9, and output.

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

Member Function Documentation

SoType SoTriggerAny::getClassTypeId (void) [static]This static method returns the SoType object associated with objects of this class.

Reimplemented from SoEngine.

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
     }
     else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
       SoGroup * group = (SoGroup *)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::getInputDataPtr (void) [static, protected]Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoEngine.

const SoEngineOutputData ** SoTriggerAny::getOutputDataPtr (void) [static, protected]Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Reimplemented from SoEngine.

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.

void SoTriggerAny::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 SoTriggerAny::input0Input trigger.

Referenced by SoTriggerAny().

SoSFTrigger SoTriggerAny::input1Input trigger.

Referenced by SoTriggerAny().

SoSFTrigger SoTriggerAny::input2Input trigger.

Referenced by SoTriggerAny().

SoSFTrigger SoTriggerAny::input3Input trigger.

Referenced by SoTriggerAny().

SoSFTrigger SoTriggerAny::input4Input trigger.

Referenced by SoTriggerAny().

SoSFTrigger SoTriggerAny::input5Input trigger.

Referenced by SoTriggerAny().

SoSFTrigger SoTriggerAny::input6Input trigger.

Referenced by SoTriggerAny().

SoSFTrigger SoTriggerAny::input7Input trigger.

Referenced by SoTriggerAny().

SoSFTrigger SoTriggerAny::input8Input trigger.

Referenced by SoTriggerAny().

SoSFTrigger SoTriggerAny::input9Input trigger.

Referenced by SoTriggerAny().

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

Referenced by SoTriggerAny().

Author

Generated automatically by Doxygen for Coin from the source code.