SoMFString Class Reference

Multiple-value field containing any number of strings. More...

#include <Inventor/fields/SoMFString.h>

Inheritance diagram for SoMFString:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
const SoMFString &	operator= (const SoMFString &f)
	Copy from another field of same type.
	SoMFString ()
	Default constructor.
virtual	~SoMFString ()
	Destructor.
SbString *	startEditing ()
	Returns a pointer to the internally maintained array that can be modified.
void	finishEditing ()
	Indicates that batch edits have finished.
const SbString &	operator[] (int i) const
	Returns the i'th value of the field.
const SbString *	getValues (int start) const
	Returns a pointer into the array of values in the field, starting at index start.
int	find (const SbString &targetValue, SbBool addIfNotFound=FALSE)
	Finds the given targetValue in the array and returns the index of that value.
void	setValues (int start, int num, const SbString *newValues)
	Sets num values starting at index start to the values.
void	set1Value (int index, const SbString &newValue)
	Sets the index'th value in the array to newValue.
void	setValue (const SbString &newValue)
	Sets the first value in the array to newValue, and deletes.
const SbString &	operator= (const SbString &newValue)
	Sets the first value in the array to newValue, and deletes.
int	operator== (const SoMFString &f) const
	Returns TRUE if all of the values of this field equal those of.
int	operator!= (const SoMFString &f) const
	Returns TRUE if all of the values of this field do not equal.
virtual void	enableDeleteValues ()
	Sets the enableDeleteValues flag.
virtual void	disableDeleteValues ()
	Temporary disable value deleting.
virtual SbBool	isDeleteValuesEnabled ()
	Returns FALSE if user data array has been given to
virtual size_t	getValueSize () const
	Get size of the value.
void	setValuesPointer (int num, const SbString *userData)
	Sets the field to contain the num values stored in userData array.
void	setValuesPointer (int num, SbString *userData)
	See setValuesPointer(int, const SbString *)
SoNONUNICODE void	setValues (int start, int num, const char *strings[])
	Sets num values, starting at index start , to the strings in the given character arrays.
SoNONUNICODE void	setValue (const char *string)
	Deletes all values currently in this field and sets this field to contain only the given string.
void	setValues (int start, int num, const SO_WCHAR_T *strings[])
	Sets num values, starting at index start , to the strings in the given character arrays.
void	setValue (const SO_WCHAR_T *string)
	Deletes all values currently in this field and sets this field to contain only the given string.
void	deleteText (int fromLine, int fromChar, int toLine, int toChar)
	Convenience function to delete text from consecutive strings.
Public Member Functions inherited from SoMField
int	getNum () const
	Returns the number of values currently in the field.
void	setNum (int num)
	Forces this field to have exactly num values, inserting or deleting values as necessary.
virtual void	deleteValues (int start, int num=-1)
	Deletes num values beginning at index start (index start through start + num -1 will be deleted, and any leftover values will be moved down to fill in the gap created).
virtual void	insertSpace (int start, int num)
	Inserts space for num values at index start .
SoNONUNICODE SbBool	set1 (int index, const char *valueString)
	This is equivalent to the set() method of SoField, but operates on only one value.
SbBool	set1 (int index, const SbString &valueString)
	This is equivalent to the set() method of SoField, but operates on only one value.
void	get1 (int index, SbString &valueString)
	This is equivalent to the get() method of SoField, but operates on only one value.
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 SoMField
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

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.

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

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 setValuesPointer() 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.

Definition at line 116 of file SoMFString.h.

Constructor & Destructor Documentation

SoMFString()

SoMFString::SoMFString

(

)

Default constructor.

~SoMFString()

virtual SoMFString::~SoMFString ( )

virtual

Destructor.

Member Function Documentation

deleteText()

void SoMFString::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.

disableDeleteValues()

virtual void SoMFString::disableDeleteValues ( )

inlinevirtual

Temporary disable value deleting.

Definition at line 119 of file SoMFString.h.

enableDeleteValues()

virtual void SoMFString::enableDeleteValues ( )

inlinevirtual

Sets the enableDeleteValues flag.

This flag (if TRUE) allows Open Inventor to destroy the user data array given to setValuesPointer(). This user data array will be managed exactly like internal field data values. Default is FALSE.

Definition at line 119 of file SoMFString.h.

find()

int SoMFString::find	(	const SbString &	targetValue,
		SbBool	addIfNotFound = FALSE
	)

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

finishEditing()

void SoMFString::finishEditing ( )

inline

Indicates that batch edits have finished.

See startEditing().

Definition at line 119 of file SoMFString.h.

getClassTypeId()

static SoType SoMFString::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoMFString::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Reimplemented in SoMFFilePathString.

getValues()

const SbString * SoMFString::getValues ( int  start ) const

inline

Returns a pointer into the array of values in the field, starting at index start.

The values are read-only. See the startEditing()/finishEditing() methods for a way of modifying values in place.

Definition at line 119 of file SoMFString.h.

getValueSize()

virtual size_t SoMFString::getValueSize ( ) const

inlinevirtual

Get size of the value.

Reimplemented from SoField.

Definition at line 119 of file SoMFString.h.

isDeleteValuesEnabled()

virtual SbBool SoMFString::isDeleteValuesEnabled ( )

inlinevirtual

Returns FALSE if user data array has been given to

setValuesPointer() and enableDeleteValues() has never been called, and memory for data has not been reallocated. Otherwise, returns TRUE.

Definition at line 119 of file SoMFString.h.

operator!=()

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

inline

Returns TRUE if all of the values of this field do not equal.

those of the given f. If the fields are different types TRUE will always be returned.

Definition at line 119 of file SoMFString.h.

operator=() [1/2]

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

inline

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

Definition at line 119 of file SoMFString.h.

operator=() [2/2]

const SoMFString & SoMFString::operator=

(

const SoMFString &

f

)

Copy from another field of same type.

operator==()

int SoMFString::operator==

(

const SoMFString &

f

)

const

Returns TRUE if all of the values of this field equal those of.

the given f. If the fields are different types FALSE will always be returned.

operator[]()

const SbString & SoMFString::operator[] ( int  i ) const

inline

Returns the i'th value of the field.

Indexing past the end of the field (passing in i greater than getNum()) will return garbage.

Definition at line 119 of file SoMFString.h.

set1Value()

void SoMFString::set1Value	(	int	index,
		const SbString &	newValue
	)

Sets the index'th value in the array to newValue.

The array will be automatically expanded, if necessary.

setValue() [1/3]

SoNONUNICODE void SoMFString::setValue

(

const char *

string

)

Deletes all values currently in this field and sets this field to contain only the given string.

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

setValue() [2/3]

void SoMFString::setValue

(

const SbString &

newValue

)

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

setValue() [3/3]

void SoMFString::setValue

(

const SO_WCHAR_T *

string

)

Deletes all values currently in this field and sets this field to contain only the given string.

setValues() [1/3]

SoNONUNICODE void SoMFString::setValues	(	int	start,
		int	num,
		const char *	strings[]
	)

Sets num values, starting at index start , to the strings in the given character arrays.

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

setValues() [2/3]

void SoMFString::setValues	(	int	start,
		int	num,
		const SbString *	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.

setValues() [3/3]

void SoMFString::setValues	(	int	start,
		int	num,
		const SO_WCHAR_T *	strings[]
	)

Sets num values, starting at index start , to the strings in the given character arrays.

setValuesPointer() [1/2]

void SoMFString::setValuesPointer	(	int	num,
		const SbString *	userData
	)

Sets the field to contain the num values stored in userData array.

This array will not be copied into the field: it will be directly used by the field. If num and userData are not correctly specified, the results are undefined (and probably undesirable). param num is the number of values that userData contains and must be a positive integer. param userData is an array allocated by malloc or realloc and can be deallocated by free (no constructor or destructor is called). userData must not be NULL. Its size must be at least num*sizeof(valueType).

setValuesPointer() [2/2]

void SoMFString::setValuesPointer	(	int	num,
		SbString *	userData
	)

See setValuesPointer(int, const SbString *)

startEditing()

SbString * SoMFString::startEditing ( )

inline

Returns a pointer to the internally maintained array that can be modified.

The values in the array may be changed, but values cannot be added or removed. It is illegal to call any other editing methods between startEditing() and finishEditing() (e.g. set1Value(), setValue(), etc.). Fields, engines or sensors connected to this field and sensors are not notified that this field has changed until finishEditing() is called. Calling finishEditing() always sets the isDefault() flag to FALSE and informs engines and sensors that the field changed, even if none of the values actually were changed.

Definition at line 119 of file SoMFString.h.

---

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

• Inventor/fields/SoMFString.h