com.openinventor.inventor.fields

Class SoSFString

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoSField

com.openinventor.inventor.fields.SoSFString

Direct Known Subclasses:

SoSFFilePathString

public class SoSFString
extends SoSField

Field containing a string. A field containing an string (sequence of characters).

SoSFStrings are written to file as a sequence of ASCII characters in double quotes (optional if the string doesn't contain any whitespace). 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:

   Testing
   "One, Two, Three"
   "He said, \"Immel did it!\""

are all valid strings.

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.

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_".

See also:

SoField, SoSField, SoMFString

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getValue() Returns this field's value.
long	getValueSize() Get size of the value.
void	setValue(java.lang.String newValue) Sets this field to newValue.

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

SoSFString

@Deprecated
public SoSFString()

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

SoSFString

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

Default constructor.

Method Detail

getValueSize

public long getValueSize()

Get size of the value.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

setValue

public void setValue(java.lang.String newValue)

Sets this field to newValue.

getValue

public java.lang.String getValue()

Returns this field's value.