Open Inventor Reference
SoGate Class Reference

Selectively copies its input to its output. More...

#include <Inventor/engines/SoGate.h>

Inheritance diagram for SoGate:
SoEngine SoFieldContainer SoBase

List of all members.

Public Member Functions

 SoGate (SoType mfInputType)
 Constructor. The argument specifies the type of the input field.

Static Public Member Functions

static void initClass ()
 Initializes base engine class.

Public Attributes

SoSFBool enable
 enable continuous flow-through
SoSFTrigger trigger
 copy a single value
SoMFieldinput
 Note that unlike most engines the input field is a pointer.
SoEngineOutputoutput
 Note that unlike most engines the output is a pointer.

Protected Member Functions

virtual void inputChanged (SoField *whichInput)
 This is called whenever the value of an input is changed.
virtual SoFieldContainercopyThroughConnection () const
 Copies an instance that is encountered through a field connection.

Detailed Description

This engine selectively copies its input to its output. The type of the input field can be any subclass of SoMField. The type is specified when an instance of the class is created. For example, SoGate(SoMFFloat::getClassTypeId()) creates an engine that copies floating-point values.

The enable input controls continous flow-through of values. While enable is TRUE, the input will be copied to the output. Alternatively, by touching the trigger input, you can copy a single value from the input to the output.

Note that unlike most other engine fields, input and output are pointers. Note also that by default input does not contain any values.

See Also
SoEngineOutput, SoConcatenate, SoSelectOne

Definition at line 96 of file SoGate.h.


Constructor & Destructor Documentation

SoGate::SoGate ( SoType  mfInputType)

Member Function Documentation

virtual SoFieldContainer* SoGate::copyThroughConnection ( ) const [protected, virtual]

Reimplemented from SoEngine.

static void SoGate::initClass ( ) [static]

Reimplemented from SoEngine.

virtual void SoGate::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 105 of file SoGate.h.

The default value for this field is no values.

Definition at line 110 of file SoGate.h.

The type of the output is the same as the input.

Definition at line 114 of file SoGate.h.

Definition at line 106 of file SoGate.h.


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