org.web3d.vrml.nodes
Interface VRMLPickableNodeType

All Superinterfaces:

FrameStateListener, VRMLNode, VRMLNodeType

public interface VRMLPickableNodeType
extends VRMLNodeType

Marker interface to indicate nodes of the X3DPickableObject type.

The X3DPickableObject is an Xj3D extension node, and it's defined in the specification at http://www.xj3d.org/extensions/picking.html

Version:

$Revision: 1.2 $

Author:

Justin COuch

Method Summary

void	getObjectType(java.lang.String[] val) Fetch the number of object type values in use currently.
boolean	getPickable() Get the current pickable state of the object.
int	numObjectType() Get the current number of valid object type strings.
void	setObjectType(java.lang.String[] types, int numValid) Set the list of picking targets that this object corresponds to.
void	setPickable(boolean state) Set the pickable state of this object.

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

setObjectType

void setObjectType(java.lang.String[] types,
                   int numValid)

Set the list of picking targets that this object corresponds to. These can be an array of strings.

Parameters:

types - The list of object type strings to use

numValid - The number of valid values to read from the array

numObjectType

int numObjectType()

Get the current number of valid object type strings.

Returns:

a number >= 0

getObjectType

void getObjectType(java.lang.String[] val)

Fetch the number of object type values in use currently.

Parameters:

val - An array to copy the values to

setPickable

void setPickable(boolean state)

Set the pickable state of this object. True to allow it and it's children to participate in picking, false to remove it.

Parameters:

state - true to enable picking, false otherwise

getPickable

boolean getPickable()

Get the current pickable state of the object.

Returns:

true if picking is allowed, false otherwise