org.web3d.vrml.nodes
Interface VRMLOverlayNodeType

All Superinterfaces:

FrameStateListener, VRMLChildNodeType, VRMLNode, VRMLNodeType, VRMLSurfaceNodeType, VRMLWorldRootChildNodeType

public interface VRMLOverlayNodeType
extends VRMLSurfaceNodeType

OverlayNodeType defines a surface that is always screen-aligned and is drawn over the top of the basic 3D scene.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Method Summary

VRMLNodeType	getLayout() Get the current layout of this overlay node.
void	setLayout(VRMLNodeType kids) Set the layout to the new value.

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

isVisible, setVisible, surfaceSizeChanged

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

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

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

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

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

allEventsComplete

Method Detail

setLayout

void setLayout(VRMLNodeType kids)
               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.

Parameters:

kids - The new layout to use

Throws:

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

getLayout

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.

Returns:

The current list of children or null