SoGate Class Reference
[Engines]
Selectively copies its input to its output. More...
#include <Inventor/engines/SoGate.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoGate (SoType mfInputType) | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoSFBool | enable |
| SoSFTrigger | trigger |
| SoMField * | input |
| SoEngineOutput * | output |
Detailed Description
Selectively copies its input to its output.
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 continuous 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 by default input does not contain any values.
Note also that unlike most other engine fields, input and output are pointers.
FILE FORMAT/DEFAULT
- Gate {
| type | <inputType> |
| input | [] |
| enable | FALSE |
| trigger |
SEE ALSO
SoEngineOutput, SoConcatenate, SoSelectOne
Constructor & Destructor Documentation
| SoGate::SoGate | ( | SoType | mfInputType | ) |
Constructor.
The argument specifies the type of the input field.
Member Function Documentation
| static SoType SoGate::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoEngine.
| virtual SoType SoGate::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoTypedObject.
Member Data Documentation
Enable continous flow-through.
The value that is copied to the output when the gate is open.
( lt ) Contains a copy of the input value if the gate is open.
Copy a single value.
The documentation for this class was generated from the following file:
- Inventor/engines/SoGate.h