Package com.openinventor.inventor.fields

Class SoMFUByte

  • public class SoMFUByte
extends SoMField
    Multiple-value field containing any number of uint8_t integers. A multiple-value field that contains any number of unsigned byte (8-bit) integers.

    SoMFUBytes are written to file as one or more unsigned char integers, in decimal, hexadecimal or octal format.

    When more than one value is present, all of the values are enclosed in square brackets and separated by commas; for example: 

       [ 17, 0xFF, 055 ]

    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

      • find

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

      • disableDeleteValues

        public void disableDeleteValues()
        Temporary disable value deleting.

      • getValueAt

        public byte getValueAt​(int i)

      • setValue

        public void setValue​(byte 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

      • 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.

      • set1Value

        public void set1Value​(int index,
                      byte 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.

      • getValues

        public byte[] 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.

      • find

        public int find​(byte 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).

      • setValues

        public void setValues​(int start,
                      byte[] 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.