org.web3d.vrml.nodes
Interface VRMLPointingDeviceSensorNodeType

All Superinterfaces:

FrameStateListener, VRMLChildNodeType, VRMLNode, VRMLNodeType, VRMLSensorNodeType, VRMLWorldRootChildNodeType

All Known Subinterfaces:

VRMLDragSensorNodeType, VRMLTouchSensorNodeType

All Known Implementing Classes:

BaseDragSensorNode

public interface VRMLPointingDeviceSensorNodeType
extends VRMLSensorNodeType

A sensor driven by a pointing device.

Version:

$Revision: 1.11 $

Author:

Alan Hudson

Method Summary

java.lang.String	getDescription() Get the current state of the description field.
boolean	getIsOver() Get the current value of the isOver field.
boolean	requiresPointOnly() Flag to notify the user whether the node implementation only needs the hit point information, or it needs everything else as well.
void	setDescription(java.lang.String desc) Set a new value for the description field.
void	setIsOver(boolean newIsOver) Set the flag describing whether the pointing device is over this sensor.

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

getEnabled, getIsActive, setEnabled

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

requiresPointOnly

boolean requiresPointOnly()

Flag to notify the user whether the node implementation only needs the hit point information, or it needs everything else as well. This is an optimisation method that allows the internals of the event model to avoid doing unnecessary work. If the return value is true, then the hitNormal and hitTexCoord parameter values will not be supplied (they'll be null references).

Returns:

true if the node implementation only requires hitPoint information

setDescription

void setDescription(java.lang.String desc)

Set a new value for the description field.

Parameters:

desc - The new value for the description field

getDescription

java.lang.String getDescription()

Get the current state of the description field.

Returns:

The current value of description

setIsOver

void setIsOver(boolean newIsOver)

Set the flag describing whether the pointing device is over this sensor. The result should be that isOver SFBool output only field is set appropriately at the node level.

Parameters:

newIsOver - The new value for isOver

getIsOver

boolean getIsOver()

Get the current value of the isOver field.

Returns:

The current value of isOver