Package org.web3d.x3d.jsail.Picking

Class PrimitivePickSensor

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Picking.PrimitivePickSensor

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DSensorNode, PrimitivePickSensor, X3DPickSensorNode

public class PrimitivePickSensor
extends X3DConcreteNode
implements PrimitivePickSensor

If a non-uniform scale is applied to the pick sensor, correct results may require level 3 support.

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. PrimitivePickSensor node tooltip: (X3D version 3.2 or later) [X3DPickSensorNode] PrimitivePickSensor tests picking intersections using one of the basic primitive shapes specified in the pickingGeometry field [Cone|Cylinder|Sphere|Box] against the pickTarget geometry.

• Warning: boolean fields used to control visibility of primitive pickingGeometry subsections are ignored when evaluating picking intersections. Example: a Cylinder without end caps is still treated as an enclosed Cylinder.
• Hint: Sorting is defined based on the primitive type as follows. For Cone, the closest picked primitive is defined to be that closest to the vertex point. For Cylinder, Box, and Sphere, the closest picked primitive is defined to be that closest to the center.
• Hint: picking is performed between rendered frames of the event model. An author sets up the picking request in one frame by placing a LinePickSensor in the desired location. At the start of the next frame, any picking intersections are reported by the pick sensor.
• Hint: picking notification is performed at the start of the frame for all enabled pick sensors once all other sensors are processed.
• Hint: event timing details are explained in X3D Specification 4.4.8.3 Execution model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#ExecutionModel
• Warning: order of contained nodes is significant, single pickingGeometry node must precede pickTarget node array.
• Hint: Box, Cone, Cylinder or Sphere can be used for pickingGeometry node.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

• X3D Abstract Specification: PrimitivePickSensor
• X3D Tooltips: PrimitivePickSensor
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the PrimitivePickSensor element: Picking
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_ISACTIVE	fromField ROUTE name for SFBool field named isActive.
static final String	fromField_MATCHCRITERION	fromField ROUTE name for SFString field named matchCriterion.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_OBJECTTYPE	fromField ROUTE name for MFString field named objectType.
static final String	fromField_PICKEDGEOMETRY	fromField ROUTE name for MFNode field named pickedGeometry.
static final String	fromField_PICKINGGEOMETRY	fromField ROUTE name for SFNode field named pickingGeometry.
static final String	fromField_PICKTARGET	fromField ROUTE name for MFNode field named pickTarget.
static final String	INTERSECTIONTYPE_BOUNDS	Tooltip: TODO undefined in X3D specification.
static final String	INTERSECTIONTYPE_DEFAULT_VALUE	SFString field named intersectionType has default value "BOUNDS" (Java syntax) or BOUNDS (XML syntax).
static final String	INTERSECTIONTYPE_GEOMETRY	Tooltip: TODO undefined in X3D specification.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Picking component level for this element: 2
static final String	MATCHCRITERION_DEFAULT_VALUE	SFString field named matchCriterion has default value "MATCH_ANY" (Java syntax) or MATCH_ANY (XML syntax).
static final String	MATCHCRITERION_MATCH_ANY	Tooltip: any match of objectType values is acceptable.
static final String	MATCHCRITERION_MATCH_EVERY	Tooltip: every objectType value in X3DPickSensorNode and X3DPickableObject shall match.
static final String	MATCHCRITERION_MATCH_ONLY_ONE	Tooltip: one and only one objectType value can match.
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: PrimitivePickSensor.
static final String	OBJECTTYPE_ALL	Tooltip: each node is available for picking.
static final ArrayList<String>	OBJECTTYPE_DEFAULT_VALUE	MFString field named objectType has default quoted value new String[] {"ALL"} (Java syntax) or quoted value "ALL" (XML syntax).
static final String	OBJECTTYPE_NONE	Tooltip: no node is available for picking.
static final String	OBJECTTYPE_TERRAIN	Tooltip: TERRAIN is an example value.
static final X3DGeometryNode	PICKINGGEOMETRY_DEFAULT_VALUE	SFNode field named pickingGeometry has default value null (Java syntax) or NULL (XML syntax).
static final String	SORTORDER_ALL	Tooltip: every object that satisfies picking conditions for this pick sensor is returned.
static final String	SORTORDER_ALL_SORTED	Tooltip: every object that satisfies picking conditions for this pick sensor is returned, in sorted order.
static final String	SORTORDER_ANY	Tooltip: any single object that can satisfy picking conditions.
static final String	SORTORDER_CLOSEST	Tooltip: return closest object by distance that satisfies conditions of this pick sensor.
static final String	SORTORDER_DEFAULT_VALUE	SFString field named sortOrder has default value "CLOSEST" (Java syntax) or CLOSEST (XML syntax).
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_MATCHCRITERION	toField ROUTE name for SFString field named matchCriterion.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_OBJECTTYPE	toField ROUTE name for MFString field named objectType.
static final String	toField_PICKINGGEOMETRY	toField ROUTE name for SFNode field named pickingGeometry.
static final String	toField_PICKTARGET	toField ROUTE name for MFNode field named pickTarget.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
PrimitivePickSensor()	Constructor for PrimitivePickSensor to initialize member variables with default values.
PrimitivePickSensor(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
PrimitivePickSensor	addComments(String newComment)	Add comment as String to contained commentsList.
PrimitivePickSensor	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
PrimitivePickSensor	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
PrimitivePickSensor	addObjectType(String newValue)	Add singleton String value to MFString objectType field.
PrimitivePickSensor	addObjectType(SFString newValue)	Add singleton SFString value to MFString objectType field.
PrimitivePickSensor	addPickTarget(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for pickTarget field.
PrimitivePickSensor	addPickTarget(X3DNode newValue)	Add single child node to existing array of pickTarget nodes (if any).
void	addPickTarget(X3DNode[] newValue)	Add array of child pickTarget nodes to array of existing nodes (if any).
PrimitivePickSensor	clearIS()	Utility method to clear SFNode value of IS field.
PrimitivePickSensor	clearMetadata()	Utility method to clear SFNode value of metadata field.
PrimitivePickSensor	clearObjectType()	Utility method to clear MFString value of objectType field.
PrimitivePickSensor	clearPickingGeometry()	Utility method to clear SFNode value of pickingGeometry field.
PrimitivePickSensor	clearPickTarget()	Utility method to clear MFNode value of pickTarget field.
X3DConcreteElement	findElementByNameValue(String nameValue)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(String nameValue, String elementName)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
final String	getComponent()	Defines X3D component for the PrimitivePickSensor element: Picking
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
String	getDescription()	Provide String value from inputOutput SFString field named description.
final String	getElementName()	Provides name of this element: PrimitivePickSensor
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
String	getIntersectionType()	Provide String enumeration value (baseType xs:NMTOKEN) ["BOUNDS" | "GEOMETRY" | 'etc.'] from initializeOnly SFString field named intersectionType.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
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.
ArrayList<String>	getObjectTypeList()	Utility method to get ArrayList value of MFString objectType field, similar to getObjectType().
String	getObjectTypeString()	Utility method to get String value of MFString objectType field, similar to getObjectType().
X3DNode[]	getPickedGeometry()	Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from outputOnly MFNode field pickedGeometry.
ArrayList<X3DNode>	getPickedGeometryList()	Utility method to get ArrayList value of MFNode pickedGeometry field, similar to getPickedGeometry().
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.
ArrayList<X3DNode>	getPickTargetList()	Utility method to get ArrayList value of MFNode pickTarget field, similar to getPickTarget().
String	getSortOrder()	Provide String enumeration value (baseType xs:NMTOKEN) ["ANY" | "CLOSEST" | "ALL" | "ALL_SORTED" | 'etc.'] from initializeOnly SFString field named sortOrder.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasElementByNameValue(String nameValue, String elementName)	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
boolean	hasPickingGeometry()	Indicate whether an object is available for inputOutput SFNode field pickingGeometry.
boolean	hasPickTarget()	Indicate whether an object is available for inputOutput MFNode field pickTarget.
final void	initialize()	Initialize all member variables to default values.
final PrimitivePickSensor	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
PrimitivePickSensor	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final PrimitivePickSensor	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
PrimitivePickSensor	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final PrimitivePickSensor	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
PrimitivePickSensor	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
PrimitivePickSensor	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
PrimitivePickSensor	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
PrimitivePickSensor	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
PrimitivePickSensor	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
final PrimitivePickSensor	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
PrimitivePickSensor	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
PrimitivePickSensor	setIntersectionType(String newValue)	Accessor method to assign String enumeration value ("BOUNDS" | "GEOMETRY") to initializeOnly SFString field named intersectionType.
PrimitivePickSensor	setIntersectionType(SFString newValue)	Assign typed object value to SFString intersectionType field, similar to setIntersectionType(String).
PrimitivePickSensor	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
PrimitivePickSensor	setMatchCriterion(String newValue)	Accessor method to assign String enumeration value ("MATCH_ANY" | "MATCH_EVERY" | "MATCH_ONLY_ONE") to inputOutput SFString field named matchCriterion.
PrimitivePickSensor	setMatchCriterion(SFString newValue)	Assign typed object value to SFString matchCriterion field, similar to setMatchCriterion(String).
PrimitivePickSensor	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
PrimitivePickSensor	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
PrimitivePickSensor	setObjectType(String newValue)	Assign singleton String value to MFString objectType field, similar to setObjectType(String[]).
PrimitivePickSensor	setObjectType(String[] newValue)	Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
PrimitivePickSensor	setObjectType(ArrayList<String> newValue)	Assign ArrayList value of MFString objectType field, similar to setObjectType(String[]).
PrimitivePickSensor	setObjectType(MFString newValue)	Assign typed object value to MFString objectType field, similar to setObjectType(String[]).
PrimitivePickSensor	setObjectType(SFString newValue)	Assign single SFString object value to MFString objectType field, similar to setObjectType(String[]).
PrimitivePickSensor	setPickingGeometry(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field pickingGeometry.
PrimitivePickSensor	setPickingGeometry(X3DGeometryNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field pickingGeometry.
PrimitivePickSensor	setPickTarget(ArrayList<X3DNode> newValue)	Assign ArrayList value of MFNode pickTarget field, similar to setPickTarget(org.web3d.x3d.sai.Core.X3DNode[]).
void	setPickTarget(X3DNode newValue)	Set single child pickTarget node, replacing prior array of existing nodes (if any).
PrimitivePickSensor	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.
PrimitivePickSensor	setSortOrder(String newValue)	Accessor method to assign String enumeration value ("ANY" | "CLOSEST" | "ALL" | "ALL_SORTED") to initializeOnly SFString field named sortOrder.
PrimitivePickSensor	setSortOrder(SFString newValue)	Assign typed object value to SFString sortOrder field, similar to setSortOrder(String).
final PrimitivePickSensor	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
PrimitivePickSensor	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
PrimitivePickSensor	setUSE(PrimitivePickSensor DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

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

Field Details

INTERSECTIONTYPE_BOUNDS

public static final String INTERSECTIONTYPE_BOUNDS

Tooltip: TODO undefined in X3D specification. SFString field named intersectionType with X3DUOM simpleType intersectionTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "BOUNDS" (Java syntax) or BOUNDS (XML syntax).

See Also:

• XML Schema: intersectionTypeValues
• https://www.web3d.org/member-only/mantis/view.php?id=1294
• Constant Field Values

INTERSECTIONTYPE_GEOMETRY

public static final String INTERSECTIONTYPE_GEOMETRY

Tooltip: TODO undefined in X3D specification. SFString field named intersectionType with X3DUOM simpleType intersectionTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "GEOMETRY" (Java syntax) or GEOMETRY (XML syntax).

See Also:

• XML Schema: intersectionTypeValues
• https://www.web3d.org/member-only/mantis/view.php?id=1294
• Constant Field Values

MATCHCRITERION_MATCH_ANY

public static final String MATCHCRITERION_MATCH_ANY

Tooltip: any match of objectType values is acceptable. SFString field named matchCriterion with X3DUOM simpleType pickSensorMatchCriterionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MATCH_ANY" (Java syntax) or MATCH_ANY (XML syntax).

See Also:

• XML Schema: pickSensorMatchCriterionChoices
• Constant Field Values

MATCHCRITERION_MATCH_EVERY

public static final String MATCHCRITERION_MATCH_EVERY

Tooltip: every objectType value in X3DPickSensorNode and X3DPickableObject shall match. SFString field named matchCriterion with X3DUOM simpleType pickSensorMatchCriterionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MATCH_EVERY" (Java syntax) or MATCH_EVERY (XML syntax).

See Also:

• XML Schema: pickSensorMatchCriterionChoices
• Constant Field Values

MATCHCRITERION_MATCH_ONLY_ONE

public static final String MATCHCRITERION_MATCH_ONLY_ONE

Tooltip: one and only one objectType value can match. SFString field named matchCriterion with X3DUOM simpleType pickSensorMatchCriterionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MATCH_ONLY_ONE" (Java syntax) or MATCH_ONLY_ONE (XML syntax).

See Also:

• XML Schema: pickSensorMatchCriterionChoices
• Constant Field Values

OBJECTTYPE_ALL

public static final String OBJECTTYPE_ALL

Tooltip: each node is available for picking. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ALL" (Java syntax) or '"ALL"' (XML syntax).

See Also:

• XML Schema: pickableObjectTypeValues
• Constant Field Values

OBJECTTYPE_NONE

public static final String OBJECTTYPE_NONE

Tooltip: no node is available for picking. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).

See Also:

• XML Schema: pickableObjectTypeValues
• Constant Field Values

OBJECTTYPE_TERRAIN

public static final String OBJECTTYPE_TERRAIN

Tooltip: TERRAIN is an example value. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "TERRAIN" (Java syntax) or '"TERRAIN"' (XML syntax).

See Also:

• XML Schema: pickableObjectTypeValues
• Constant Field Values

SORTORDER_ANY

public static final String SORTORDER_ANY

Tooltip: any single object that can satisfy picking conditions. SFString field named sortOrder with X3DUOM simpleType pickSensorSortOrderValues and with X3DUOM baseType xs:NMTOKEN can equal this value "ANY" (Java syntax) or ANY (XML syntax).

See Also:

• XML Schema: pickSensorSortOrderValues
• Constant Field Values

SORTORDER_CLOSEST

public static final String SORTORDER_CLOSEST

Tooltip: return closest object by distance that satisfies conditions of this pick sensor. SFString field named sortOrder with X3DUOM simpleType pickSensorSortOrderValues and with X3DUOM baseType xs:NMTOKEN can equal this value "CLOSEST" (Java syntax) or CLOSEST (XML syntax).

See Also:

• XML Schema: pickSensorSortOrderValues
• Constant Field Values

SORTORDER_ALL

public static final String SORTORDER_ALL

Tooltip: every object that satisfies picking conditions for this pick sensor is returned. SFString field named sortOrder with X3DUOM simpleType pickSensorSortOrderValues and with X3DUOM baseType xs:NMTOKEN can equal this value "ALL" (Java syntax) or ALL (XML syntax).

See Also:

• XML Schema: pickSensorSortOrderValues
• Constant Field Values

SORTORDER_ALL_SORTED

public static final String SORTORDER_ALL_SORTED

Tooltip: every object that satisfies picking conditions for this pick sensor is returned, in sorted order. SFString field named sortOrder with X3DUOM simpleType pickSensorSortOrderValues and with X3DUOM baseType xs:NMTOKEN can equal this value "ALL_SORTED" (Java syntax) or ALL_SORTED (XML syntax).

See Also:

• XML Schema: pickSensorSortOrderValues
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: PrimitivePickSensor.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the PrimitivePickSensor element: Picking

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Picking component level for this element: 2

See Also:

• Constant Field Values

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

ENABLED_DEFAULT_VALUE

public static final boolean ENABLED_DEFAULT_VALUE

SFBool field named enabled has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

INTERSECTIONTYPE_DEFAULT_VALUE

public static final String INTERSECTIONTYPE_DEFAULT_VALUE

SFString field named intersectionType has default value "BOUNDS" (Java syntax) or BOUNDS (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

MATCHCRITERION_DEFAULT_VALUE

public static final String MATCHCRITERION_DEFAULT_VALUE

SFString field named matchCriterion has default value "MATCH_ANY" (Java syntax) or MATCH_ANY (XML syntax).

See Also:

• Constant Field Values

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

OBJECTTYPE_DEFAULT_VALUE

public static final ArrayList<String> OBJECTTYPE_DEFAULT_VALUE

MFString field named objectType has default quoted value new String[] {"ALL"} (Java syntax) or quoted value "ALL" (XML syntax).

PICKINGGEOMETRY_DEFAULT_VALUE

public static final X3DGeometryNode PICKINGGEOMETRY_DEFAULT_VALUE

SFNode field named pickingGeometry has default value null (Java syntax) or NULL (XML syntax).

SORTORDER_DEFAULT_VALUE

public static final String SORTORDER_DEFAULT_VALUE

SFString field named sortOrder has default value "CLOSEST" (Java syntax) or CLOSEST (XML syntax).

See Also:

• Constant Field Values

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_ENABLED

public static final String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

toField_ENABLED

public static final String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_ISACTIVE

public static final String fromField_ISACTIVE

fromField ROUTE name for SFBool field named isActive.

See Also:

• Constant Field Values

fromField_MATCHCRITERION

public static final String fromField_MATCHCRITERION

fromField ROUTE name for SFString field named matchCriterion.

See Also:

• Constant Field Values

toField_MATCHCRITERION

public static final String toField_MATCHCRITERION

toField ROUTE name for SFString field named matchCriterion.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_OBJECTTYPE

public static final String fromField_OBJECTTYPE

fromField ROUTE name for MFString field named objectType.

See Also:

• Constant Field Values

toField_OBJECTTYPE

public static final String toField_OBJECTTYPE

toField ROUTE name for MFString field named objectType.

See Also:

• Constant Field Values

fromField_PICKEDGEOMETRY

public static final String fromField_PICKEDGEOMETRY

fromField ROUTE name for MFNode field named pickedGeometry.

See Also:

• Constant Field Values

fromField_PICKINGGEOMETRY

public static final String fromField_PICKINGGEOMETRY

fromField ROUTE name for SFNode field named pickingGeometry.

See Also:

• Constant Field Values

toField_PICKINGGEOMETRY

public static final String toField_PICKINGGEOMETRY

toField ROUTE name for SFNode field named pickingGeometry.

See Also:

• Constant Field Values

fromField_PICKTARGET

public static final String fromField_PICKTARGET

fromField ROUTE name for MFNode field named pickTarget.

See Also:

• Constant Field Values

toField_PICKTARGET

public static final String toField_PICKTARGET

toField ROUTE name for MFNode field named pickTarget.

See Also:

• Constant Field Values

Constructor Details

PrimitivePickSensor

public PrimitivePickSensor()

Constructor for PrimitivePickSensor to initialize member variables with default values.

PrimitivePickSensor

public PrimitivePickSensor(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Details

getElementName

public final String getElementName()

Provides name of this element: PrimitivePickSensor

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the PrimitivePickSensor element: Picking

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 2

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public String getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the node.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface PrimitivePickSensor

Specified by:

getDescription in interface X3DPickSensorNode

Specified by:

getDescription in interface X3DSensorNode

Returns:

value of description field

setDescription

public PrimitivePickSensor setDescription(String newValue)

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

Tooltip: Author-provided prose that describes intended purpose of the node.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface PrimitivePickSensor

Specified by:

setDescription in interface X3DPickSensorNode

Specified by:

setDescription in interface X3DSensorNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

public PrimitivePickSensor setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

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

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface PrimitivePickSensor

Specified by:

getEnabled in interface X3DPickSensorNode

Specified by:

getEnabled in interface X3DSensorNode

Returns:

value of enabled field

setEnabled

public PrimitivePickSensor setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

setEnabled in interface PrimitivePickSensor

Specified by:

setEnabled in interface X3DPickSensorNode

Specified by:

setEnabled in interface X3DSensorNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public PrimitivePickSensor setEnabled(SFBool newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getIntersectionType

public String getIntersectionType()

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

Tooltip: intersectionType specifies precision of the collision computation.

• Hint: intersectionType constants may be extended by the browser to provide additional options.
• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.

Available enumeration values for string comparison: BOUNDS, GEOMETRY.

Specified by:

getIntersectionType in interface PrimitivePickSensor

Specified by:

getIntersectionType in interface X3DPickSensorNode

Returns:

value of intersectionType field

setIntersectionType

public PrimitivePickSensor setIntersectionType(String newValue)

Accessor method to assign String enumeration value ("BOUNDS" | "GEOMETRY") to initializeOnly SFString field named intersectionType.

Hint: authors have option to choose from an extendible list of predefined enumeration values (BOUNDS, GEOMETRY).

Tooltip: intersectionType specifies precision of the collision computation.

• Hint: intersectionType constants may be extended by the browser to provide additional options.
• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.

Specified by:

setIntersectionType in interface PrimitivePickSensor

Specified by:

setIntersectionType in interface X3DPickSensorNode

Parameters:

newValue - is new value for the intersectionType field.

Returns:

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

setIntersectionType

public PrimitivePickSensor setIntersectionType(SFString newValue)

Assign typed object value to SFString intersectionType field, similar to setIntersectionType(String).

Parameters:

newValue - is new value for the intersectionType field.

Returns:

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

getIS

public IS getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public PrimitivePickSensor setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

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

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

clearIS

public PrimitivePickSensor clearIS()

Utility method to clear SFNode value of IS field.

Returns:

PrimitivePickSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasIS

public boolean hasIS()

Indicate whether an object is available for inputOutput SFNode field IS.

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getIS()

getIsActive

public boolean getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

Tooltip: isActive indicates when the intersecting object is picked by the picking geometry. Output event isActive=true gets sent once a picked item is found. Output event isActive=false gets sent once no picked item is found.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getIsActive in interface PrimitivePickSensor

Specified by:

getIsActive in interface X3DPickSensorNode

Specified by:

getIsActive in interface X3DSensorNode

Returns:

value of isActive field

getMatchCriterion

public String getMatchCriterion()

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

Tooltip: defines whether the intersection test (i.e. pick) by this X3DPickSensorNode must match one or more objectType. Specifically MATCH_ANY means any match of objectType values is acceptable, MATCH_EVERY means that every objectType value in this node shall match an objectType value in the X3DPickableObject, and MATCH_ONLY_ONE means that one and only one objectType value can match. *


Available enumeration values for string comparison: MATCH_ANY, MATCH_EVERY, MATCH_ONLY_ONE.

Specified by:

getMatchCriterion in interface PrimitivePickSensor

Specified by:

getMatchCriterion in interface X3DPickSensorNode

Returns:

value of matchCriterion field

setMatchCriterion

public PrimitivePickSensor setMatchCriterion(String newValue)

Accessor method to assign String enumeration value ("MATCH_ANY" | "MATCH_EVERY" | "MATCH_ONLY_ONE") to inputOutput SFString field named matchCriterion.

Warning: authors can only choose from a strict list of enumeration values (MATCH_ANY, MATCH_EVERY, MATCH_ONLY_ONE).

Tooltip: defines whether the intersection test (i.e. pick) by this X3DPickSensorNode must match one or more objectType. Specifically MATCH_ANY means any match of objectType values is acceptable, MATCH_EVERY means that every objectType value in this node shall match an objectType value in the X3DPickableObject, and MATCH_ONLY_ONE means that one and only one objectType value can match. *

Specified by:

setMatchCriterion in interface PrimitivePickSensor

Specified by:

setMatchCriterion in interface X3DPickSensorNode

Parameters:

newValue - is new value for the matchCriterion field.

Returns:

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

setMatchCriterion

public PrimitivePickSensor setMatchCriterion(SFString newValue)

Assign typed object value to SFString matchCriterion field, similar to setMatchCriterion(String).

Parameters:

newValue - is new value for the matchCriterion field.

Returns:

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

getMetadata

public 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 PrimitivePickSensor

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DPickSensorNode

Specified by:

getMetadata in interface X3DSensorNode

Returns:

value of metadata field

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public PrimitivePickSensor 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 PrimitivePickSensor

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DPickSensorNode

Specified by:

setMetadata in interface X3DSensorNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public PrimitivePickSensor clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

PrimitivePickSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public PrimitivePickSensor setMetadata(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• setMetadata(org.web3d.x3d.sai.Core.X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

Indicate whether an object is available for inputOutput SFNode field metadata.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getMetadata()
• getMetadataProtoInstance()
• X3D Scene Authoring Hints: Metadata Nodes

getObjectType

public String[] getObjectType()

Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.

Tooltip: The objectType field specifies a set of labels used in the picking process. Each string specified is treated as an independent label that needs to be matched against the same type in one of the pick sensor instances. Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to intersect a pick sensor with objectType value "GROUND" fails since the objectType values do not match. Example: the special value "ALL" means that each node is available for picking regardless of the type specified by the pick sensor. Example: the special value "NONE" effectively disables all picking for this node and is the equivalent of setting the pickable field of the corresponding PickableGroup to false.

• Hint: authors may define any value for objectType.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Available enumeration values for string comparison: ALL, NONE, TERRAIN.

Specified by:

getObjectType in interface PrimitivePickSensor

Specified by:

getObjectType in interface X3DPickSensorNode

Returns:

value of objectType field

getObjectTypeList

public ArrayList<String> getObjectTypeList()

Utility method to get ArrayList value of MFString objectType field, similar to getObjectType().

Returns:

value of objectType field

getObjectTypeString

public String getObjectTypeString()

Utility method to get String value of MFString objectType field, similar to getObjectType().

Returns:

value of objectType field

setObjectType

public PrimitivePickSensor setObjectType(String[] newValue)

Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.

Hint: authors have option to choose from an extendible list of predefined enumeration values (ALL, NONE, TERRAIN).

Tooltip: The objectType field specifies a set of labels used in the picking process. Each string specified is treated as an independent label that needs to be matched against the same type in one of the pick sensor instances. Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to intersect a pick sensor with objectType value "GROUND" fails since the objectType values do not match. Example: the special value "ALL" means that each node is available for picking regardless of the type specified by the pick sensor. Example: the special value "NONE" effectively disables all picking for this node and is the equivalent of setting the pickable field of the corresponding PickableGroup to false.

• Hint: authors may define any value for objectType.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setObjectType in interface PrimitivePickSensor

Specified by:

setObjectType in interface X3DPickSensorNode

Parameters:

newValue - is new value for the objectType field.

Returns:

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

setObjectType

public PrimitivePickSensor setObjectType(MFString newValue)

Assign typed object value to MFString objectType field, similar to setObjectType(String[]).

Parameters:

newValue - is new value for the objectType field.

Returns:

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

setObjectType

public PrimitivePickSensor setObjectType(SFString newValue)

Assign single SFString object value to MFString objectType field, similar to setObjectType(String[]).

Parameters:

newValue - is new value for the objectType field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setObjectType

public PrimitivePickSensor setObjectType(String newValue)

Assign singleton String value to MFString objectType field, similar to setObjectType(String[]).

Parameters:

newValue - is new value for the objectType field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setObjectType

public PrimitivePickSensor setObjectType(ArrayList<String> newValue)

Assign ArrayList value of MFString objectType field, similar to setObjectType(String[]).

Parameters:

newValue - is new value for the objectType field.

Returns:

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

clearObjectType

public PrimitivePickSensor clearObjectType()

Utility method to clear MFString value of objectType field. This method does not initialize withOBJECTTYPE_DEFAULT_VALUE.

Returns:

PrimitivePickSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addObjectType

public PrimitivePickSensor addObjectType(String newValue)

Add singleton String value to MFString objectType field.

Parameters:

newValue - is new value to add to the objectType field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addObjectType

public PrimitivePickSensor addObjectType(SFString newValue)

Add singleton SFString value to MFString objectType field.

Parameters:

newValue - is new value to add to the objectType field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

getPickedGeometry

public X3DNode[] getPickedGeometry()

Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from outputOnly MFNode field pickedGeometry.

Tooltip: Output event containing the node or nodes that have been found to intersect with the picking geometry from the last time this node performed a picking operation, given in the local coordinate system.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.

Specified by:

getPickedGeometry in interface PrimitivePickSensor

Specified by:

getPickedGeometry in interface X3DPickSensorNode

Returns:

value of pickedGeometry field

See Also:

• X3DChildNode

getPickedGeometryList

public ArrayList<X3DNode> getPickedGeometryList()

Utility method to get ArrayList value of MFNode pickedGeometry field, similar to getPickedGeometry().

Returns:

value of pickedGeometry field

getPickingGeometry

public X3DGeometryNode getPickingGeometry()

Provide org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field pickingGeometry.

Specified by:

getPickingGeometry in interface PrimitivePickSensor

Specified by:

getPickingGeometry in interface X3DPickSensorNode

Returns:

value of pickingGeometry field

See Also:

• 
  
  Tooltip: [Cone|Cylinder|Sphere|Box] pickingGeometry specifies the exact geometry coordinates that are used to perform the intersection testing of the picking operation. *
  

setPickingGeometry

public PrimitivePickSensor setPickingGeometry(X3DGeometryNode newValue)

Accessor method to assign org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field pickingGeometry.

Specified by:

setPickingGeometry in interface PrimitivePickSensor

Specified by:

setPickingGeometry in interface X3DPickSensorNode

Parameters:

newValue - is new value for the pickingGeometry field.

Returns:

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

See Also:

• 
  
  Tooltip: [Cone|Cylinder|Sphere|Box] pickingGeometry specifies the exact geometry coordinates that are used to perform the intersection testing of the picking operation. *
  

clearPickingGeometry

public PrimitivePickSensor clearPickingGeometry()

Utility method to clear SFNode value of pickingGeometry field.

Returns:

PrimitivePickSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setPickingGeometry

public PrimitivePickSensor setPickingGeometry(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field pickingGeometry.

Parameters:

newValue - is new value for the pickingGeometry field.

Returns:

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

See Also:

• setPickingGeometry(org.web3d.x3d.sai.Rendering.X3DGeometryNode)

hasPickingGeometry

public boolean hasPickingGeometry()

Indicate whether an object is available for inputOutput SFNode field pickingGeometry.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getPickingGeometry()
• getPickingGeometryProtoInstance()

getPickTarget

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

Tooltip: [X3DGroupingNode|X3DShapeNode|Inline] pickTarget specifies the list of nodes against which picking operations are performed. All nodes declared in this field and their descendents are evaluated for intersections. *


Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DGroupingNode|X3DShapeNode|Inline.

Specified by:

getPickTarget in interface PrimitivePickSensor

Specified by:

getPickTarget in interface X3DPickSensorNode

Returns:

value of pickTarget field

See Also:

• X3DGroupingNode
• X3DShapeNode
• Inline

getPickTargetList

public ArrayList<X3DNode> getPickTargetList()

Utility method to get ArrayList value of MFNode pickTarget field, similar to getPickTarget().

Returns:

value of pickTarget field

setPickTarget

public PrimitivePickSensor 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.

Tooltip: [X3DGroupingNode|X3DShapeNode|Inline] pickTarget specifies the list of nodes against which picking operations are performed. All nodes declared in this field and their descendents are evaluated for intersections. *


Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DGroupingNode|X3DShapeNode|Inline.

Specified by:

setPickTarget in interface PrimitivePickSensor

Specified by:

setPickTarget in interface X3DPickSensorNode

Parameters:

newValue - is new value for the pickTarget field.

Returns:

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

setPickTarget

public PrimitivePickSensor setPickTarget(ArrayList<X3DNode> newValue)

Assign ArrayList value of MFNode pickTarget field, similar to setPickTarget(org.web3d.x3d.sai.Core.X3DNode[]).

Parameters:

newValue - is new value for the pickTarget field.

Returns:

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

addPickTarget

public PrimitivePickSensor addPickTarget(X3DNode newValue)

Add single child node to existing array of pickTarget nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DGroupingNode|X3DShapeNode|Inline and ProtoInstance.

Parameters:

newValue - is new value to be appended the pickTarget field.

Returns:

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

addPickTarget

public PrimitivePickSensor addPickTarget(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for pickTarget field.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.

Parameters:

newValue - is new value to be appended the parts field.

Returns:

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

addPickTarget

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

Specified by:

addPickTarget in interface PrimitivePickSensor

Specified by:

addPickTarget in interface X3DPickSensorNode

Parameters:

newValue - is new value array to be appended the pickTarget field.

setPickTarget

public void setPickTarget(X3DNode newValue)

Set single child pickTarget node, replacing prior array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DGroupingNode|X3DShapeNode|Inline.

Specified by:

setPickTarget in interface PrimitivePickSensor

Specified by:

setPickTarget in interface X3DPickSensorNode

Parameters:

newValue - is new node for the pickTarget field (restricted to X3DGroupingNode|X3DShapeNode|Inline)

clearPickTarget

public PrimitivePickSensor clearPickTarget()

Utility method to clear MFNode value of pickTarget field. This method does not initialize withPICKTARGET_DEFAULT_VALUE.

Returns:

PrimitivePickSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasPickTarget

public boolean hasPickTarget()

Indicate whether an object is available for inputOutput MFNode field pickTarget.

Returns:

whether a properly typed node or ProtoInstance array or CommentsBlock is available.

See Also:

• getPickTarget()

getSortOrder

public String getSortOrder()

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

Tooltip: The sortOrder field determines the order provided for picked output events. Example: ANY means any single object that can satisfy picking conditions for this pick sensor. Consistency of results is not guaranteed. Example: ALL means that every object that satisfies the picking conditions for this pick sensor shall be returned. Example: ALL_SORTED means that every object that satisfies the picking conditions for this pick sensor shall be returned with the order of the output fields provided in a distance-sorted order from closest to farthest away. The exact algorithm for sorting is defined by the individual node definitions. Example: CLOSEST means that the closest object by distance that satisfies the conditions of this pick sensor. *The exact algorithm for distance determination shall be defined by individual node definitions*.

• Hint: browser implementations may define additional values and algorithms beyond these four required values.
• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.

Available enumeration values for string comparison: ANY, CLOSEST, ALL, ALL_SORTED.

Specified by:

getSortOrder in interface PrimitivePickSensor

Specified by:

getSortOrder in interface X3DPickSensorNode

Returns:

value of sortOrder field

setSortOrder

public PrimitivePickSensor setSortOrder(String newValue)

Accessor method to assign String enumeration value ("ANY" | "CLOSEST" | "ALL" | "ALL_SORTED") to initializeOnly SFString field named sortOrder.

Hint: authors have option to choose from an extendible list of predefined enumeration values (ANY, CLOSEST, ALL, ALL_SORTED).

Tooltip: The sortOrder field determines the order provided for picked output events. Example: ANY means any single object that can satisfy picking conditions for this pick sensor. Consistency of results is not guaranteed. Example: ALL means that every object that satisfies the picking conditions for this pick sensor shall be returned. Example: ALL_SORTED means that every object that satisfies the picking conditions for this pick sensor shall be returned with the order of the output fields provided in a distance-sorted order from closest to farthest away. The exact algorithm for sorting is defined by the individual node definitions. Example: CLOSEST means that the closest object by distance that satisfies the conditions of this pick sensor. *The exact algorithm for distance determination shall be defined by individual node definitions*.

• Hint: browser implementations may define additional values and algorithms beyond these four required values.
• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.

Specified by:

setSortOrder in interface PrimitivePickSensor

Specified by:

setSortOrder in interface X3DPickSensorNode

Parameters:

newValue - is new value for the sortOrder field.

Returns:

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

setSortOrder

public PrimitivePickSensor setSortOrder(SFString newValue)

Assign typed object value to SFString sortOrder field, similar to setSortOrder(String).

Parameters:

newValue - is new value for the sortOrder field.

Returns:

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

getDEF

public String getDEF()

Provide String value from inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final PrimitivePickSensor setDEF(String newValue)

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

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public PrimitivePickSensor setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

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

getUSE

public String getUSE()

Provide String value from inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).

• Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
• Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
• Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final PrimitivePickSensor setUSE(String newValue)

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

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).

• Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
• Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
• Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

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 class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public PrimitivePickSensor setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

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

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final PrimitivePickSensor setCssClass(String newValue)

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

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public PrimitivePickSensor setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

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

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final PrimitivePickSensor setHtmlID(String newValue)

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

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public PrimitivePickSensor setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

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

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final PrimitivePickSensor setCssStyle(String newValue)

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

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public PrimitivePickSensor setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

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

setUSE

public PrimitivePickSensor setUSE(PrimitivePickSensor DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that 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.

Parameters:

DEFnode - must have a DEF value defined

Returns:

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

addComments

public PrimitivePickSensor addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public PrimitivePickSensor addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

PrimitivePickSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public PrimitivePickSensor addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

PrimitivePickSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

• X3D.FILE_EXTENSION_CLASSICVRML
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

• X3D.FILE_EXTENSION_VRML97
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Virtual Reality Modeling Language (VRML) 97 specification
• VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

• findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

• findElementByNameValue(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

• findNodeByDEF(String)

validate

public String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)