Package org.web3d.vrml.nodes

Class ImportNodeProxy

java.lang.Object

org.web3d.vrml.nodes.ImportNodeProxy

All Implemented Interfaces:

Cloneable, VRMLNode, FrameStateListener, VRMLNodeListener, VRMLNodeType

public class ImportNodeProxy
extends Object
implements VRMLNodeType, VRMLNodeListener, Cloneable

A proxy node representation for allowing processing of X3D imports.

Version:

$Revision: 1.7 $

Author:

Justin Couch

Constructor Summary

Constructors

Constructor	Description
ImportNodeProxy(String importedAs, String inlineDef, String exportedAs)	Create a new instance of this node with the given node type name.

Method Summary

Modifier and Type	Method	Description
void	addNodeListener(VRMLNodeListener l)	Add a listener to this node instance.
void	allEventsComplete()	Ignored by this base implementation.
void	clearRemovedLayerIds()	Clear the current removed layer ID list.
Object	clone()	Make a cloned copy of this class.
void	fieldChanged(int index)	Notification that the field represented by the given index has changed.
String	getExportedName()	Get the name that the node was exported as from the inline.
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
String	getImportedName()	Get the import name.
String	getInlineDEFName()	Get the DEF name of the inline that this import works with.
int[]	getLayerIds()	Get a listing of the current layer IDs that are directly or indirectly referencing this node.
VRMLNodeType	getMetadataObject()	Get the currently registered metadata object instance.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
int	getPrimaryType()	Get the primary type of this node.
VRMLNodeType	getRealNode()	Fetch the real node reference.
int	getRefCount(int layer)	Ask for the current number of references to this object.
int[]	getRemovedLayerIds()	Get the list of layer IDs that this node has just been removed from.
int[]	getSecondaryType()	Get the secondary types of this node.
Object	getUserData(int index)	Fetch the stored user data for a given field index.
String	getVRMLNodeName()	Get the name of this node as a string.
boolean	hasFieldChanged(int index)	Check to see if the given field has changed since we last checked.
boolean	isDEF()	Check to see if this node has been DEFd.
boolean	isSetupFinished()	Check to see if setupFinished() has already been called on this node.
void	notifyExternProtoLoaded(int index, VRMLNodeType node)	Notify a node that an ExternProto has resolved.
void	removeNodeListener(VRMLNodeListener l)	Remove a listener from this node instance.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setDEF()	Notify this node that is has been DEFd.
void	setErrorReporter(org.j3d.util.ErrorReporter reporter)	Register an error reporter with the engine so that any errors generated by the node's internals can be reported in a nice, pretty fashion.
void	setFrameStateManager(FrameStateManager mgr)	Ignored by this implementation.
void	setMetadataObject(VRMLNodeType data)	Set the X3DMetadataObject that is associated with this node.
void	setRealNode(VRMLNodeType node)	Set the real node that this proxy is representing.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setUserData(int index, Object data)	Set arbitrary data for a given field.
void	setValue(int index, boolean value)	Set the value of the field at the given index as an boolean.
void	setValue(int index, boolean[] value, int numValid)	Set the value of the field at the given index as an array of boolean.
void	setValue(int index, double value)	Set the value of the field at the given index as an double.
void	setValue(int index, double[] value, int numValid)	Set the value of the field at the given index as an array of doubles.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.
void	setValue(int index, int value)	Set the value of the field at the given index as an integer.
void	setValue(int index, int[] value, int numValid)	Set the value of the field at the given index as an array of integers.
void	setValue(int index, long value)	Set the value of the field at the given index as an long.
void	setValue(int index, long[] value, int numValid)	Set the value of the field at the given index as an array of longs.
void	setValue(int index, String value)	Set the value of the field at the given index as a string.
void	setValue(int index, String[] value, int numValid)	Set the value of the field at the given index as an array of strings.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.
void	setValue(int index, VRMLNodeType[] children, int numValid)	Set the value of the field at the given index as an array of nodes.
void	setVersion(int major, int minor, boolean isStatic)	Set the version of VRML that this node should represent.
void	updateRefCount(int layer, boolean add)	Change the reference count up or down by one.

Methods inherited from class java.lang.Object

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

Constructor Details

ImportNodeProxy

public ImportNodeProxy(String importedAs,
 String inlineDef,
 String exportedAs)

Create a new instance of this node with the given node type name. inSetup will be set to true and isDEF set to false.

Parameters:

importedAs - The name from the import statement

inlineDef - The DEF name of the inline this import refers to

exportedAs - The name the node was exported from the Inline as

Method Details

allEventsComplete

public void allEventsComplete()

Ignored by this base implementation. Any class that needs this method may override this method as required.

Specified by:

allEventsComplete in interface FrameStateListener

setErrorReporter

public void setErrorReporter(org.j3d.util.ErrorReporter reporter)

Register an error reporter with the engine so that any errors generated by the node's internals can be reported in a nice, pretty fashion. Setting a value of null will clear the currently set reporter. If one is already set, the new value replaces the old.

Specified by:

setErrorReporter in interface VRMLNode

Parameters:

reporter - The instance to use or null

getVRMLNodeName

public String getVRMLNodeName()

Get the name of this node as a string.

Specified by:

getVRMLNodeName in interface VRMLNode

Returns:

The name of the node

isDEF

public boolean isDEF()

Check to see if this node has been DEFd. Returns true if it has and the user should ask for the shared representation rather than the normal one.

Specified by:

isDEF in interface VRMLNode

Returns:

true if this node has been DEFd

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

getSecondaryType

public int[] getSecondaryType()

Get the secondary types of this node. Replaces the instanceof mechanism for use in switch statements. If there are no secondary types, it will return a zero-length array.

Specified by:

getSecondaryType in interface VRMLNode

Returns:

The secondary type

setVersion

public void setVersion(int major,
 int minor,
 boolean isStatic)

Set the version of VRML that this node should represent. Different versions have different capabilities, even within the same node.

Specified by:

setVersion in interface VRMLNode

Parameters:

major - The major version number of this scene

minor - The minor version number of this scene

isStatic - true if this node is under a StaticGroup and won't change after the setup is finished

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Specified by:

getFieldDeclaration in interface VRMLNode

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Specified by:

getFieldIndex in interface VRMLNode

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getNumFields

public int getNumFields()

Get the number of fields.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Empty for the default implementation. Any derived class that has node children should override this method with real values.

Specified by:

getNodeFieldIndices in interface VRMLNode

Returns:

null

setUserData

public void setUserData(int index,
 Object data)
                 throws InvalidFieldException

Set arbitrary data for a given field. Provided primarily to help the EAI fulfill its requirements, but may be useful elsewhere.

Specified by:

setUserData in interface VRMLNode

Parameters:

index - The index of destination field to set

data - The item to store for the field

Throws:

InvalidFieldException - The field index is not known

getUserData

public Object getUserData(int index)
                   throws InvalidFieldException

Fetch the stored user data for a given field index. If nothing is registered, null is returned.

Specified by:

getUserData in interface VRMLNode

Parameters:

index - The index of destination field to set

Returns:

The item stored for the field or null

Throws:

InvalidFieldException - The field index is not known

setMetadataObject

public void setMetadataObject(VRMLNodeType data)
                       throws InvalidFieldValueException

Set the X3DMetadataObject that is associated with this node.

Specified by:

setMetadataObject in interface VRMLNodeType

Parameters:

data - The node to register as the metadata

Throws:

InvalidFieldValueException - The object instance provided does not implement VRMLMetadataNodeType or is not a proto instance that encapsulates it as it's primary type

getMetadataObject

public VRMLNodeType getMetadataObject()

Get the currently registered metadata object instance. If none is set then return null.

Specified by:

getMetadataObject in interface VRMLNodeType

Returns:

The current metadata object or null

isSetupFinished

public boolean isSetupFinished()

Check to see if setupFinished() has already been called on this node.

Specified by:

isSetupFinished in interface VRMLNodeType

Returns:

true if setupFinished() has been called

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

setDEF

public void setDEF()

Notify this node that is has been DEFd. This method shall only be called before setupFinished(). It is an error to call it any other time. It is also guaranteed that this call will be made after construction, but before any of the setValue() methods have been called.

Specified by:

setDEF in interface VRMLNodeType

Throws:

IllegalStateException - The setup is finished.

getRefCount

public int getRefCount(int layer)

Ask for the current number of references to this object. Always returns zero for the proxy.

Specified by:

getRefCount in interface VRMLNodeType

Parameters:

layer - The id of the layer to modify the ref count on

Returns:

0

updateRefCount

public void updateRefCount(int layer,
 boolean add)

Change the reference count up or down by one. Ignored for node proxies.

Specified by:

updateRefCount in interface VRMLNodeType

Parameters:

layer - The id of the layer to modify the ref count on

add - true to increment the reference count, false to decrement

getLayerIds

public int[] getLayerIds()

Get a listing of the current layer IDs that are directly or indirectly referencing this node. Always returns null for proxies.

Specified by:

getLayerIds in interface VRMLNodeType

Returns:

null

getRemovedLayerIds

public int[] getRemovedLayerIds()

Get the list of layer IDs that this node has just been removed from. If it currently has not been removed from anything, this will return null. This will remain updated until the next clearRemovedLayerIds() call.

Specified by:

getRemovedLayerIds in interface VRMLNodeType

Returns:

An array of all the IDs this is delete from or null if none

clearRemovedLayerIds

public void clearRemovedLayerIds()

Clear the current removed layer ID list. If there is nothing removed, this method does nothing.

Specified by:

clearRemovedLayerIds in interface VRMLNodeType

setFrameStateManager

public void setFrameStateManager(FrameStateManager mgr)

Ignored by this implementation.

Specified by:

setFrameStateManager in interface VRMLNodeType

Parameters:

mgr - The manager instance to use

hasFieldChanged

public boolean hasFieldChanged(int index)

Check to see if the given field has changed since we last checked. Calling this method will set the flag back to "not changed" so that two consecutive reads after a changed value would result in a true and then false being returned. If the field number is not recognized for this node then this returns false.

Specified by:

hasFieldChanged in interface VRMLNodeType

Parameters:

index - The index of the field to change.

Returns:

true if the field has changed since last read

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. Empty implementation in the base class. Derived classes will need to override this to make route management work.

Specified by:

sendRoute in interface VRMLNodeType

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

addNodeListener

public void addNodeListener(VRMLNodeListener l)

Add a listener to this node instance. If the listener is already added or null the request is silently ignored.

Specified by:

addNodeListener in interface VRMLNodeType

Parameters:

l - The listener instance to add

removeNodeListener

public void removeNodeListener(VRMLNodeListener l)

Remove a listener from this node instance. If the listener is null or not registered, the request is silently ignored.

Specified by:

removeNodeListener in interface VRMLNodeType

Parameters:

l - The listener to be removed

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

setValue

public void setValue(int index,
 int value)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an integer. This would be used to set SFInt32 field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 int[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of integers. This would be used to set MFInt32 field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 boolean value)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an boolean. This would be used to set SFBool field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 boolean[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of boolean. This would be used to set MFBool field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 float value)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of floats. This would be used to set MFFloat, SFVec2f, SFVec3f and SFRotation field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 long value)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an long. This would be used to set SFTime field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 long[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of longs. This would be used to set MFTime field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 double value)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an double. This would be used to set SFDouble field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 double[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of doubles. This would be used to set MFDouble, SFVec2d and SFVec3d field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 String value)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as a string. This would be used to set SFString field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 String[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of strings. This would be used to set MFString field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 VRMLNodeType child)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as a node. This would be used to set SFNode field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

child - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 VRMLNodeType[] children,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of nodes. This would be used to set MFNode field types.

Specified by:

setValue in interface VRMLNodeType

Parameters:

index - The index of destination field to set

children - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

notifyExternProtoLoaded

public void notifyExternProtoLoaded(int index,
 VRMLNodeType node)
                             throws InvalidFieldValueException

Description copied from interface: VRMLNodeType

Notify a node that an ExternProto has resolved. This will verify the objects type and add it to the render sceneGraph.

Specified by:

notifyExternProtoLoaded in interface VRMLNodeType

Parameters:

index - The field index

node - The node resolved

Throws:

InvalidFieldValueException - If the proto contains he wrong type

fieldChanged

public void fieldChanged(int index)

Notification that the field represented by the given index has changed. Use this to pass into the root scene a notification that it's own output has changed, as well as mark the local flag so that routing can happen.

Specified by:

fieldChanged in interface VRMLNodeListener

Parameters:

index - The index of the field that changed.

clone

public Object clone()
             throws CloneNotSupportedException

Make a cloned copy of this class. Implementation makes something between a shallow and deep copy, depending on the internal structure.

Overrides:

clone in class Object

Returns:

A cloned instance of this instance

Throws:

CloneNotSupportedException - Something lower couldn't clone

setRealNode

public void setRealNode(VRMLNodeType node)

Set the real node that this proxy is representing. At this time, do any mapping from the fields to check for validity. If the parameter value is null, clear the existing mappings. If a field has been requested due to an external ROUTE that does not exist in the real node, an error message is sent through the error reporter and that field is subsequently ignored, but the rest of the mappings continue.

Parameters:

node - The node instance to use

getRealNode

public VRMLNodeType getRealNode()

Fetch the real node reference. If one is not set, this will return null.

Returns:

A reference to the real node or null

getInlineDEFName

public String getInlineDEFName()

Get the DEF name of the inline that this import works with.

Returns:

The DEF name string

getExportedName

public String getExportedName()

Get the name that the node was exported as from the inline.

Returns:

The export name string

getImportedName

public String getImportedName()

Get the import name.

Returns:

The import name string