com.openinventor.inventor.fields

Class SoMFName

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoMField

com.openinventor.inventor.fields.SoMFName

public class SoMFName
extends SoMField

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

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

Method Summary

Modifier and Type	Method and Description
void	disableDeleteValues() Temporary disable value deleting.
boolean	equals(java.lang.Object obj)
int	find(java.lang.String targetValue) Calls find(targetValue, false).
int	find(java.lang.String targetValue, boolean addIfNotFound) Finds the given targetValue in the array and returns the index of that value.
java.lang.String	get1Value(int i) Deprecated.
java.lang.String	getValueAt(int i)
long	getValueSize() Get size of the value.
void	set1Value(int index, java.lang.String newValue) Sets the index'th value in the array to newValue.
void	setValue(java.lang.String newValue) Sets the first value in the array to newValue, and deletes.

Methods inherited from class com.openinventor.inventor.fields.SoMField

deleteValues, deleteValues, get1, getNum, insertSpace, set1, setNum

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

SoMFName

@Deprecated
public SoMFName()

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

SoMFName

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

Default constructor.

Method Detail

get1Value

@Deprecated
public java.lang.String get1Value(int i)

Deprecated.

find

public int find(java.lang.String targetValue)

Calls find(targetValue, false).

getValueAt

public java.lang.String getValueAt(int i)

disableDeleteValues

public void disableDeleteValues()

Temporary disable value deleting.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

getValueSize

public long getValueSize()

Get size of the value.

Specified by:

getValueSize in class SoMField

setValue

public void setValue(java.lang.String newValue)

Sets the first value in the array to newValue, and deletes. the second and subsequent values. If field's values are stored in an user data array, this array is no more used.

find

public int find(java.lang.String targetValue,
                boolean addIfNotFound)

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

set1Value

public void set1Value(int index,
                      java.lang.String newValue)

Sets the index'th value in the array to newValue. The array will be automatically expanded, if necessary. In that case, if field's values are stored in an user data array, this array is no more used.