Package org.web3d.vrml.renderer.common.nodes.surface

Class BaseOverlay

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.surface.BaseOverlay

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLNodeType, VRMLOverlayNodeType, VRMLSurfaceNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NROverlay

public abstract class BaseOverlay
extends AbstractNode
implements VRMLOverlayNodeType

Common implementation of an Overlay node.

Version:

$Revision: 1.13 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BAD_NODE_MSG	Message for when the node in setValue() is not a Appearance
protected static final String	BAD_PROTO_MSG	Message for when the proto is not a Appearance
protected static final int	FIELD_LAYOUT	The field index for layout
protected static final int	FIELD_VISIBLE	The field index for visible
protected static final int	FIELD_WINDOW_SIZE_CHANGED	The field index for windowSizeChanged
protected static final int	LAST_OVERLAY_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected VRMLProtoInstance	pLayout	The proto representation of the the layout field
protected VRMLSurfaceLayoutNodeType	vfLayout	The value of the layout SFNode exposedField
protected boolean	vfVisible	exposedField SFBool visible
protected float[]	vfWindowSize	The value of the windowSizeChanged eventOut

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseOverlay()	Construct a new default Overlay object
protected	BaseOverlay(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
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.
VRMLNodeType	getLayout()	Get the current layout of this overlay node.
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.
boolean	isVisible()	Get the current visibility state of this node.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setLayout(VRMLNodeType layout)	Set the layout to the new value.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, boolean value)	Set the value of the field at the given index as a boolean.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.
void	setVisible(boolean state)	Set the visibility state of the surface.
void	surfaceSizeChanged(int width, int height)	Notification that the area allocated to the surface has changed.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

allEventsComplete

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_VISIBLE

protected static final int FIELD_VISIBLE

The field index for visible

See Also:

• Constant Field Values

FIELD_WINDOW_SIZE_CHANGED

protected static final int FIELD_WINDOW_SIZE_CHANGED

The field index for windowSizeChanged

See Also:

• Constant Field Values

FIELD_LAYOUT

protected static final int FIELD_LAYOUT

The field index for layout

See Also:

• Constant Field Values

LAST_OVERLAY_INDEX

protected static final int LAST_OVERLAY_INDEX

The last field index used by this class

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

BAD_PROTO_MSG

protected static final String BAD_PROTO_MSG

Message for when the proto is not a Appearance

See Also:

• Constant Field Values

BAD_NODE_MSG

protected static final String BAD_NODE_MSG

Message for when the node in setValue() is not a Appearance

See Also:

• Constant Field Values

vfVisible

protected boolean vfVisible

exposedField SFBool visible

vfWindowSize

protected float[] vfWindowSize

The value of the windowSizeChanged eventOut

vfLayout

protected VRMLSurfaceLayoutNodeType vfLayout

The value of the layout SFNode exposedField

pLayout

protected VRMLProtoInstance pLayout

The proto representation of the the layout field

Constructor Details

BaseOverlay

protected BaseOverlay()

Construct a new default Overlay object

BaseOverlay

protected BaseOverlay(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not the same type, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the same type

Method Details

isVisible

public boolean isVisible()

Get the current visibility state of this node.

Specified by:

isVisible in interface VRMLSurfaceNodeType

Returns:

true if the node is current visible, false otherwise

setVisible

public void setVisible(boolean state)

Set the visibility state of the surface. A non-visible surface will still take events and update, just not be rendered.

Specified by:

setVisible in interface VRMLSurfaceNodeType

Parameters:

state - true to make this node visible, false to hide

surfaceSizeChanged

public void surfaceSizeChanged(int width,
 int height)

Notification that the area allocated to the surface has changed. The new size in pixels is given.

Specified by:

surfaceSizeChanged in interface VRMLSurfaceNodeType

Parameters:

width - The width of the surface in pixels

height - The height of the surface in pixels

setLayout

public void setLayout(VRMLNodeType layout)
               throws InvalidFieldValueException

Set the layout to the new value. Setting a value of null will clear the current layout and leave nothing visible on-screen. The node provided must be either VRMLSurfaceLayoutNodeType or VRMLProtoInstance.

Specified by:

setLayout in interface VRMLOverlayNodeType

Parameters:

layout - The new layout to use

Throws:

InvalidFieldValueException - The nodes are not one of the required types.

getLayout

public VRMLNodeType getLayout()

Get the current layout of this overlay node. If none is set, null is returned. The node returned will be either VRMLSurfaceLayoutNodeType or VRMLProtoInstance.

Specified by:

getLayout in interface VRMLOverlayNodeType

Returns:

The current list of children or null

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

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Specified by:

getNodeFieldIndices in interface VRMLNode

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

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

getNumFields

public int getNumFields()

Get the number of fields.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

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

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

Overrides:

setupFinished in class AbstractNode

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

Overrides:

getFieldValue in class AbstractNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

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

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class AbstractNode

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.

setValue

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

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

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

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 know

setValue

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

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

Overrides:

setValue in class AbstractNode

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 know