SoSelectOne(3iv)

1SoSelectOne(3IV)()                                          SoSelectOne(3IV)()
2
3
4

NAME

6       SoSelectOne — selects one value from a multiple-value field.
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoEngine > SoSelectOne
10

SYNOPSIS

12       #include <Inventor/engines/SoSelectOne.h>
13
14          Inputs from class SoSelectOne:
15
16     SoSFInt32           index
17     <inputType>         input
18
19          Outputs from class SoSelectOne:
20
21     (<outputType>)      output
22
23          Methods from class SoSelectOne:
24
25                         SoSelectOne(SoType inputType)
26
27          Methods from class SoEngine:
28
29     static SoType       getClassTypeId()
30     virtual int         getOutputs(SoEngineOutputList &list) const
31     SoEngineOutput *    getOutput(const SbName &outputName) const
32     SbBool              getOutputName(const  SoEngineOutput  *output,  SbName
33                              &outputName) const
34     SoEngine *          copy() const
35     static SoEngine *   getByName(const SbName &name)
36     static int          getByName(const SbName &name, SoEngineList &list)
37
38          Methods from class SoFieldContainer:
39
40     void                setToDefaults()
41     SbBool              hasDefaultValues() const
42     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
43     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
44                              copyConnections = FALSE)
45     SbBool              set(const char *fieldDataString)
46     void                get(SbString &fieldDataString)
47     virtual int         getFields(SoFieldList &resultList) const
48     virtual SoField *   getField(const SbName &fieldName) const
49     SbBool              getFieldName(const SoField *field, SbName &fieldName)
50                              const
51     SbBool              isNotifyEnabled() const
52     SbBool              enableNotify(SbBool flag)
53
54          Methods from class SoBase:
55
56     void                ref()
57     void                unref() const
58     void                unrefNoDelete() const
59     void                touch()
60     virtual SoType      getTypeId() const
61     SbBool              isOfType(SoType type) const
62     virtual void        setName(const SbName &name)
63     virtual SbName      getName() const
64
65

DESCRIPTION

67       This engine selects a single value from a multiple-value  field,  based
68       on  the  input field index. The type of the input field can be any sub‐
69       class of SoMField, and the type of the output is the corresponding sub‐
70       class  of  SoSField.   For example, if the input type is SoMFVec3f, the
71       output type will be SoSFVec3f. The type is specified when  an  instance
72       of  the  class  is  created.  For  example, SoSelectOne(SoMFFloat::get‐
73       ClassTypeId())  creates  an  engine  that  selects  one  floating-point
74       value.
75
76       Note  that  unlike most other engine fields, the input field and output
77       are pointers. Note also that by default input does not contain any val‐
78       ues, and no value is output from the engine.
79

INPUTS

81     SoSFInt32           index
82          Index of the value to select from the multiple-value field.
83
84     <inputType>         input
85          The multiple-value field from which the value will be selected.
86
87

OUTPUTS

89     (<outputType>)      output
90          The single value selected.
91
92

METHODS

94                         SoSelectOne(SoType inputType)
95          Constructor.  The  argument specifies the type of the multiple-value
96          input field.
97
98

FILE FORMAT/DEFAULTS

100       SelectOne {
101          type   <inputType>
102          input  []
103          index  0
104     }
105