Package vrml.field

Class MFNode

java.lang.Object

vrml.Field

vrml.MField

vrml.field.MFNode

All Implemented Interfaces:

Cloneable

public class MFNode
extends MField

VRML JSAI type class containing multiple BaseNode fields

Version:

$Revision: 1.6 $

Author:

Alan Hudson, Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	ARRAY_INC	How much should we increment the array by when there is an add or insert request.
protected BaseNode[]	data	The rot values

Fields inherited from class vrml.MField

numElements

Fields inherited from class vrml.Field

valueChanged

Constructor Summary

Constructors

Constructor	Description
MFNode()	Create a new empty array with no content.
MFNode(int size, BaseNode[] values)	Create a new BaseNode array based on a selection of values
MFNode(BaseNode[] values)	Create a new BaseNode array based on all the values.

Method Summary

Modifier and Type	Method	Description
void	addValue(BaseNode node)	Add this value to the end of the list.
void	addValue(ConstSFNode node)	Add this value to the end of the list.
void	addValue(SFNode node)	Add this value to the end of the list.
void	clear()	Clear the field of all elements
Object	clone()	Make a clone of this object.
void	delete(int index)	Remove the element at the given position and shift any other items down.
BaseNode	get1Value(int index)	Get the value of the field at the given index
void	getValue(BaseNode[] values)	Copy the values from this field into the user array
void	insertValue(int index, BaseNode node)	Insert a value at the given index into the array
void	insertValue(int index, ConstSFNode node)	Insert a value at the given index into the array
void	insertValue(int index, SFNode node)	Insert a value at the given index into the array
void	set1Value(int index, BaseNode node)	Replace one value in the array with this value.
void	set1Value(int index, ConstSFNode node)	Replace one value in the array with this value.
void	set1Value(int index, SFNode node)	Replace one value in the array with this value.
void	setValue(int size, BaseNode[] values)	Replace the value of this array with a subsection of the given values.
void	setValue(BaseNode[] values)	Replace the value of this array with the given values
void	setValue(ConstMFNode value)	Set the value of this field based on the value of the given field.
void	setValue(MFNode value)	Set the value of this field based on the value of the given field.
String	toString()	Create a string representation of the field values.

Methods inherited from class vrml.MField

getSize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ARRAY_INC

protected static final int ARRAY_INC

How much should we increment the array by when there is an add or insert request. This value is array items, not elements.

See Also:

• Constant Field Values

data

protected BaseNode[] data

The rot values

Constructor Details

MFNode

public MFNode()

Create a new empty array with no content.

MFNode

public MFNode(BaseNode[] values)

Create a new BaseNode array based on all the values.

Parameters:

values - The values to copy

MFNode

public MFNode(int size,
 BaseNode[] values)

Create a new BaseNode array based on a selection of values

Parameters:

size - The number of elements to copy

values - The values to copy

Method Details

getValue

public void getValue(BaseNode[] values)

Copy the values from this field into the user array

Parameters:

values - The target array to copy into

get1Value

public BaseNode get1Value(int index)

Get the value of the field at the given index

Parameters:

index - The position to get the value from

Returns:

The value at that index

setValue

public void setValue(BaseNode[] values)

Replace the value of this array with the given values

Parameters:

values - The new values to use

setValue

public void setValue(int size,
 BaseNode[] values)

Replace the value of this array with a subsection of the given values.

Parameters:

size - The number of elements to copy

values - The new values to use

setValue

public void setValue(MFNode value)

Set the value of this field based on the value of the given field.

Parameters:

value - The field to copy data from

setValue

public void setValue(ConstMFNode value)

Set the value of this field based on the value of the given field.

Parameters:

value - The field to copy data from

set1Value

public void set1Value(int index,
 BaseNode node)

Replace one value in the array with this value.

Parameters:

index - The index to replace

node - The new value to use

set1Value

public void set1Value(int index,
 ConstSFNode node)

Replace one value in the array with this value.

Parameters:

index - The index to replace

node - The new value to use

set1Value

public void set1Value(int index,
 SFNode node)

Replace one value in the array with this value.

Parameters:

index - The index to replace

node - The new value to use

addValue

public void addValue(BaseNode node)

Add this value to the end of the list.

Parameters:

node - The new value to add

addValue

public void addValue(SFNode node)

Add this value to the end of the list.

Parameters:

node - The new value to add

addValue

public void addValue(ConstSFNode node)

Add this value to the end of the list.

Parameters:

node - The new value to add

insertValue

public void insertValue(int index,
 BaseNode node)

Insert a value at the given index into the array

Parameters:

index - The index to replace

node - The new value to insert

insertValue

public void insertValue(int index,
 ConstSFNode node)

Insert a value at the given index into the array

Parameters:

index - The index to replace

node - The new value to insert

insertValue

public void insertValue(int index,
 SFNode node)

Insert a value at the given index into the array

Parameters:

index - The index to replace

node - The new value to insert

clear

public void clear()

Clear the field of all elements

Specified by:

clear in class MField

delete

public void delete(int index)

Remove the element at the given position and shift any other items down.

Specified by:

delete in class MField

Parameters:

index - The position to delete the item at

toString

public String toString()

Create a string representation of the field values.

Overrides:

toString in class Object

Returns:

A string representing the values.

clone

public Object clone()

Make a clone of this object.

Specified by:

clone in class Field

Returns:

A copy of the field and its data