Package org.web3d.x3d.sai.Picking

Interface X3DPickSensorNode

All Superinterfaces:

X3DChildNode, X3DNode, X3DSensorNode

All Known Subinterfaces:

LinePickSensor, PointPickSensor, PrimitivePickSensor, VolumePickSensor

All Known Implementing Classes:

LinePickSensor, PointPickSensor, PrimitivePickSensor, VolumePickSensor

public interface X3DPickSensorNode
extends X3DSensorNode

The X3DPickSensorNode abstract node type is the base node type that represents the lowest common denominator of picking capabilities.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

• SAI Java Specification
• X3D Abstract Specification
• X3D Tooltips
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
void	addPickTarget(X3DNode[] newValue)	Add array of child pickTarget nodes to array of existing nodes (if any).
String	getDescription()	Provide String value from inputOutput SFString field named description.
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getIntersectionType()	Provide String enumeration value (baseType xs:NMTOKEN) ["BOUNDS" | "GEOMETRY" | 'etc.'] from initializeOnly SFString field named intersectionType.
boolean	getIsActive()	Provide boolean value from outputOnly SFBool field named isActive.
String	getMatchCriterion()	Provide String enumeration value (baseType xs:NMTOKEN) ["MATCH_ANY" | "MATCH_EVERY" | "MATCH_ONLY_ONE"] from inputOutput SFString field named matchCriterion.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
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 org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from outputOnly MFNode field pickedGeometry.
X3DGeometryNode	getPickingGeometry()	Provide org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field pickingGeometry.
X3DNode[]	getPickTarget()	Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to X3DGroupingNode|X3DShapeNode|Inline, from inputOutput MFNode field pickTarget.
String	getSortOrder()	Provide String enumeration value (baseType xs:NMTOKEN) ["ANY" | "CLOSEST" | "ALL" | "ALL_SORTED" | 'etc.'] from initializeOnly SFString field named sortOrder.
X3DPickSensorNode	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
X3DPickSensorNode	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
X3DPickSensorNode	setIntersectionType(String newValue)	Accessor method to assign String enumeration value ("BOUNDS" | "GEOMETRY") to initializeOnly SFString field named intersectionType.
X3DPickSensorNode	setMatchCriterion(String newValue)	Accessor method to assign String enumeration value ("MATCH_ANY" | "MATCH_EVERY" | "MATCH_ONLY_ONE") to inputOutput SFString field named matchCriterion.
X3DPickSensorNode	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DPickSensorNode	setObjectType(String[] newValue)	Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
X3DPickSensorNode	setPickingGeometry(X3DGeometryNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.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)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field pickTarget.
X3DPickSensorNode	setSortOrder(String newValue)	Accessor method to assign String enumeration value ("ANY" | "CLOSEST" | "ALL" | "ALL_SORTED") to initializeOnly SFString field named sortOrder.

Method Details

getDescription

String getDescription()

Provide String value from inputOutput SFString field named description.

Specified by:

getDescription in interface X3DSensorNode

Returns:

value of description field

setDescription

X3DPickSensorNode setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

Specified by:

setDescription in interface X3DSensorNode

Parameters:

newValue - is new value for the description field.

Returns:

X3DPickSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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)

Accessor method to 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

String getIntersectionType()

Provide String enumeration value (baseType xs:NMTOKEN) ["BOUNDS" | "GEOMETRY" | 'etc.'] from initializeOnly SFString field named intersectionType.

Returns:

value of intersectionType field

setIntersectionType

X3DPickSensorNode setIntersectionType(String newValue)

Accessor method to assign String enumeration value ("BOUNDS" | "GEOMETRY") 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

String getMatchCriterion()

Provide String enumeration value (baseType xs:NMTOKEN) ["MATCH_ANY" | "MATCH_EVERY" | "MATCH_ONLY_ONE"] from inputOutput SFString field named matchCriterion.

Returns:

value of matchCriterion field

setMatchCriterion

X3DPickSensorNode setMatchCriterion(String newValue)

Accessor method to assign String enumeration value ("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 org.web3d.x3d.sai.Core.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)

Accessor method to assign org.web3d.x3d.sai.Core.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

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(String[] newValue)

Accessor method to assign String enumeration array (""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 org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) 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 org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field pickingGeometry.

Returns:

value of pickingGeometry field

setPickingGeometry

X3DPickSensorNode setPickingGeometry(X3DGeometryNode newValue)

Accessor method to assign org.web3d.x3d.sai.Rendering.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 org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) 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
• Inline

setPickTarget

X3DPickSensorNode setPickTarget(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field pickTarget.

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

String getSortOrder()

Provide String enumeration value (baseType xs:NMTOKEN) ["ANY" | "CLOSEST" | "ALL" | "ALL_SORTED" | 'etc.'] from initializeOnly SFString field named sortOrder.

Returns:

value of sortOrder field

setSortOrder

X3DPickSensorNode setSortOrder(String newValue)

Accessor method to assign String enumeration value ("ANY" | "CLOSEST" | "ALL" | "ALL_SORTED") 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).