Package com.openinventor.inventor.fields

Class SoMFPath

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoMField

com.openinventor.inventor.fields.SoMFPath

public class SoMFPath
extends SoMField

Multiple-value field containing any number of paths. This field maintains a set SoPath instances.

SoMFPaths are written to file as one or more paths (see the SoPath reference page for a description of the file format for a path). When more than one value is present, all of the values are enclosed in square brackets and separated by commas.

SoMFPaths are not able to write "per instance" information to a file for instancing nodes like SoMultipleInstance and SoMultipleCopy. The path(s) will reference the whole set of instances under the instancing node.

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	Description
SoMFPath(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	disableDeleteValues()	Temporary disable value deleting.
boolean	equals(java.lang.Object obj)
int	find(SoPath targetValue)	Calls find(targetValue, false).
int	find(SoPath targetValue, boolean addIfNotFound)	Finds the given targetValue in the array and returns the index of that value.
SoPath	getPath(int index)	Returns pointer to nth path.
SoPath	getValueAt(int i)
void	set1Value(int index, SoPath newValue)	Sets the index'th value in the array to newValue.
void	setValue(SoPath newValue)	Sets the first value in the array to newValue, and deletes.
void	setValues(int start, SoPath[] newValues)	Sets num values starting at index start to the values.

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, connectFrom, connectFrom, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getContainer, getNumConnections, getValueSize, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getNativeResourceHandle

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoMFPath

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

Default constructor.

Method Detail

find

public int find(SoPath targetValue)

Calls find(targetValue, false).

disableDeleteValues

public void disableDeleteValues()

Temporary disable value deleting.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

setValue

public void setValue(SoPath 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.

set1Value

public void set1Value(int index,
                      SoPath 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.

setValues

public void setValues(int start,
                      SoPath[] 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. In that case, if field's values are stored in an user data array, this array is no more used.

getPath

public SoPath getPath(int index)

Returns pointer to nth path.

find

public int find(SoPath 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).

getValueAt

public SoPath getValueAt(int i)