Class PointPickSensorObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Picking.PointPickSensorObject
All Implemented Interfaces:
X3DChildNode, X3DNode, X3DSensorNode, PointPickSensor, X3DPickSensorNode

public class PointPickSensorObject
extends X3DConcreteNode
implements PointPickSensor
PointPickSensor tests one or more pickingGeometry points in space as lying inside the provided pickTarget geometry.

X3D node tooltip: (X3D version 3.2 or later) [X3DPickSensorNode] PointPickSensor tests one or more pickingGeometry points in space as lying inside the provided pickTarget geometry. For each pickingGeometry PointSet coordinate point that lies inside the pickTarget geometry, a pickedPoint coordinate is returned along with a corresponding pickedGeometry node inside which the point lies.
  • Hint: because points represent an infinitely small location in space, sortOrder values CLOSEST and ALL_SORTED are defined to mean ANY and ALL respectively.
  • 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/documents/specifications/19775-1/V3.3/Part01/concepts.html#ExecutionModelWarning: order of contained nodes is significant, single pickingGeometry node must precede pickTarget node array.
  • Hint: PointSet 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: PointPickSensor, X3D Tooltips: PointPickSensor, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • PointPickSensorObject

      public PointPickSensorObject()
      Constructor for PointPickSensorObject to initialize member variables with default values.
    • PointPickSensorObject

      public PointPickSensorObject​(java.lang.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 java.lang.String getElementName()
      Provides name of this element: PointPickSensor
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the PointPickSensor 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: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.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 java.lang.String getAccessType​(java.lang.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 java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • getEnabled

      public boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface PointPickSensor
      Specified by:
      getEnabled in interface X3DPickSensorNode
      Specified by:
      getEnabled in interface X3DSensorNode
      Returns:
      value of enabled field
    • setEnabled

      public PointPickSensorObject 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 PointPickSensor
      Specified by:
      setEnabled in interface X3DPickSensorNode
      Specified by:
      setEnabled in interface X3DSensorNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEnabled

      public PointPickSensorObject setEnabled​(SFBoolObject newValue)
      Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIntersectionType

      public java.lang.String getIntersectionType()
      Provide String enumeration value ( baseType intersectionTypeValues) ["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 PointPickSensor
      Specified by:
      getIntersectionType in interface X3DPickSensorNode
      Returns:
      value of intersectionType field
    • setIntersectionType

      public PointPickSensorObject setIntersectionType​(java.lang.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 PointPickSensor
      Specified by:
      setIntersectionType in interface X3DPickSensorNode
      Parameters:
      newValue - is new value for the intersectionType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setIntersectionType

      public PointPickSensorObject setIntersectionType​(SFStringObject newValue)
      Assign typed object value to SFString intersectionType field, similar to setIntersectionType(String).
      Parameters:
      newValue - is new value for the intersectionType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIS

      public ISObject getIS()
      Provide ISObject 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 PointPickSensorObject setIS​(ISObject newValue)
      Accessor method to assign ISObject 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:
      PointPickSensorObject - 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 PointPickSensorObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      PointPickSensorObject - 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 PointPickSensor
      Specified by:
      getIsActive in interface X3DPickSensorNode
      Specified by:
      getIsActive in interface X3DSensorNode
      Returns:
      value of isActive field
    • getMatchCriterion

      public java.lang.String getMatchCriterion()
      Provide String enumeration value ( baseType pickSensorMatchCriterionChoices) ["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 PointPickSensor
      Specified by:
      getMatchCriterion in interface X3DPickSensorNode
      Returns:
      value of matchCriterion field
    • setMatchCriterion

      public PointPickSensorObject setMatchCriterion​(java.lang.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 PointPickSensor
      Specified by:
      setMatchCriterion in interface X3DPickSensorNode
      Parameters:
      newValue - is new value for the matchCriterion field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMatchCriterion

      public PointPickSensorObject setMatchCriterion​(SFStringObject newValue)
      Assign typed object value to SFString matchCriterion field, similar to setMatchCriterion(String).
      Parameters:
      newValue - is new value for the matchCriterion field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface PointPickSensor
      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:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public PointPickSensorObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface PointPickSensor
      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:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

      public PointPickSensorObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public PointPickSensorObject setMetadata​(ProtoInstanceObject 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:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(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 java.lang.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 PointPickSensor
      Specified by:
      getObjectType in interface X3DPickSensorNode
      Returns:
      value of objectType field
    • getObjectTypeList

      public java.util.ArrayList<java.lang.String> getObjectTypeList()
      Utility method to get ArrayList value of MFString objectType field, similar to getObjectType().
      Returns:
      value of objectType field
    • setObjectType

      public PointPickSensorObject setObjectType​(java.lang.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 PointPickSensor
      Specified by:
      setObjectType in interface X3DPickSensorNode
      Parameters:
      newValue - is new value for the objectType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setObjectType

      public PointPickSensorObject setObjectType​(MFStringObject newValue)
      Assign typed object value to MFString objectType field, similar to setObjectType(String[]).
      Parameters:
      newValue - is new value for the objectType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setObjectType

      public PointPickSensorObject setObjectType​(SFStringObject newValue)
      Assign single SFString object value to MFString objectType field, similar to setObjectType(String[]).
      Parameters:
      newValue - is new value for the objectType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setObjectType

      public PointPickSensorObject setObjectType​(java.lang.String newValue)
      Assign singleton String value to MFString objectType field, similar to setObjectType(String[]).
      Parameters:
      newValue - is new value for the objectType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setObjectType

      public PointPickSensorObject setObjectType​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString objectType field, similar to setObjectType(String[]).
      Parameters:
      newValue - is new value for the objectType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearObjectType

      public PointPickSensorObject clearObjectType()
      Utility method to clear MFString value of objectType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addObjectType

      public PointPickSensorObject addObjectType​(java.lang.String newValue)
      Add singleton String value to MFString objectType field.
      Parameters:
      newValue - is new value to add to the objectType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addObjectType

      public PointPickSensorObject addObjectType​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString objectType field.
      Parameters:
      newValue - is new value to add to the objectType field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getPickedGeometry

      public X3DNode[] getPickedGeometry()
      Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 PointPickSensor
      Specified by:
      getPickedGeometry in interface X3DPickSensorNode
      Returns:
      value of pickedGeometry field
      See Also:
      X3DChildNode
    • getPickedGeometryList

      public java.util.ArrayList<X3DNode> getPickedGeometryList()
      Utility method to get ArrayList value of MFNode pickedGeometry field, similar to getPickedGeometry().
      Returns:
      value of pickedGeometry field
    • getPickedPoint

      public float[] getPickedPoint()
      Provide array of 3-tuple float results from outputOnly MFVec3f field named pickedPoint.

      Tooltip: Output event containing 3D points on surface of underlying pickingGeometry computed by the picking intersection computations, 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.
      Specified by:
      getPickedPoint in interface PointPickSensor
      Returns:
      value of pickedPoint field
    • getPickingGeometry

      public X3DGeometryNode getPickingGeometry()
      Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field pickingGeometry.
      Specified by:
      getPickingGeometry in interface PointPickSensor
      Specified by:
      getPickingGeometry in interface X3DPickSensorNode
      Returns:
      value of pickingGeometry field
      See Also:
      Tooltip: [PointSet] pickingGeometry specifies the exact geometry coordinates that are used to perform the intersection testing of the picking operation. *
    • setPickingGeometry

      public PointPickSensorObject setPickingGeometry​(X3DGeometryNode newValue)
      Accessor method to assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field pickingGeometry.
      Specified by:
      setPickingGeometry in interface PointPickSensor
      Specified by:
      setPickingGeometry in interface X3DPickSensorNode
      Parameters:
      newValue - is new value for the pickingGeometry field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [PointSet] pickingGeometry specifies the exact geometry coordinates that are used to perform the intersection testing of the picking operation. *
    • clearPickingGeometry

      public PointPickSensorObject clearPickingGeometry()
      Utility method to clear SFNode value of pickingGeometry field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setPickingGeometry

      public PointPickSensorObject setPickingGeometry​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field pickingGeometry.
      Parameters:
      newValue - is new value for the pickingGeometry field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setPickingGeometry(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 X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DGroupingNode|X3DShapeNode|Inline, from inputOutput MFNode field pickTarget.

      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 PointPickSensor
      Specified by:
      getPickTarget in interface X3DPickSensorNode
      Returns:
      value of pickTarget field
      See Also:
      X3DGroupingNode, X3DShapeNode, InlineObject
    • getPickTargetList

      public java.util.ArrayList<X3DNode> getPickTargetList()
      Utility method to get ArrayList value of MFNode pickTarget field, similar to getPickTarget().
      Returns:
      value of pickTarget field
    • setPickTarget

      public PointPickSensorObject setPickTarget​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field pickTarget. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Grouping.X3DGroupingNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Shape.X3DShapeNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Networking.InlineObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DGroupingNode|X3DShapeNode|Inline; newValue=" + newValue); }

      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 PointPickSensor
      Specified by:
      setPickTarget in interface X3DPickSensorNode
      Parameters:
      newValue - is new value for the pickTarget field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPickTarget

      public PointPickSensorObject setPickTarget​(java.util.ArrayList<X3DNode> newValue)
      Assign ArrayList value of MFNode pickTarget field, similar to setPickTarget(X3DNode[]).
      Parameters:
      newValue - is new value for the pickTarget field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addPickTarget

      public PointPickSensorObject 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:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addPickTarget

      public PointPickSensorObject addPickTarget​(ProtoInstanceObject newValue)
      Add single ProtoInstanceObject (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:
      PointPickSensorObject - 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 PointPickSensor
      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 PointPickSensor
      Specified by:
      setPickTarget in interface X3DPickSensorNode
      Parameters:
      newValue - is new node for the pickTarget field (restricted to X3DGroupingNode|X3DShapeNode|Inline)
    • clearPickTarget

      public PointPickSensorObject clearPickTarget()
      Utility method to clear MFNode value of pickTarget field.
      Returns:
      PointPickSensorObject - 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 java.lang.String getSortOrder()
      Provide String enumeration value ( baseType pickSensorSortOrderValues) ["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 that any single object 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 PointPickSensor
      Specified by:
      getSortOrder in interface X3DPickSensorNode
      Returns:
      value of sortOrder field
    • setSortOrder

      public PointPickSensorObject setSortOrder​(java.lang.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 that any single object 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 PointPickSensor
      Specified by:
      setSortOrder in interface X3DPickSensorNode
      Parameters:
      newValue - is new value for the sortOrder field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSortOrder

      public PointPickSensorObject setSortOrder​(SFStringObject newValue)
      Assign typed object value to SFString sortOrder field, similar to setSortOrder(String).
      Parameters:
      newValue - is new value for the sortOrder field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public java.lang.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.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final PointPickSensorObject setDEF​(java.lang.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.

      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:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public PointPickSensorObject setDEF​(SFStringObject newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public java.lang.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 PointPickSensorObject setUSE​(java.lang.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:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public PointPickSensorObject setUSE​(SFStringObject newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final PointPickSensorObject setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public PointPickSensorObject setCssClass​(SFStringObject newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public PointPickSensorObject setUSE​(PointPickSensorObject 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:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public PointPickSensorObject addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public PointPickSensorObject addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public PointPickSensorObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      PointPickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.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:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.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:
      X3DObject.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 java.lang.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:
      X3DObject.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​(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.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​(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.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 java.lang.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.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)