Class SoMFEnum<EnumType extends java.lang.Enum<EnumType> & IntegerValuedEnum>
- java.lang.Object
-
- com.openinventor.inventor.Inventor
-
- com.openinventor.inventor.fields.SoField
-
- com.openinventor.inventor.fields.SoMField
-
- com.openinventor.inventor.fields.SoMFEnum<EnumType>
-
- Direct Known Subclasses:
SoMFBitMask
public class SoMFEnum<EnumType extends java.lang.Enum<EnumType> & IntegerValuedEnum> extends SoMField
Multiple-value field containing any number of enumerated type values. A multiple-value field that contains any number of enumerated type values, stored as ints. Nodes that use this field class define mnemonic names for values. These names should be used when setting or testing the values of the field, even though the values are treated as integers in the methods.SoMFEnums are written to file as a set of mnemonic enumerated type names. These names differ among uses of this field in various node classes. See the reference pages for specific nodes for the names.
When more than one value is present, all of the values are enclosed in square brackets and separated by commas.
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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.openinventor.inventor.fields.SoField
SoField.FieldTypes
-
Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand
-
-
Field Summary
-
Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle
-
-
Constructor Summary
Constructors Constructor Description SoMFEnum(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType, java.lang.Class<EnumType> enumClass)
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
disableDeleteValues()
Temporary disable value deleting.boolean
equals(java.lang.Object obj)
int
find(int targetValue)
Calls find(targetValue, false).int
find(int targetValue, boolean addIfNotFound)
Finds the given targetValue in the array and returns the index of that value.void
finishEditing()
Indicates that batch edits have finished.java.nio.IntBuffer
getDirectValues(int start)
Returns a pointer into the array of values in the field, starting at index start.int
getValueAt(int i)
int[]
getValues(int start)
Returns a pointer into the array of values in the field, starting at index start.void
set1Value(int index, int newValue)
Sets the index'th value in the array to newValue.void
set1Value(int index, java.lang.String name)
Sets the index 'th value to be the integer corresponding to the mnemonic name in the given string.void
setValue(int newValue)
Sets the first value in the array to newValue, and deletes.void
setValue(java.lang.String name)
Sets this field to contain one and only one value, which is the mnemonic name as a string.void
setValues(int start, int[] newValues)
Sets num values starting at index start to the values.void
setValuesBuffer(java.nio.ByteBuffer userData)
Sets the field to contain the values stored in userData.java.nio.IntBuffer
startEditing()
Returns a pointer to the internally maintained array that can be modified.-
Methods inherited from class com.openinventor.inventor.fields.SoMField
deleteValues, deleteValues, get1, getNum, insertSpace, set1, setNum
-
Methods inherited from class com.openinventor.inventor.fields.SoField
appendConnection, appendConnection, connectFrom, connectFrom, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getContainer, getNumConnections, getValueSize, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch
-
Methods inherited from class com.openinventor.inventor.Inventor
dispose, getNativeResourceHandle
-
-
-
-
Constructor Detail
-
SoMFEnum
public SoMFEnum(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType, java.lang.Class<EnumType> enumClass)
Default constructor.
-
-
Method Detail
-
find
public int find(int targetValue)
Calls find(targetValue, false).
-
finishEditing
public void finishEditing()
Indicates that batch edits have finished. SeestartEditing()
.
-
getDirectValues
public java.nio.IntBuffer getDirectValues(int start)
Returns a pointer into the array of values in the field, starting at index start. The values are read-only. See thestartEditing()
/finishEditing() methods for a way of modifying values in place.
-
getValueAt
public int getValueAt(int i)
-
disableDeleteValues
public void disableDeleteValues()
Temporary disable value deleting.
-
startEditing
public java.nio.IntBuffer 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 betweenstartEditing()
andfinishEditing()
(e.g.set1Value()
,setValue()
, etc.). Fields, engines or sensors connected to this field and sensors are not notified that this field has changed untilfinishEditing()
is called. CallingfinishEditing()
always sets theisDefault()
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, java.lang.String name)
Sets the index 'th value to be the integer corresponding to the mnemonic name in the given string.
-
setValue
public void setValue(java.lang.String name)
Sets this field to contain one and only one value, which is the mnemonic name as a string.
-
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.
-
setValue
public void setValue(int 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.
-
find
public int find(int 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).
-
getValues
public int[] getValues(int start)
Returns a pointer into the array of values in the field, starting at index start. The values are read-only. See thestartEditing()
/finishEditing() methods for a way of modifying values in place.
-
set1Value
public void set1Value(int index, int 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.
-
setValues
public void setValues(int start, int[] 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.
-
-