| SoSFString Class |
Field containing a string.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.FieldsSoField
OIV.Inventor.FieldsSoSField
OIV.Inventor.FieldsSoSFString
OIV.Inventor.FieldsSoSFFilePathString
Namespace: OIV.Inventor.Fields
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.2.0 (10.16.2.0)
SyntaxThe SoSFString type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoSFString | Default constructor. |
Methods| Name | Description | |
|---|---|---|
| AppendConnection(SoEngineOutput) | Appends this field to the list of connections from another engineOutput. |
| AppendConnection(SoField) | Appends this field to the list of connections from another field. |
| ConnectFrom(SoEngineOutput) | Connects this field from an engine output. |
| ConnectFrom(SoField) | Connects this field to another field. |
| CopyFrom | Copy from another field of same type. |
| Disconnect | Disconnect the field from whatever it was connected to. |
| Disconnect(SoEngineOutput) | Disconnect the field from the requested engineOutput. |
| Disconnect(SoField) | Disconnect the field from the requested field. |
| EnableConnection | Field connections may be enabled and disabled. |
| Equals | (Overrides SoFieldEquals(Object).) |
| Get | Returns the value of the field in the Open Inventor file format, even if the field has its default value. |
| GetConnectedEngine | Returns true if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput. |
| GetConnectedField | Returns true if this field is being written into by another field, and returns the field it is connected to in writingField. |
| GetConnections | Returns a list of the connections to this field. |
| GetContainer | Returns the object that contains this field. |
| GetForwardConnections | Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetNumConnections | Returns the number of connections to this field. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue | Obsolete. Returns this field's value. |
| GetValueSize | Gets the size of the value. |
| IsConnected | Returns true if the field is connected to anything. |
| IsConnectedFromEngine | Returns true if the field is connected to an engine's output. |
| IsConnectedFromField | Returns true if the field is connected to another field. |
| IsConnectedFromVRMLInterp | Returns true if the field is connected to a VRML interpOutput. |
| IsConnectionEnabled | Returns false if connections to this field are disabled. |
| IsDefault | Gets the state of default flag of the field. |
| IsIgnored | Gets the ignore flag for this field. |
| Set | Sets the field to the given value, which is an ASCII string in the Open Inventor file format. |
| SetIgnored | Sets the ignore flag for this field. |
| SetValue | Obsolete. Sets this field to newValue. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Touch | Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth. |
Operators| Name | Description | |
|---|---|---|
  | Equality | |
| Inequality |
Properties
RemarksA 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