Package com.openinventor.inventor.fields

Class SoMFVec2s

  • public class SoMFVec2s
extends SoMField
    Multiple-value field containing any number of two-dimensional vectors. A multiple-value field that contains any number of two-dimensional vectors.

    SoMFVec2ss are written to file as one or more pairs of short values separated by whitespace. When more than one value is present, all of the values are enclosed in square brackets and separated by commas; for example: 

       [ 0 0, 1 3, 100 17 ]

    Data copying:

    SoMF fields are a kind of "smart container", automatically expanding as necessary to hold the data provided by the application. This is very convenient, but for large blocks of data it may be desireable to avoid making a copy of the application data. The setValuesBuffer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied. Please see SoMFVec3f for more information and example code.

    • Method Detail

      • setValues

        public void setValues​(int start,
                      int num,
                      short[] xy)
        Deprecated.
        As of Open Inventor 9.3.1, use setValues(int, short[]) instead.
        Sets values from array of arrays of 2 shorts.

      • find

        public int find​(SbVec2s targetValue)
        Calls find(targetValue, false).

      • getDirectValues

        public java.nio.ShortBuffer getDirectValues​(int start)
        Returns a pointer into the array of values in the field, starting at index start. The values are read-only. See the startEditing()/finishEditing() methods for a way of modifying values in place.

      • getValueAt

        public SbVec2s getValueAt​(int i)

      • getValues

        public SbVec2s[] getValues​(int start)
        Returns a pointer into the array of values in the field, starting at index start. The values are read-only. See the startEditing()/finishEditing() methods for a way of modifying values in place.

      • setValues

        public void setValues​(int start,
                      SbVec2s[] newValues)
        Sets num values starting at index start to the values. in newValues. The array will automatically be made larger to accommodate the new values, if necessary. In that case, if field's values are stored in an user data array, this array is no more used.

      • find

        public int find​(SbVec2s targetValue,
                boolean addIfNotFound)
        Finds the given targetValue in the array and returns the index of that value. in the array. If the value is not found, -1 is returned. If addIfNotFound is set, then targetValue is added to the end of the array (but -1 is still returned).

      • setValue

        public void setValue​(short x,
                     short y)
        Sets to one value from 2 shorts.

      • set1Value

        public void set1Value​(int index,
                      short[] xy)
        Sets one value from 2 shorts in array.

      • finishEditing

        public void finishEditing()
        Indicates that batch edits have finished. See startEditing().

      • startEditing

        public java.nio.ShortBuffer startEditing()
        Returns a pointer to the internally maintained array that can be modified. The values in the array may be changed, but values cannot be added or removed. It is illegal to call any other editing methods between startEditing() and finishEditing() (e.g. set1Value(), setValue(), etc.). Fields, engines or sensors connected to this field and sensors are not notified that this field has changed until finishEditing() is called. Calling finishEditing() always sets the isDefault() flag to false and informs engines and sensors that the field changed, even if none of the values actually were changed.

      • set1Value

        public void set1Value​(int index,
                      SbVec2s newValue)
        Sets the index'th value in the array to newValue. The array will be automatically expanded, if necessary. In that case, if field's values are stored in an user data array, this array is no more used.

      • setValue

        public void setValue​(SbVec2f vec2f)
        Sets to one value from single precision vector.

      • setValues

        public void setValues​(int start,
                      short[] xy)
        Sets values from the specified array of shorts. The size of the array must be a multiple of 2.

      • setValuesBuffer

        public void setValuesBuffer​(java.nio.ByteBuffer userData)
        Sets the field to contain the values stored in userData. This data will not be copied into the field: it will be directly used by the field.

      • setValues

        public void setValues​(int start,
                      SbVec2f[] vec2f)
        Sets values from array of single precision vectors.

      • disableDeleteValues

        public void disableDeleteValues()
        Temporary disable value deleting.

      • setValue

        public void setValue​(short[] xy)
        Sets to one value from 2 shorts in array.

      • setValue

        public void setValue​(SbVec2s newValue)
        Sets the first value in the array to newValue, and deletes. the second and subsequent values. If field's values are stored in an user data array, this array is no more used.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class SoField

      • set1Value

        public void set1Value​(int index,
                      SbVec2f vec2f)
        Sets one value from single precision vector.

      • set1Value

        public void set1Value​(int index,
                      short x,
                      short y)
        Sets one value from 2 shorts.