Package org.web3d.vrml.renderer.common.nodes.picking

Class BasePickingNode

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.BaseSensorNode

org.web3d.vrml.renderer.common.nodes.picking.BasePickingNode

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLNodeType, VRMLPickingSensorNodeType, VRMLSensorNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

BaseLinePickSensor, BasePointPickSensor, BasePrimitivePickSensor, BaseVolumePickSensor

public abstract class BasePickingNode
extends BaseSensorNode
implements VRMLPickingSensorNodeType

Implementation of the abstract X3DPickingNode type.

Version:

$Revision: 1.15 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_INTERSECTION_TYPE	The field index for hitTexCoord_Changed
protected static final int	FIELD_OBJECT_TYPE	Index of the objectType field
protected static final int	FIELD_PICK_TARGET	The field index for hitPoint_Changed
protected static final int	FIELD_PICKED_GEOMETRY	The field index for pickedGeometry
protected static final int	FIELD_PICKING_GEOMETRY	The field index for pickingGeometry
protected static final int	FIELD_SORT_ORDER	The field index for isOver
protected static final String	GEOMETRY_NODE_MSG	Message for when the node in setValue() is not a Geometry
protected static final String	GEOMETRY_PROTO_MSG	Message for when the proto is not a Geometry
protected int	intersectionType	Constant representing the intersection type
protected static final Map<String,Integer>	intersectTypeMap	Map containing the string to constant mapping for intersection type
protected static final int	LAST_PICK_INDEX	Last index used by this base node
protected int	numPickedGeometry	Number of valid items in the pickedGeometry array
protected int	numPickTarget	Number of valid items in the vfPickTarget array
protected VRMLProtoInstance	pPickingGeometry	The proto version of the picking geometry
protected int	sortType	Constant representing the sort type
protected static final Map<String,Integer>	sortTypeMap	Map containing the string to constant mapping for sorting
protected org.j3d.util.HashSet<String>	validGeometryNodeNames	The set of valid geometry node name types that the picking instance is allowed to use for the pick geometry.
protected String	vfIntersectionType	The value of the intersectionType field
protected String[]	vfObjectType	MFString objectType
protected VRMLNodeType[]	vfPickedGeometry	The value of the pickTarget field
protected VRMLGeometryNodeType	vfPickingGeometry	The value of the pickingGeometry field
protected VRMLNodeType[]	vfPickTarget	The value of the pickTarget field
protected String	vfSortOrder	The value of the sortOrder field

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseSensorNode

FIELD_ENABLED, FIELD_IS_ACTIVE, LAST_SENSOR_INDEX, vfEnabled, vfIsActive

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Fields inherited from interface org.web3d.vrml.nodes.VRMLPickingSensorNodeType

BOX_PICK, CONE_PICK, CYLINDER_PICK, INTERSECT_BOUNDS, INTERSECT_GEOMETRY, LINE_PICK, POINT_PICK, SORT_ALL, SORT_ALL_SORTED, SORT_ANY, SORT_CLOSEST, SPHERE_PICK, UNDEFINED_PICK, VOLUME_PICK

Constructor Summary

Constructors

Constructor	Description
BasePickingNode(String name, String errorMsg)	Construct a new generalised picking node object.

Method Summary

Modifier and Type	Method	Description
protected void	checkPickTargetType(VRMLNodeType target)	Check to make sure the picking target node being added is of the correct type.
protected void	copy(VRMLPickingSensorNodeType node)	Set the fields of the sensor node that has the fields set based on the fields of the passed in node.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int	getIntersectionType()	Get the intersection type requested for this node
void	getObjectType(String[] val)	Fetch the number of object type values in use currently.
VRMLNodeType	getPickingGeometry()	Fetch the node that is being used to pick the geometry
VRMLNodeType[]	getPickingTargets()	Get the list of nodes that are used for the target geometry.
int	getPrimaryType()	Get the primary type of this node.
int	getSortOrder()	Get the intersection type requested for this node
void	notifyPickChange(int numPicks, VRMLNode[] nodes, float[] points, float[] normals, float[] texCoords)	Notify the drag sensor that a sensor is currently dragging this device and that it's position and orientation are as given.
void	notifyPickEnd()	Notification that this sensor has finished a picking action.
void	notifyPickStart(int numPicks, VRMLNode[] nodes, float[] points, float[] normals, float[] texCoords)	Notification that this sensor has just been clicked on to start the pick action.
int	numObjectType()	Get the current number of valid object type strings.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setEnabled(boolean state)	Accessor method to set a new value for the enabled field.
void	setObjectType(String[] types, int numValid)	Set the list of picking targets that this object corresponds to.
void	setPickingGeometry(VRMLNodeType child)	Set node content as replacement for the pickingGeometry field.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, String value)	Set the value of the field at the given index as a single string.
void	setValue(int index, String[] value, int numValid)	Set the value of the field at the given index as an array of floats.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as an array of nodes.
void	setValue(int index, VRMLNodeType[] children, int numValid)	Set the value of the field at the given index as an array of nodes.
protected void	updateChildren(VRMLNodeType[] targets, int numValid)	Update the child list with the new nodes.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.BaseSensorNode

copy, getEnabled, getIsActive, setValue

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

allEventsComplete

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

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

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

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

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

getPickingType

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

getEnabled, getIsActive

Field Details

FIELD_PICKING_GEOMETRY

protected static final int FIELD_PICKING_GEOMETRY

The field index for pickingGeometry

See Also:

• Constant Field Values

FIELD_PICK_TARGET

protected static final int FIELD_PICK_TARGET

The field index for hitPoint_Changed

See Also:

• Constant Field Values

FIELD_INTERSECTION_TYPE

protected static final int FIELD_INTERSECTION_TYPE

The field index for hitTexCoord_Changed

See Also:

• Constant Field Values

FIELD_PICKED_GEOMETRY

protected static final int FIELD_PICKED_GEOMETRY

The field index for pickedGeometry

See Also:

• Constant Field Values

FIELD_SORT_ORDER

protected static final int FIELD_SORT_ORDER

The field index for isOver

See Also:

• Constant Field Values

FIELD_OBJECT_TYPE

protected static final int FIELD_OBJECT_TYPE

Index of the objectType field

See Also:

• Constant Field Values

LAST_PICK_INDEX

protected static final int LAST_PICK_INDEX

Last index used by this base node

See Also:

• Constant Field Values

GEOMETRY_PROTO_MSG

protected static final String GEOMETRY_PROTO_MSG

Message for when the proto is not a Geometry

See Also:

• Constant Field Values

GEOMETRY_NODE_MSG

protected static final String GEOMETRY_NODE_MSG

Message for when the node in setValue() is not a Geometry

See Also:

• Constant Field Values

sortTypeMap

protected static final Map<String,Integer> sortTypeMap

Map containing the string to constant mapping for sorting

intersectTypeMap

protected static final Map<String,Integer> intersectTypeMap

Map containing the string to constant mapping for intersection type

vfObjectType

protected String[] vfObjectType

MFString objectType

vfPickingGeometry

protected VRMLGeometryNodeType vfPickingGeometry

The value of the pickingGeometry field

pPickingGeometry

protected VRMLProtoInstance pPickingGeometry

The proto version of the picking geometry

vfPickTarget

protected VRMLNodeType[] vfPickTarget

The value of the pickTarget field

vfPickedGeometry

protected VRMLNodeType[] vfPickedGeometry

The value of the pickTarget field

vfIntersectionType

protected String vfIntersectionType

The value of the intersectionType field

vfSortOrder

protected String vfSortOrder

The value of the sortOrder field

intersectionType

protected int intersectionType

Constant representing the intersection type

sortType

protected int sortType

Constant representing the sort type

numPickTarget

protected int numPickTarget

Number of valid items in the vfPickTarget array

numPickedGeometry

protected int numPickedGeometry

Number of valid items in the pickedGeometry array

validGeometryNodeNames

protected org.j3d.util.HashSet<String> validGeometryNodeNames

The set of valid geometry node name types that the picking instance is allowed to use for the pick geometry. THis is sort of a bit of a kludge to deal with the multiple renderer thing. However, when we do get a proto instance, we first walk down the stack looking for the implementation node to make sure it satisfies one of these names too.

Constructor Details

BasePickingNode

public BasePickingNode(String name,
 String errorMsg)

Construct a new generalised picking node object.

Parameters:

name - The VRML name of this node

errorMsg - Error message to use for the wrong geometry pick type

Method Details

copy

protected void copy(VRMLPickingSensorNodeType node)

Set the fields of the sensor node that has the fields set based on the fields of the passed in node. This will not copy any children nodes, only the local fields.

Parameters:

node - The sensor node to copy info from

setObjectType

public void setObjectType(String[] types,
 int numValid)

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

Specified by:

setObjectType in interface VRMLPickingSensorNodeType

Parameters:

types - The list of object type strings to use

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

numObjectType

public int numObjectType()

Get the current number of valid object type strings.

Specified by:

numObjectType in interface VRMLPickingSensorNodeType

Returns:

a number >= 0

getObjectType

public void getObjectType(String[] val)

Fetch the number of object type values in use currently.

Specified by:

getObjectType in interface VRMLPickingSensorNodeType

Parameters:

val - An array to copy the values to

getSortOrder

public int getSortOrder()

Get the intersection type requested for this node

Specified by:

getSortOrder in interface VRMLPickingSensorNodeType

Returns:

one of the SORT_* constants

getIntersectionType

public int getIntersectionType()

Get the intersection type requested for this node

Specified by:

getIntersectionType in interface VRMLPickingSensorNodeType

Returns:

one of the INTERSECT_* constants

setPickingGeometry

public void setPickingGeometry(VRMLNodeType child)
                        throws InvalidFieldValueException

Set node content as replacement for the pickingGeometry field. This checks only for basic geometry handling. If a concrete node needs a specific set of nodes, it should override this method to check.

Specified by:

setPickingGeometry in interface VRMLPickingSensorNodeType

Parameters:

child - The new picking geometry. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

getPickingGeometry

public VRMLNodeType getPickingGeometry()

Fetch the node that is being used to pick the geometry

Specified by:

getPickingGeometry in interface VRMLPickingSensorNodeType

Returns:

The valid geometry node or null if not set

getPickingTargets

public VRMLNodeType[] getPickingTargets()

Get the list of nodes that are used for the target geometry. This can be a internal listing of children. Any node valid entries in the can be set to null.

Specified by:

getPickingTargets in interface VRMLPickingSensorNodeType

Returns:

an array of picking targets

notifyPickStart

public void notifyPickStart(int numPicks,
 VRMLNode[] nodes,
 float[] points,
 float[] normals,
 float[] texCoords)

Notification that this sensor has just been clicked on to start the pick action. Derived classes should call this one to handle the basic node output and state. Points, normals, texCoords not handled.

Specified by:

notifyPickStart in interface VRMLPickingSensorNodeType

Parameters:

numPicks - The number of items picked in the array

nodes - The geometry that was picked

points - Optional array of points that are the intersection points

normals - Optional array of normals that are the intersection points

texCoords - Optional array of texture coordinates that are the intersection points

notifyPickChange

public void notifyPickChange(int numPicks,
 VRMLNode[] nodes,
 float[] points,
 float[] normals,
 float[] texCoords)

Notify the drag sensor that a sensor is currently dragging this device and that it's position and orientation are as given.

Specified by:

notifyPickChange in interface VRMLPickingSensorNodeType

Parameters:

numPicks - The number of items picked in the array

nodes - The geometry that was picked

points - Optional array of points that are the intersection points

normals - Optional array of normals that are the intersection points

texCoords - Optional array of texture coordinates that are the intersection points

notifyPickEnd

public void notifyPickEnd()

Notification that this sensor has finished a picking action.

Specified by:

notifyPickEnd in interface VRMLPickingSensorNodeType

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class BaseSensorNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class BaseSensorNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 String value)
              throws InvalidFieldException

Set the value of the field at the given index as a single string. This would be used to set SFString field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not know

setValue

public void setValue(int index,
 String[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an array of floats. This would be used to set MFString field type.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

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

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setValue

public void setValue(int index,
 VRMLNodeType child)
              throws InvalidFieldValueException,
InvalidFieldException

Set the value of the field at the given index as an array of nodes. This would be used to set MFNode field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

child - The new value to use for the node

Throws:

InvalidFieldException - The field index is not know

InvalidFieldValueException - The value provided does not fit this type of node

setValue

public void setValue(int index,
 VRMLNodeType[] children,
 int numValid)
              throws InvalidFieldException

Set the value of the field at the given index as an array of nodes. This would be used to set MFNode field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

children - The new value to use for the node

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

Throws:

InvalidFieldException - The field index is not know

setEnabled

public void setEnabled(boolean state)

Accessor method to set a new value for the enabled field.

Specified by:

setEnabled in interface VRMLSensorNodeType

Overrides:

setEnabled in class BaseSensorNode

Parameters:

state - Whether this sensor is enabled

checkPickTargetType

protected void checkPickTargetType(VRMLNodeType target)
                            throws InvalidFieldValueException

Check to make sure the picking target node being added is of the correct type. If not, issue an error.

Parameters:

target - The node to check that it follows the requirements

Throws:

InvalidFieldValueException - The node is not a grouping or shape node

updateChildren

protected void updateChildren(VRMLNodeType[] targets,
 int numValid)

Update the child list with the new nodes. This is called after all the basic filtering has been complete and may be overridden by derived classes if needed. The default implementation is empty.

Parameters:

targets - The list of current children

numValid - The number of valid children to check