com.openinventor.inventor.fields

Class SoMFNode

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoMField

com.openinventor.inventor.fields.SoMFNode

public class SoMFNode
extends SoMField

Multiple-value field containing any number of nodes. This field maintains a set of SoNode instances.

SoMFNodes are written to file as one or more nodes. When more than one value is present, all of the values are enclosed in square brackets and separated by commas; for example:

   [ Cube {} , Sphere { radius 2.0 }, USE myTranslation ]

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

Method Summary

Modifier and Type	Method and Description
void	addNode(SoNode node) Adds a node as last one in group.
void	disableDeleteValues() Temporary disable value deleting.
boolean	equals(java.lang.Object obj)
int	find(SoNode targetValue) Calls find(targetValue, false).
int	find(SoNode targetValue, boolean addIfNotFound) Finds the given targetValue in the array and returns the index of that value.
int	findNode(SoNode node) Finds index of given node within group.
SoNode	get1Value(int i) Deprecated.
SoNode	getNode(int index) Returns pointer to nth node node.
int	getNumNodes() Returns number of nodes.
SoNode	getValueAt(int i)
long	getValueSize() Get size of the value.
void	insertNode(SoNode node, int newNodeIndex) Adds a node so that it becomes the one with the given index.
void	removeAllNodes() Removes all nodes from group.
void	removeNode(int index) Removes node with given index from group.
void	removeNode(SoNode node) Removes first instance of given node from group .
void	replaceNode(int index, SoNode newNode) Replaces node with given index with new node.
void	replaceNode(SoNode oldNode, SoNode newNode) Replaces first instance of given node with new node.
void	set1Value(int index, SoNode newValue) Sets the index'th value in the array to newValue.
void	setValue(SoNode newValue) Sets the first value in the array to newValue, and deletes.
void	setValues(int start, SoNode[] 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, 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

SoMFNode

@Deprecated
public SoMFNode()

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

SoMFNode

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

Default constructor.

Method Detail

get1Value

@Deprecated
public SoNode get1Value(int i)

Deprecated.

find

public int find(SoNode targetValue)

Calls find(targetValue, false).

findNode

public int findNode(SoNode node)

Finds index of given node within group.

getValueAt

public SoNode getValueAt(int i)

setValues

public void setValues(int start,
                      SoNode[] 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.

find

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

disableDeleteValues

public void disableDeleteValues()

Temporary disable value deleting.

getNumNodes

public int getNumNodes()

Returns number of nodes.

removeNode

public void removeNode(SoNode node)

Removes first instance of given node from group .

removeNode

public void removeNode(int index)

Removes node with given index from group.

getNode

public SoNode getNode(int index)

Returns pointer to nth node node.

insertNode

public void insertNode(SoNode node,
                       int newNodeIndex)

Adds a node so that it becomes the one with the given index.

getValueSize

public long getValueSize()

Get size of the value.

Specified by:

getValueSize in class SoMField

setValue

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

addNode

public void addNode(SoNode node)

Adds a node as last one in group.

set1Value

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

removeAllNodes

public void removeAllNodes()

Removes all nodes from group.

replaceNode

public void replaceNode(SoNode oldNode,
                        SoNode newNode)

Replaces first instance of given node with new node.

replaceNode

public void replaceNode(int index,
                        SoNode newNode)

Replaces node with given index with new node.