SoGate(3IV)NAMESoGate (SoGate) - selectively copies its input to its output
INHERITS FROM
SoBase > SoFieldContainer > SoEngine > SoGateSYNOPSIS
#include <Inventor_c/engines/SoGate.h>
Inputs from class SoGate:
SoSFBool enable
SoSFTrigger trigger
<inputType> input
Outputs from class SoGate:
(<outputType>) output
Functions from class SoGate:
SoGate * SoGateSoGateCreate(SoType inputType)
Functions from class SoEngine:
SoType SoGateGetTypeId()
int SoGateGetOuts(const SoGate *this, SoEngineOutputList
*list)
SoEngineOutput * SoGateGetOut(const SoGate *this, const char
*outputName)
SbBool SoGateGetOutName(const SoGate *this, const
SoEngineOutput *output, SbName *outputName)
SoEngine * SoGateCopy(const SoGate *this)
SoEngine * SoGateGetByName(const char *name)
int SoGateGetByNameList(const char *name, SoEngineList
*list)
Functions from class SoFieldContainer:
SoType SoGateGetClassTypeId()
void SoGateSetToDflts(SoGate *this)
SbBool SoGateHasDfltVals(const SoGate *this)
SbBool SoGateFldsAreEq(const SoGate *this, const
SoFieldContainer *fc)
void SoGateCopyFieldVals(SoGate *this, const
SoFieldContainer *fc, SbBool copyConnections =
FALSE)
SbBool SoGateSet(SoGate *this, const char *fieldDataString)
void SoGateGet(SoGate *this, SbString *fieldDataString)
int SoGateGetFields(const SoGate *this, SoFieldList
*resultList)
Page 1SoGate(3IV)
SoField * SoGateGetField(const SoGate *this, const char
*fieldName)
SbBool SoGateGetFieldName(const SoGate *this, const SoField
*field, SbName *fieldName)
SbBool SoGateIsNotifyEnabled(const SoGate *this)
SbBool SoGateEnableNotify(SoGate *this, SbBool flag)
Functions from class SoBase:
void SoGateRef(SoGate *this)
void SoGateUnref(const SoGate *this)
void SoGateUnrefNoDelete(const SoGate *this)
void SoGateTouch(SoGate *this)
SbBool SoGateIsOfType(const SoGate *this, SoType type)
void SoGateSetName(SoGate *this, const char *name)
SbName SoGateGetName(const SoGate *this)
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,
SoGateCreate(SoMFloatGetClassTypeId()) 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
SoSFBool enable
Enable continous flow-through.
SoSFTrigger trigger
Copy a single value.
<inputType> input
The value that is copied to the output when the gate is open.
OUTPUTS
(<outputType>) output
Contains a copy of the input value if the gate is open.
FUNCTIONSSoGate * SoGateSoGateCreate(SoType inputType)
Constructor. The argument specifies the type of the input field.
Page 2SoGate(3IV)FILE FORMAT/DEFAULTS
Gate {
type <inputType>
input []
enable FALSE
trigger
}
SEE ALSO
SoEngineOutput, SoConcatenate, SoSelectOne
Page 3
