1SoMFTime(3IV)()                                                SoMFTime(3IV)()
2
3
4

NAME

6       SoMFTime — multiple-value field containing any number of SbTime values
7

INHERITS FROM

9       SoField > SoMField > SoMFTime
10

SYNOPSIS

12       #include <Inventor/fields/SoMFTime.h>
13
14          Methods from class SoMFTime:
15
16     static SoType       getClassTypeId()
17     virtual void        getTypeId() const
18     const SbTime &      operator [](int i) const
19     const SbTime *      getValues(int start) const
20     int                 find(const SbTime & targetValue, SbBool addIfNotFound
21                              = FALSE)
22     void                setValues(int start, int num, const  SbTime  *newVal‐
23                              ues)
24     void                set1Value(int index, const SbTime & newValue)
25     const SbTime &      operator =(const SbTime & newValue)
26     void                setValue(const SbTime & newValue)
27     int                 operator ==(const SoMFTime &f) const
28     int                 operator !=(const SoMFTime &f) const
29     SbTime *            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 SbTime values.
67
68       SoMFTimes are written to file as one or more double-precision  floating
69       point values representing the length of time in seconds. Absolute times
70       are measured relative to 00:00:00 GMT, January 1, 1970.
71
72       When more than one value is present, all of the values are enclosed  in
73       square brackets and separated by commas; for example:
74
75          [ 1.0, 1345600.1200055, 99.8 ]
76
77
78

METHODS

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

SEE ALSO

140       SbTime
141
142
143
144
145                                                               SoMFTime(3IV)()
Impressum