Field containing a string. More...

#include <Inventor/fields/SoSFString.h>

Inheritance diagram for SoSFString:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

const SoSFString &	operator= (const SoSFString &f)
	Copy from another field of same type.

	SoSFString ()
	Default constructor.

virtual	~SoSFString ()
	Destructor.

const SbString &	getValue () const
	Returns this field's value.

void	setValue (const SbString &newValue)
	Sets this field to newValue.

const SbString &	operator= (const SbString &newValue)
	Sets this field to newValue.

int	operator== (const SoSFString &f) const
	Returns TRUE if otherField is of the same type and has the same value as this field.

int	operator!= (const SoSFString &f) const
	Returns FALSE if otherField is of the same type and has the same value as this field.

virtual size_t	getValueSize () const
	Get size of the value.

SoNONUNICODE void	setValue (const char *string)
	Convenience method to set the field's value given a character array.

void	setValue (const SO_WCHAR_T *string)
	Convenience method to set the field's value given a character array.

Public Member Functions inherited from SoField
void	setIgnored (SbBool ig)
	Sets the ignore flag for this field.

SbBool	isIgnored () const
	Gets the ignore flag for this field.

SbBool	isDefault () const
	Gets the state of default flag of the field.

void	enableConnection (SbBool flag)
	Field connections may be enabled and disabled.

SbBool	isConnectionEnabled () const
	Returns FALSE if connections to this field are disabled.

SbBool	connectFrom (SoEngineOutput *engineOutput)
	Connects this field from an engine output.

SbBool	connectFrom (SoField *field)
	Connects this field to another field.

SbBool	connectFrom (SoVRMLInterpOutput *interpOutput)
	Connects this field from an interpOutput.

SbBool	appendConnection (SoEngineOutput *engineOutput)
	Appends this field to the list of connections from another engineOutput.

SbBool	appendConnection (SoField *field)
	Appends this field to the list of connections from another field.

SbBool	appendConnection (SoVRMLInterpOutput *interpOutput)
	Appends this field to the list of connections from another interpOutput.

void	disconnect (SoEngineOutput *engineOutput)
	Disconnect the field from the requested engineOutput.

void	disconnect (SoField *field)
	Disconnect the field from the requested field.

void	disconnect (SoVRMLInterpOutput *interpOutput)
	Disconnect the field from the requested interpOutput.

int	getNumConnections () const
	Returns the number of connections to this field.

int	getConnections (SoFieldList &list)
	Returns a list of the connections to this field.

void	disconnect ()
	Disconnect the field from whatever it was connected to.

SbBool	isConnected () const
	Returns TRUE if the field is connected to anything.

SbBool	isConnectedFromVRMLInterp () const
	Returns TRUE if the field is connected to a VRML interpOutput.

SbBool	isConnectedFromEngine () const
	Returns TRUE if the field is connected to an engine's output.

SbBool	isConnectedFromField () const
	Returns TRUE if the field is connected to another field.

SbBool	getConnectedEngine (SoEngineOutput *&engineOutput) const
	Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.

SbBool	getConnectedField (SoField *&writingField) const
	Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.

SbBool	getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
	Returns the VRMLInterpolator output field is connected to.

int	getForwardConnections (SoFieldList &list) const
	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.

SoFieldContainer *	getContainer () const
	Returns the object that contains this field.

SoNONUNICODE SbBool	set (const char *valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

SbBool	set (const SbString &valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

void	get (SbString &valueString)
	Returns the value of the field in the Open Inventor file format, even if the field has its default value.

virtual void	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.

int	operator== (const SoField &f) const
	Return TRUE if this field is of the same type and has the same value as f.

int	operator!= (const SoField &f) const
	Return FALSE if this field is of the same type and has the same value as f.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoSField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.

Static Public Member Functions inherited from SoField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

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.

String 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.

SbString includes methods for construction of Unicode strings, string operators (=, += ,== ,!=, <, >, <=, >=), as well as a query method (SbString::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_".

Constructor & Destructor Documentation

◆ SoSFString()

SoSFString::SoSFString ( )

Default constructor.

◆ ~SoSFString()

virtual SoSFString::~SoSFString ( )

virtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoSFString::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoSFString::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Reimplemented in SoSFFilePathString.

◆ getValue()

const SbString & SoSFString::getValue ( ) const

inline

Returns this field's value.

Definition at line 119 of file SoSFString.h.

◆ getValueSize()

virtual size_t SoSFString::getValueSize ( ) const

inlinevirtual

Get size of the value.

Reimplemented from SoField.

Definition at line 119 of file SoSFString.h.

◆ operator!=()

int SoSFString::operator!= ( const SoSFString & f ) const

inline

Returns FALSE if otherField is of the same type and has the same value as this field.

Definition at line 119 of file SoSFString.h.

◆ operator=() [1/2]

const SbString & SoSFString::operator= ( const SbString & newValue )

inline

Sets this field to newValue.

Definition at line 119 of file SoSFString.h.

◆ operator=() [2/2]

const SoSFString & SoSFString::operator= ( const SoSFString & f )

Copy from another field of same type.

◆ operator==()

int SoSFString::operator== ( const SoSFString & f ) const

Returns TRUE if otherField is of the same type and has the same value as this field.

◆ setValue() [1/3]

SoNONUNICODE void SoSFString::setValue ( const char * string )

Convenience method to set the field's value given a character array.

Non Unicode: This function should not be used in a Unicode application.

◆ setValue() [2/3]

void SoSFString::setValue ( const SbString & newValue )

Sets this field to newValue.

◆ setValue() [3/3]

void SoSFString::setValue ( const SO_WCHAR_T * string )

Convenience method to set the field's value given a character array.

The documentation for this class was generated from the following file:

Inventor/fields/SoSFString.h

Open Inventor Release 2024.1.3

Public Member Functions

Static Public Member Functions

Detailed Description

SEE ALSO

Constructor & Destructor Documentation

◆ SoSFString()

◆ ~SoSFString()

Member Function Documentation

◆ getClassTypeId()

◆ getTypeId()

◆ getValue()

◆ getValueSize()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ setValue() [1/3]

◆ setValue() [2/3]

◆ setValue() [3/3]