X3DPickSensorNode (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode, X3DSensorNode

All Known Subinterfaces:

LinePickSensor, PointPickSensor, PrimitivePickSensor, VolumePickSensor

All Known Implementing Classes:

LinePickSensorObject, PointPickSensorObject, PrimitivePickSensorObject, VolumePickSensorObject
```
public interface X3DPickSensorNode
extends X3DSensorNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: TODO, X3D Tooltips, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPickTarget(X3DNode[] newValue)` Add array of child pickTarget nodes to array of existing nodes (if any).
`boolean`	`getEnabled()` Provide boolean value from inputOutput SFBool field named enabled.
`java.lang.String`	`getIntersectionType()` Provide String enumeration value ['BOUNDS'\|'GEOMETRY'\|'etc.'] from initializeOnly SFString field named intersectionType.
`boolean`	`getIsActive()` Provide boolean value from outputOnly SFBool field named isActive.
`java.lang.String`	`getMatchCriterion()` Provide String enumeration value ['MATCH_ANY'\|'MATCH_EVERY'\|'MATCH_ONLY_ONE'] from inputOutput SFString field named matchCriterion.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`java.lang.String[]`	`getObjectType()` Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.
`X3DNode[]`	`getPickedGeometry()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from outputOnly MFNode field pickedGeometry.
`X3DGeometryNode`	`getPickingGeometry()` Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field pickingGeometry.
`X3DNode[]`	`getPickTarget()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DGroupingNode\|X3DShapeNode\|Inline, from inputOutput MFNode field pickTarget.
`java.lang.String`	`getSortOrder()` Provide String enumeration value ['ANY'\|'CLOSEST'\|'ALL'\|'ALL_SORTED'\|'etc.'] from initializeOnly SFString field named sortOrder.
`X3DPickSensorNode`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`X3DPickSensorNode`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`X3DPickSensorNode`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`X3DPickSensorNode`	`setIntersectionType(java.lang.String newValue)` Assign String enumeration value ("BOUNDS"\|"GEOMETRY") ['BOUNDS'\|'GEOMETRY'\|'etc.'] to initializeOnly SFString field named intersectionType.
`X3DPickSensorNode`	`setMatchCriterion(java.lang.String newValue)` Assign String enumeration value ("MATCH_ANY"\|"MATCH_EVERY"\|"MATCH_ONLY_ONE") ['MATCH_ANY'\|'MATCH_EVERY'\|'MATCH_ONLY_ONE'] to inputOutput SFString field named matchCriterion.
`X3DPickSensorNode`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`X3DPickSensorNode`	`setObjectType(java.lang.String[] newValue)` Assign String enumeration array (""ALL""\|""NONE""\|""TERRAIN"") with quoted value(s) ["ALL","NONE","TERRAIN",...] to inputOutput MFString field named objectType.
`X3DPickSensorNode`	`setPickingGeometry(X3DGeometryNode newValue)` Assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field pickingGeometry.
`void`	`setPickTarget(X3DNode newValue)` Set single child pickTarget node, replacing prior array of existing nodes (if any).
`X3DPickSensorNode`	`setPickTarget(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DGroupingNode\|X3DShapeNode\|Inline, to inputOutput MFNode field pickTarget. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Grouping.X3DGroupingNode) \|\| (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Shape.X3DShapeNode) \|\| (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Networking.InlineObject); if (!
`X3DPickSensorNode`	`setSortOrder(java.lang.String newValue)` Assign String enumeration value ("ANY"\|"CLOSEST"\|"ALL"\|"ALL_SORTED") ['ANY'\|'CLOSEST'\|'ALL'\|'ALL_SORTED'\|'etc.'] to initializeOnly SFString field named sortOrder.
`X3DPickSensorNode`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getEnabled
```
boolean getEnabled()
```
    Provide boolean value from inputOutput SFBool field named enabled.
    
    Specified by:
    
    getEnabled in interface X3DSensorNode
    
    Returns:
    
    value of enabled field
  - setEnabled
```
X3DPickSensorNode setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Specified by:
    
    setEnabled in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIntersectionType
```
java.lang.String getIntersectionType()
```
    Provide String enumeration value ['BOUNDS'|'GEOMETRY'|'etc.'] from initializeOnly SFString field named intersectionType.
    
    Returns:
    
    value of intersectionType field
  - setIntersectionType
```
X3DPickSensorNode setIntersectionType(java.lang.String newValue)
```
    Assign String enumeration value ("BOUNDS"|"GEOMETRY") ['BOUNDS'|'GEOMETRY'|'etc.'] to initializeOnly SFString field named intersectionType.
    
    Parameters:
    
    newValue - is new value for the intersectionType field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIsActive
```
boolean getIsActive()
```
    Provide boolean value from outputOnly SFBool field named isActive.
    
    Specified by:
    
    getIsActive in interface X3DSensorNode
    
    Returns:
    
    value of isActive field
  - getMatchCriterion
```
java.lang.String getMatchCriterion()
```
    Provide String enumeration value ['MATCH_ANY'|'MATCH_EVERY'|'MATCH_ONLY_ONE'] from inputOutput SFString field named matchCriterion.
    
    Returns:
    
    value of matchCriterion field
  - setMatchCriterion
```
X3DPickSensorNode setMatchCriterion(java.lang.String newValue)
```
    Assign String enumeration value ("MATCH_ANY"|"MATCH_EVERY"|"MATCH_ONLY_ONE") ['MATCH_ANY'|'MATCH_EVERY'|'MATCH_ONLY_ONE'] to inputOutput SFString field named matchCriterion.
    
    Parameters:
    
    newValue - is new value for the matchCriterion field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DSensorNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
X3DPickSensorNode setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getObjectType
```
java.lang.String[] getObjectType()
```
    Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.
    
    Returns:
    
    value of objectType field
  - setObjectType
```
X3DPickSensorNode setObjectType(java.lang.String[] newValue)
```
    Assign String enumeration array (""ALL""|""NONE""|""TERRAIN"") with quoted value(s) ["ALL","NONE","TERRAIN",...] to inputOutput MFString field named objectType.
    
    Parameters:
    
    newValue - is new value for the objectType field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getPickedGeometry
```
X3DNode[] getPickedGeometry()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from outputOnly MFNode field pickedGeometry.
    
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
    
    Returns:
    
    value of pickedGeometry field
    
    See Also:
    
    X3DChildNode
  - getPickingGeometry
```
X3DGeometryNode getPickingGeometry()
```
    Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field pickingGeometry.
    
    Returns:
    
    value of pickingGeometry field
  - setPickingGeometry
```
X3DPickSensorNode setPickingGeometry(X3DGeometryNode newValue)
```
    Assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field pickingGeometry.
    
    Parameters:
    
    newValue - is new value for the pickingGeometry field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getPickTarget
```
X3DNode[] getPickTarget()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DGroupingNode|X3DShapeNode|Inline, from inputOutput MFNode field pickTarget.
    
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DGroupingNode|X3DShapeNode|Inline.
    
    Returns:
    
    value of pickTarget field
    
    See Also:
    
    X3DGroupingNode, X3DShapeNode, InlineObject
  - setPickTarget
```
X3DPickSensorNode setPickTarget(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DGroupingNode|X3DShapeNode|Inline, to inputOutput MFNode field pickTarget. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Grouping.X3DGroupingNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Shape.X3DShapeNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Networking.InlineObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DGroupingNode|X3DShapeNode|Inline; newValue=" + newValue); }
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DGroupingNode|X3DShapeNode|Inline.
    
    Parameters:
    
    newValue - is new value for the pickTarget field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addPickTarget
```
void addPickTarget(X3DNode[] newValue)
```
    Add array of child pickTarget nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DGroupingNode|X3DShapeNode|Inline.
    
    Parameters:
    
    newValue - is new value array to be appended the pickTarget field.
  - setPickTarget
```
void setPickTarget(X3DNode newValue)
```
    Set single child pickTarget node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the pickTarget field
  - getSortOrder
```
java.lang.String getSortOrder()
```
    Provide String enumeration value ['ANY'|'CLOSEST'|'ALL'|'ALL_SORTED'|'etc.'] from initializeOnly SFString field named sortOrder.
    
    Returns:
    
    value of sortOrder field
  - setSortOrder
```
X3DPickSensorNode setSortOrder(java.lang.String newValue)
```
    Assign String enumeration value ("ANY"|"CLOSEST"|"ALL"|"ALL_SORTED") ['ANY'|'CLOSEST'|'ALL'|'ALL_SORTED'|'etc.'] to initializeOnly SFString field named sortOrder.
    
    Parameters:
    
    newValue - is new value for the sortOrder field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
X3DPickSensorNode setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
X3DPickSensorNode setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
X3DPickSensorNode setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface X3DPickSensorNode

Method Summary

Method Detail

getEnabled

setEnabled

getIntersectionType

setIntersectionType

getIsActive

getMatchCriterion

setMatchCriterion

getMetadata

setMetadata

getObjectType

setObjectType

getPickedGeometry

getPickingGeometry

setPickingGeometry

getPickTarget

setPickTarget

addPickTarget

setPickTarget

getSortOrder

setSortOrder

setDEF

setUSE

setCssClass