man SoGate () - selectively copies its input to its output

NAME

SoGate - selectively copies its input to its output

INHERITS FROM

SoBase > SoFieldContainer > SoEngine > SoGate

SYNOPSIS

#include <Inventor/engines/SoGate.h> Inputs from class SoGate: c } c } enable

c } c } trigger

c } c } input Outputs from class SoGate: c } c } output Methods from class SoGate: c } c } SoGate(SoType inputType) Methods from class SoEngine: c } c } getClassTypeId()

c } c } getOutputs(SoEngineOutputList &list) const

c } c } getOutput(const SbName &outputName) const

c } c } getOutputName(const SoEngineOutput *output, SbName &outputName) const

c } c } copy() const

c } c } getByName(const SbName &name)

c } c } getByName(const SbName &name, SoEngineList &list) Methods from class SoFieldContainer: c } c } setToDefaults()

c } c } hasDefaultValues() const

c } c } fieldsAreEqual(const SoFieldContainer *fc) const

c } c } copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)

c } c } set(const char *fieldDataString)

c } c } get(SbString &fieldDataString)

c } c } getFields(SoFieldList &resultList) const

c } c } getField(const SbName &fieldName) const

c } c } getFieldName(const SoField *field, SbName &fieldName) const

c } c } isNotifyEnabled() const

c } c } enableNotify(SbBool flag) Methods from class SoBase: c } c } ref()

c } c } unref() const

c } c } unrefNoDelete() const

c } c } touch()

c } c } getTypeId() const

c } c } isOfType(SoType type) const

c } c } setName(const SbName &name)

c } c } getName() const

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.

INPUTS

c } c } enable

Enable continous flow-through. c } c } trigger

Copy a single value. c } c } input

The value that is copied to the output when the gate is open.

OUTPUTS

c } c } output

Contains a copy of the input value if the gate is open.

METHODS

c } c } SoGate(SoType inputType)

Constructor. The argument specifies the type of the input field.

FILE FORMAT/DEFAULTS

Gate {
type	<inputType>
input	[]
enable	FALSE
trigger	
}

SEE ALSO

SoEngineOutput, SoConcatenate, SoSelectOne