com.openinventor.inventor.fields

Class SoMFString

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoMField

com.openinventor.inventor.fields.SoMFString

Direct Known Subclasses:

SoMFFilePathString

public class SoMFString
extends SoMField

Multiple-value field containing any number of strings. A multiple-value field that contains any number of strings.

SoMFStrings are written to file as one or more strings within double quotes. Any characters (including newlines) may appear within the quotes. To include a double quote character within the string, precede it with a backslash. For example:

   [ cowEnizer , "Scene Boy" , "He said, \"I did not!\"" ]

Unicode Support

Unicode is an industry standard for encoding text of all forms and languages for use by computers. Open Inventor supports Unicode encoding, which allows internationalization of text in a standard cross-platform fashion.

String and as well as classes like SoSFString support the wchar_t type which is used for Unicode strings, and all of the text nodes are able to render Unicode strings.

String includes methods for construction of Unicode strings, string operators (=, += ,== ,!=, <, >, <=, >=), as well as a query method (String.isUnicode()).

To be able to display a particular Unicode character, the selected font must have a character for that Unicode value. Many fonts do not contain a complete set of Unicode characters. However, the shareware Unicode font file "Code2000" seems to work well.

Note that Unicode characters are not directly supported in Open Inventor files. Unicode strings are written as if the bytes in the string were a string of 8-bit characters. The string will be prefixed by "MCS_U_".

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 and Description
SoMFString() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoMFString(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	deleteText(int fromLine, int fromChar, int toLine, int toChar) Convenience function to delete text from consecutive strings.
void	disableDeleteValues() Temporary disable value deleting.
boolean	equals(java.lang.Object obj)
int	find(java.lang.String targetValue) Calls find(targetValue, false).
int	find(java.lang.String targetValue, boolean addIfNotFound) Finds the given targetValue in the array and returns the index of that value.
java.lang.String	get1Value(int i) Deprecated.
java.lang.String	getValueAt(int i)
long	getValueSize() Get size of the value.
void	set1Value(int index, java.lang.String newValue) Sets the index'th value in the array to newValue.
void	setValue(java.lang.String newValue) Sets the first value in the array to newValue, and deletes.
void	setValues(int start, java.lang.String[] 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, appendConnection, connectFrom, connectFrom, connectFrom, disconnect, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getConnectedVRMLInterp, getContainer, getNumConnections, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoMFString

@Deprecated
public SoMFString()

Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.

SoMFString

public SoMFString(SoFieldContainer fieldContainer,
                  java.lang.String fieldName,
                  SoField.FieldTypes fieldType)

Default constructor.

Method Detail

find

public int find(java.lang.String targetValue)

Calls find(targetValue, false).

get1Value

@Deprecated
public java.lang.String get1Value(int i)

Deprecated.

getValueSize

public long getValueSize()

Get size of the value.

Specified by:

getValueSize in class SoMField

deleteText

public void deleteText(int fromLine,
                       int fromChar,
                       int toLine,
                       int toChar)

Convenience function to delete text from consecutive strings. All text from the given character of one line (fromChar in fromLine) to the given character of another line (toChar in toLine), inclusive, is deleted. Any leftover text on fromLine and toLine is merged into one line.

set1Value

public void set1Value(int index,
                      java.lang.String 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(java.lang.String 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.

disableDeleteValues

public void disableDeleteValues()

Temporary disable value deleting.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

setValues

public void setValues(int start,
                      java.lang.String[] 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.

getValueAt

public java.lang.String getValueAt(int i)

find

public int find(java.lang.String 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).