Package com.openinventor.inventor.fields
Class SoMFInstanceParameter
java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.inventor.fields.SoField
com.openinventor.inventor.fields.SoMField
com.openinventor.inventor.fields.SoMFInstanceParameter
Multiple-value field containing any number of
SoInstanceParameter
nodes.
This field contains a set of SoInstanceParameter
instances.
An SoMFInstanceParameter
is written to file as one or more SoInstanceParameters. When more than one value is present, all of the values are enclosed in square brackets and separated by commas.
Convenience methods, for example setColors(), are provide to more easily set commonly used instance parameters.
- Since:
- Open Inventor 9.5
- See Also:
-
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
ConstructorsConstructorDescriptionSoMFInstanceParameter
(SoFieldContainer fieldContainer, String fieldName, SoField.FieldTypes fieldType) Default constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Temporary disable value deleting.boolean
int
find
(SoInstanceParameter targetValue) Calls find(targetValue, false).int
find
(SoInstanceParameter targetValue, boolean addIfNotFound) Finds the given targetValue in the array and returns the index of that value.findParameterByName
(String name) Returns the first parameter with the specified name.getValueAt
(int i) boolean
removeParameterByName
(String name) Remove the instance parameter with the specified name.void
set1Value
(int index, SoInstanceParameter newValue) Sets the index'th value in the array to newValue.void
setValue
(SoInstanceParameter newValue) Sets the first value in the array to newValue, and deletes.void
setValues
(int start, SoInstanceParameter[] newValues) Sets num values starting at index start to the values.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 Details
-
SoMFInstanceParameter
public SoMFInstanceParameter(SoFieldContainer fieldContainer, String fieldName, SoField.FieldTypes fieldType) Default constructor.
-
-
Method Details
-
find
Calls find(targetValue, false). -
getValueAt
-
disableDeleteValues
public void disableDeleteValues()Temporary disable value deleting. -
setValue
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
-
removeParameterByName
Remove the instance parameter with the specified name. Returns true if successful, false if not found. -
findParameterByName
Returns the first parameter with the specified name. Returns NULL if not found. -
find
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). -
set1Value
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
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.
-