1SoMFBool(3IV)()                                                SoMFBool(3IV)()
2
3
4

NAME

6       SoMFBool — multiple-value field containing any number of boolean values
7

INHERITS FROM

9       SoField > SoMField > SoMFBool
10

SYNOPSIS

12       #include <Inventor/fields/SoMFBool.h>
13
14          Methods from class SoMFBool:
15
16     static SoType       getClassTypeId()
17     virtual void        getTypeId() const
18     SbBool              operator [](int i) const
19     const SbBool *      getValues(int start) const
20     int                 find(SbBool   targetValue,   SbBool  addIfNotFound  =
21                              FALSE)
22     void                setValues(int start, int num, const  SbBool  *newVal‐
23                              ues)
24     void                set1Value(int index, SbBool newValue)
25     SbBool              operator =(SbBool newValue)
26     void                setValue(SbBool newValue)
27     int                 operator ==(const SoMFBool &f) const
28     int                 operator !=(const SoMFBool &f) const
29     SbBool *            startEditing()
30     void                finishEditing()
31
32          Methods from class SoMField:
33
34     int                 getNum() const
35     void                setNum(int num)
36     virtual void        deleteValues(int start, int num = -1)
37     virtual void        insertSpace(int start, int num)
38     SbBool              set1(int index, const char *valueString)
39     void                get1(int index, SbString &valueString)
40
41          Methods from class SoField:
42
43     void                setIgnored(SbBool ignore)
44     SbBool              isIgnored() const
45     SbBool              isDefault() const
46     virtual SbBool      isOfType(SoType type) const
47     SbBool              set(const char *valueString)
48     void                get(SbString &valueString)
49     void                touch()
50     SbBool              connectFrom(SoField *fromField)
51     SbBool              connectFrom(SoEngineOutput *fromEngine)
52     void                disconnect()
53     SbBool              isConnected() const
54     SbBool              isConnectedFromField() const
55     SbBool              getConnectedField(SoField *&writingField) const
56     SbBool              isConnectedFromEngine() const
57     SbBool              getConnectedEngine(SoEngineOutput     *&engineOutput)
58                              const
59     void                enableConnection(SbBool flag)
60     SbBool              isConnectionEnabled() const
61     int                 getForwardConnections(SoFieldList &list) const
62     SoFieldContainer *  getContainer() const
63
64

DESCRIPTION

66       A multiple-value field that contains any number of boolean values.
67
68       SoMFBools are written to file as one or more boolean values, which  are
69       written as "0" (representing a false value), "1", "TRUE", or "FALSE".
70
71       When  more than one value is present, all of the values are enclosed in
72       square brackets and separated by commas; for example:
73
74          [ 0, FALSE, 1, TRUE ]
75
76
77

METHODS

79     static SoType       getClassTypeId()
80     virtual void        getTypeId() const
81          Returns the type for this class  or  a  particular  object  of  this
82          class.
83
84     SbBool              operator [](int i) const
85          Returns  the  i'th  value of the field. Indexing past the end of the
86          field (passing in i greater than getNum()) will return garbage.
87
88     const SbBool *      getValues(int start) const
89          Returns a pointer into the array of values in the field, starting at
90          index  start.  The values are read-only; see the startEditing()/fin‐
91          ishEditing() methods for a way of modifying values in place.
92
93     int                 find(SbBool  targetValue,  SbBool   addIfNotFound   =
94                              FALSE)
95          Finds  the  given  value  in the array and returns the index of that
96          value in the array. If the value is not found, -1  is  returned.  If
97          addIfNotFound  is  set,  then targetValue is added to the end of the
98          array (but -1 is still returned).
99
100     void                setValues(int start, int num, const  SbBool  *newVal‐
101                              ues)
102          Sets  num values starting at index start to the values in newValues.
103          The array will be automatically be made larger to accomodate the new
104          values, if necessary.
105
106     void                set1Value(int index, SbBool newValue)
107          Sets  the index'th value in the array to newValue. The array will be
108          automatically expanded, if necessary.
109
110     SbBool              operator =(SbBool newValue)
111     void                setValue(SbBool newValue)
112          Sets the first value in the array to newValue, and deletes the  sec‐
113          ond and subsequent values.
114
115     int                 operator ==(const SoMFBool &f) const
116     int                 operator !=(const SoMFBool &f) const
117          Returns TRUE if all of the values of this field equal (do not equal)
118          those of the given field. If the fields are  different  types  FALSE
119          will  always be returned (even if one field is an SoMFFloat with one
120          value of 1.0 and the other is an SoMFInt with  a  value  of  1,  for
121          example).
122
123     SbBool *            startEditing()
124     void                finishEditing()
125          startEditing()  returns a pointer to the internally-maintained array
126          that can be modified. The values in the array may  be  changed,  but
127          values  cannot  be added or removed. It is illegal to call any other
128          editing methods between  startEditing()  and  finishEditing()  (e.g.
129          set1Value(), setValue(), etc).
130
131          Fields,  engines  or sensors connected to this field and sensors are
132          not notified that this field has changed  until  finishEditing()  is
133          called.  Calling finishEditing() always sets the isDefault() flag to
134          FALSE and informs engines and sensors that the field  changed,  even
135          if none of the values actually were changed.
136
137
138
139
140                                                               SoMFBool(3IV)()
Impressum