SoMFName Class Reference
[Fields]

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

#include <Inventor/fields/SoMFName.h>

Inheritance diagram for SoMFName:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
const SoMFName &	operator= (const SoMFName &f)
	SoMFName ()
virtual	~SoMFName ()
SbName *	startEditing ()
void	finishEditing ()
const SbName &	operator[] (int i) const
const SbName *	getValues (int start) const
int	find (const SbName &targetValue, SbBool addIfNotFound=FALSE)
void	setValues (int start, int num, const SbName *newValues)
void	set1Value (int index, const SbName &newValue)
void	setValue (const SbName &newValue)
const SbName &	operator= (const SbName &newValue)
int	operator== (const SoMFName &f) const
int	operator!= (const SoMFName &f) const
virtual void	enableDeleteValues ()
virtual void	disableDeleteValues ()
virtual SbBool	isDeleteValuesEnabled ()
virtual size_t	getValueSize () const
void	setValuesPointer (int num, const SbName *userData)
void	setValuesPointer (int num, SbName *userData)
void	setValues (int start, int num, const char *strings[])
void	setValue (const char *string)
Static Public Member Functions
static SoType	getClassTypeId ()

---

Detailed Description

Multiple-value field containing any number of names.

A multiple-valued field containing any number of names. Names are short series of characters generally used for labels or names, and are stored in a special table designed to allow fast lookup and comparison. For most purposes, an SoMFString field is probably more appropriate.

SoMFNames are written to file as one or more strings of characters. Names must begin with an underscore or alphabetic character, and must consist entirely of underscores, alphabetic characters, or numbers. When more than one value is present, all of the values are enclosed in square brackets and separated by commas; for example:

      [ Fred, Wilma, _Part_01, translationField ]
     

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.

---

Constructor & Destructor Documentation

SoMFName::SoMFName

(

)

Default constructor.

virtual SoMFName::~SoMFName

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void SoMFName::disableDeleteValues

(

)

[inline, virtual]

Temporary disable value deleting.

virtual void SoMFName::enableDeleteValues

(

)

[inline, virtual]

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.

int SoMFName::find	(	const SbName &	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).

void SoMFName::finishEditing

(

)

[inline]

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFName::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoMField.

virtual SoType SoMFName::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SbName* SoMFName::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.

virtual size_t SoMFName::getValueSize

(

)

const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

virtual SbBool SoMFName::isDeleteValuesEnabled

(

)

[inline, virtual]

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.

int SoMFName::operator!=

(

const SoMFName &

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.

Reimplemented from SoField.

const SbName& SoMFName::operator=

(

const SbName &

newValue

)

[inline]

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

the second and subsequent values.

const SoMFName& SoMFName::operator=

(

const SoMFName &

f

)

Copy from another field of same type.

int SoMFName::operator==

(

const SoMFName &

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.

Reimplemented from SoField.

const SbName& SoMFName::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.

void SoMFName::set1Value	(	int	index,
		const SbName &	newValue
	)

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

The array will be automatically expanded, if necessary.

void SoMFName::setValue

(

const char *

string

)

Sets this field to contain one and only one value, given by string .

void SoMFName::setValue

(

const SbName &

newValue

)

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

the second and subsequent values.

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

Sets num values beginning at index start to the names contained in the given set of character strings.

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

void SoMFName::setValuesPointer	(	int	num,
		SbName *	userData
	)

See setValuesPointer(int, const SbName *).

void SoMFName::setValuesPointer	(	int	num,
		const SbName *	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).

SbName* SoMFName::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.

---

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

• Inventor/fields/SoMFName.h