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

Class BasePointPickSensor

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

NRPointPickSensor, OGLPointPickSensor

public abstract class BasePointPickSensor
extends BasePickingNode

Implementation of the common PointPickSensor node for all renderers.

Version:

$Revision: 1.7 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_PICKED_POINT	The field index for pickedPoint
protected static final int	LAST_POINT_INDEX	Last index used by this base node
protected static final int	NUM_FIELDS	The total number of fields in this node
protected static final String	POINT_NODE_MSG	Message for when the node in setValue() is not a Geometry
protected static final String	POINT_PROTO_MSG	Message for when the proto is not a Geometry

Fields inherited from class org.web3d.vrml.renderer.common.nodes.picking.BasePickingNode

FIELD_INTERSECTION_TYPE, FIELD_OBJECT_TYPE, FIELD_PICK_TARGET, FIELD_PICKED_GEOMETRY, FIELD_PICKING_GEOMETRY, FIELD_SORT_ORDER, GEOMETRY_NODE_MSG, GEOMETRY_PROTO_MSG, intersectionType, intersectTypeMap, LAST_PICK_INDEX, numPickedGeometry, numPickTarget, pPickingGeometry, sortType, sortTypeMap, validGeometryNodeNames, vfIntersectionType, vfObjectType, vfPickedGeometry, vfPickingGeometry, vfPickTarget, vfSortOrder

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
BasePointPickSensor()	Construct a new time sensor object
BasePointPickSensor(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
int	getPickingType()	Get the picking type that this class represents.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setPickingGeometry(VRMLNodeType child)	Set node content as replacement for the pickingGeometry field.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.picking.BasePickingNode

checkPickTargetType, copy, getIntersectionType, getObjectType, getPickingGeometry, getPickingTargets, getPrimaryType, getSortOrder, notifyPickChange, notifyPickEnd, notifyPickStart, numObjectType, setEnabled, setObjectType, setupFinished, setValue, setValue, setValue, setValue, updateChildren

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

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.VRMLSensorNodeType

getEnabled, getIsActive

Field Details

FIELD_PICKED_POINT

protected static final int FIELD_PICKED_POINT

The field index for pickedPoint

See Also:

• Constant Field Values

LAST_POINT_INDEX

protected static final int LAST_POINT_INDEX

Last index used by this base node

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

The total number of fields in this node

See Also:

• Constant Field Values

POINT_PROTO_MSG

protected static final String POINT_PROTO_MSG

Message for when the proto is not a Geometry

See Also:

• Constant Field Values

POINT_NODE_MSG

protected static final String POINT_NODE_MSG

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

See Also:

• Constant Field Values

Constructor Details

BasePointPickSensor

public BasePointPickSensor()

Construct a new time sensor object

BasePointPickSensor

public BasePointPickSensor(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not the same type, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the same type

Method Details

getPickingType

public int getPickingType()

Get the picking type that this class represents. A shortcut way of quickly determining the picking strategy to be used by the internal implementation to avoid unnessary calculations.

Returns:

One of the *_PICK 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

Overrides:

setPickingGeometry in class BasePickingNode

Parameters:

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

Throws:

InvalidFieldValueException - The node does not match the required type.

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Returns:

The number of fields.

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 BasePickingNode

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 BasePickingNode

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.