1SoMFUShort(3IV)()                                            SoMFUShort(3IV)()
2
3
4

NAME

6       SoMFUShort  —  multiple-value  field  containing any number of unsigned
7       short integers
8

INHERITS FROM

10       SoField > SoMField > SoMFUShort
11

SYNOPSIS

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

DESCRIPTION

67       A multiple-value field that contains any number of unsigned short inte‐
68       gers.
69
70       SoMFUShorts are written to file as one or more unsigned  short  integer
71       values,  represented  as  decimal, hexadecimal (beginning with '0x') or
72       octal (beginning with '0') values. When more than one value is present,
73       all of the values are enclosed in square brackets and separated by com‐
74       mas; for example:
75
76          [ 7, 0xFF, 033 ]
77
78
79

METHODS

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