org.web3d.vrml.nodes
Interface VRMLSurfaceNodeType

All Superinterfaces:

FrameStateListener, VRMLChildNodeType, VRMLNode, VRMLNodeType

All Known Subinterfaces:

VRMLOverlayNodeType

public interface VRMLSurfaceNodeType

extends VRMLChildNodeType

Representation of any node that allows the definition of a surface node type.

A surface allows the composition of one piece of content on another piece. For example it allows an application such as a text editor to be embedded into the 3D world as a texture on another object, or even as a standalone item of geometry.

Version:

$Revision: 1.3 $

Author:

Justin Couch

Method Summary

boolean	isVisible() Get the current visibility state of this surface.
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 interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, getFieldValue, getMetadataObject, getRefCount, 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

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.

Parameters:

width - The width of the surface in pixels

height - The height of the surface in pixels

isVisible

public boolean isVisible()

Get the current visibility state of this surface.

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.

Parameters:

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