SoSelectOne(3IV)

NAME
     SoSelectOne (SoSelOne) - selects one value from a multiple-value field.

INHERITS FROM
     SoBase > SoFieldContainer > SoEngine > SoSelectOne

SYNOPSIS
     #include <Inventor_c/engines/SoSelectOne.h>

     typedef SoSelectOne  SoSelOne

          Inputs from class SoSelectOne:

     SoSFInt32           index
     <inputType>         input

          Outputs from class SoSelectOne:

     (<outputType>)      output

          Functions from class SoSelectOne:

     SoSelectOne *       SoSelOneSoSelOneCreate(SoType inputType)

          Functions from class SoEngine:

     SoType              SoSelOneGetTypeId()
     int                 SoSelOneGetOuts(const SoSelOne *this,
                              SoEngineOutputList *list)
     SoEngineOutput *    SoSelOneGetOut(const SoSelOne *this, const char
                              *outputName)
     SbBool              SoSelOneGetOutName(const SoSelOne *this, const
                              SoEngineOutput *output, SbName *outputName)
     SoEngine *          SoSelOneCopy(const SoSelOne *this)
     SoEngine *          SoSelOneGetByName(const char *name)
     int                 SoSelOneGetByNameList(const char *name, SoEngineList
                              *list)

          Functions from class SoFieldContainer:

     SoType              SoSelOneGetClassTypeId()
     void                SoSelOneSetToDflts(SoSelOne *this)
     SbBool              SoSelOneHasDfltVals(const SoSelOne *this)
     SbBool              SoSelOneFldsAreEq(const SoSelOne *this, const
                              SoFieldContainer *fc)
     void                SoSelOneCopyFieldVals(SoSelOne *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoSelOneSet(SoSelOne *this, const char
                              *fieldDataString)
     void                SoSelOneGet(SoSelOne *this, SbString
                              *fieldDataString)
     int                 SoSelOneGetFields(const SoSelOne *this, SoFieldList
                              *resultList)
     SoField *           SoSelOneGetField(const SoSelOne *this, const char
                              *fieldName)
     SbBool              SoSelOneGetFieldName(const SoSelOne *this, const
                              SoField *field, SbName *fieldName)
     SbBool              SoSelOneIsNotifyEnabled(const SoSelOne *this)
     SbBool              SoSelOneEnableNotify(SoSelOne *this, SbBool flag)

          Functions from class SoBase:

     void                SoSelOneRef(SoSelOne *this)
     void                SoSelOneUnref(const SoSelOne *this)
     void                SoSelOneUnrefNoDelete(const SoSelOne *this)
     void                SoSelOneTouch(SoSelOne *this)
     SbBool              SoSelOneIsOfType(const SoSelOne *this, SoType type)
     void                SoSelOneSetName(SoSelOne *this, const char *name)
     SbName              SoSelOneGetName(const SoSelOne *this)


DESCRIPTION
     This engine selects a single value from a multiple-value field, based on
     the input field index. The type of the input field can be any subclass of
     SoMField, and the type of the output is the corresponding subclass of
     SoSField.  For example, if the input type is SoMFVec3f, the output type
     will be SoSFVec3f. The type is specified when an instance of the class is
     created. For example,  SoSelOneCreate(SoMFloatGetClassTypeId()) creates
     an engine that selects one floating-point value.

     Note that unlike most other engine fields, the input field and output are
     pointers. Note also that by default input does not contain any values,
     and no value is output from the engine.

INPUTS
     SoSFInt32           index
          Index of the value to select from the multiple-value field.

     <inputType>         input
          The multiple-value field from which the value will be selected.


OUTPUTS
     (<outputType>)      output
          The single value selected.


FUNCTIONS
     SoSelectOne *       SoSelOneSoSelOneCreate(SoType inputType)
          Constructor. The argument specifies the type of the multiple-value
          input field.

FILE FORMAT/DEFAULTS
     SelectOne {
          type   <inputType>
          input  []
          index  0
     }

SEE ALSO
     SoEngineOutput, SoConcatenate, SoGate