org.web3d.vrml.nodes
Interface VRMLBindableNodeType

All Superinterfaces:

FrameStateListener, VRMLChildNodeType, VRMLNode, VRMLNodeType

All Known Subinterfaces:

J3DBackgroundNodeType, J3DViewpointNodeType, OGLBackgroundNodeType, OGLBindableNodeType, OGLNavigationInfoNodeType, OGLViewpointNodeType, VRMLBackgroundNodeType, VRMLNavigationInfoNodeType, VRMLViewpointNodeType

All Known Implementing Classes:

BaseBindableNode

public interface VRMLBindableNodeType

extends VRMLChildNodeType

Indicates that a node can be bound within the scenegraph to make it the active item.

These nodes obey the binding stack properties of the VRML spec. The interface does not allow for dynamic feedback of how the binding is notified to the user interface because it is assumed that the renderer implementor will have their own ideas on the best way to do this.

Version:

$Revision: 1.8 $

Author:

Justin Couch

Method Summary

void	addBindableNodeListener(VRMLBindableNodeListener l) Add a listener for activable events.
double	getBindTime() Get the time of the last bound state change.
boolean	getIsBound() Get the current isBound state of the node.
void	removeBindableNodeListener(VRMLBindableNodeListener l) Remove a listener for geometry changed events.
void	setBind(boolean enable, boolean notify, double time) Set the bind field of this node.
void	setOnStack(boolean onStack) Notify the bindable node that it is on the stack, or not on the stack, as the case may be and that it should send bind events as appropriate

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

addBindableNodeListener

public void addBindableNodeListener(VRMLBindableNodeListener l)

Add a listener for activable events. If the listener is null or already registered it will silently ignore the requests.

Parameters:

l - The listener to add

removeBindableNodeListener

public void removeBindableNodeListener(VRMLBindableNodeListener l)

Remove a listener for geometry changed events. If the listener is null or has not been registered it will silently ignore the requests.

Parameters:

l - The listener to remove

setOnStack

public void setOnStack(boolean onStack)

Notify the bindable node that it is on the stack, or not on the stack, as the case may be and that it should send bind events as appropriate

Parameters:

onStack - true if this node is now on the stack

setBind

public void setBind(boolean enable,
                    boolean notify,
                    double time)

Set the bind field of this node. This will cause the node to be moved within the stack according to the properties.

Parameters:

enable - True if this node is to be bound

notify - true if this should notify the listeners

time - The time that this was sent

getIsBound

public boolean getIsBound()

Get the current isBound state of the node.

Returns:

the current binding state

getBindTime

public double getBindTime()

Get the time of the last bound state change.

Returns:

the time value