Class LinePickSensorObject

    • Field Detail

      • INTERSECTIONTYPE_BOUNDS

        public static final java.lang.String INTERSECTIONTYPE_BOUNDS
        SFString field named intersectionType with X3DUOM baseType intersectionTypeValues can equal this value "BOUNDS" (Java syntax) or BOUNDS (XML syntax).
        See Also:
        intersectionTypeValues, Constant Field Values
      • INTERSECTIONTYPE_GEOMETRY

        public static final java.lang.String INTERSECTIONTYPE_GEOMETRY
        SFString field named intersectionType with X3DUOM baseType intersectionTypeValues can equal this value "GEOMETRY" (Java syntax) or GEOMETRY (XML syntax).
        See Also:
        intersectionTypeValues, Constant Field Values
      • pickSensorMatchCriterionChoices

        public static final java.util.ArrayList<java.lang.String> pickSensorMatchCriterionChoices
        List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.

        Allowed values: "MATCH_ANY", "MATCH_EVERY", "MATCH_ONLY_ONE".

        pickSensorMatchCriterionChoices are strictly allowed enumeration values for X3DPickSensorNode node matchCriterion field. Bounded, no additional values are possible.
        See Also:
        https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/picking.html#X3DPickSensorNode
      • MATCHCRITERION_MATCH_ANY

        public static final java.lang.String MATCHCRITERION_MATCH_ANY
        SFString field named matchCriterion with X3DUOM baseType pickSensorMatchCriterionChoices can equal this value "MATCH_ANY" (Java syntax) or MATCH_ANY (XML syntax).
        See Also:
        pickSensorMatchCriterionChoices, Constant Field Values
      • MATCHCRITERION_MATCH_EVERY

        public static final java.lang.String MATCHCRITERION_MATCH_EVERY
        SFString field named matchCriterion with X3DUOM baseType pickSensorMatchCriterionChoices can equal this value "MATCH_EVERY" (Java syntax) or MATCH_EVERY (XML syntax).
        See Also:
        pickSensorMatchCriterionChoices, Constant Field Values
      • MATCHCRITERION_MATCH_ONLY_ONE

        public static final java.lang.String MATCHCRITERION_MATCH_ONLY_ONE
        SFString field named matchCriterion with X3DUOM baseType pickSensorMatchCriterionChoices can equal this value "MATCH_ONLY_ONE" (Java syntax) or MATCH_ONLY_ONE (XML syntax).
        See Also:
        pickSensorMatchCriterionChoices, Constant Field Values
      • OBJECTTYPE_ALL

        public static final java.lang.String OBJECTTYPE_ALL
        MFString field named objectType with X3DUOM baseType pickableObjectTypeValues is an array that can include this quoted enumeration value (and alternate values) "ALL" (Java syntax) or '"ALL"' (XML syntax).
        See Also:
        pickableObjectTypeValues, Constant Field Values
      • OBJECTTYPE_NONE

        public static final java.lang.String OBJECTTYPE_NONE
        MFString field named objectType with X3DUOM baseType pickableObjectTypeValues is an array that can include this quoted enumeration value (and alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).
        See Also:
        pickableObjectTypeValues, Constant Field Values
      • OBJECTTYPE_TERRAIN

        public static final java.lang.String OBJECTTYPE_TERRAIN
        MFString field named objectType with X3DUOM baseType pickableObjectTypeValues is an array that can include this quoted enumeration value (and alternate values) "TERRAIN" (Java syntax) or '"TERRAIN"' (XML syntax).
        See Also:
        pickableObjectTypeValues, Constant Field Values
      • pickSensorSortOrderValues

        public static final java.util.ArrayList<java.lang.String> pickSensorSortOrderValues
        List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.

        Allowed values: "ANY", "CLOSEST", "ALL", "ALL_SORTED".

        pickSensorSortOrderValues are allowed enumeration values for X3DPickSensorNode node sortOrder field. Unbounded, additional values are possible.
        See Also:
        https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/picking.html#X3DPickSensorNode
      • SORTORDER_ANY

        public static final java.lang.String SORTORDER_ANY
        SFString field named sortOrder with X3DUOM baseType pickSensorSortOrderValues can equal this value "ANY" (Java syntax) or ANY (XML syntax).
        See Also:
        pickSensorSortOrderValues, Constant Field Values
      • SORTORDER_CLOSEST

        public static final java.lang.String SORTORDER_CLOSEST
        SFString field named sortOrder with X3DUOM baseType pickSensorSortOrderValues can equal this value "CLOSEST" (Java syntax) or CLOSEST (XML syntax).
        See Also:
        pickSensorSortOrderValues, Constant Field Values
      • SORTORDER_ALL

        public static final java.lang.String SORTORDER_ALL
        SFString field named sortOrder with X3DUOM baseType pickSensorSortOrderValues can equal this value "ALL" (Java syntax) or ALL (XML syntax).
        See Also:
        pickSensorSortOrderValues, Constant Field Values
      • SORTORDER_ALL_SORTED

        public static final java.lang.String SORTORDER_ALL_SORTED
        SFString field named sortOrder with X3DUOM baseType pickSensorSortOrderValues can equal this value "ALL_SORTED" (Java syntax) or ALL_SORTED (XML syntax).
        See Also:
        pickSensorSortOrderValues, Constant Field Values
      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: LinePickSensor.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the LinePickSensor 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: 1
        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 java.lang.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 ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • MATCHCRITERION_DEFAULT_VALUE

        public static final java.lang.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 java.util.ArrayList<java.lang.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 java.lang.String SORTORDER_DEFAULT_VALUE
        SFString field named sortOrder has default value "CLOSEST" (Java syntax) or CLOSEST (XML syntax).
        See Also:
        Constant Field Values
      • fromField_ENABLED

        public static final java.lang.String fromField_ENABLED
        fromField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • toField_ENABLED

        public static final java.lang.String toField_ENABLED
        toField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_ISACTIVE

        public static final java.lang.String fromField_ISACTIVE
        fromField ROUTE name for SFBool field named isActive.
        See Also:
        Constant Field Values
      • fromField_MATCHCRITERION

        public static final java.lang.String fromField_MATCHCRITERION
        fromField ROUTE name for SFString field named matchCriterion.
        See Also:
        Constant Field Values
      • toField_MATCHCRITERION

        public static final java.lang.String toField_MATCHCRITERION
        toField ROUTE name for SFString field named matchCriterion.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_OBJECTTYPE

        public static final java.lang.String fromField_OBJECTTYPE
        fromField ROUTE name for MFString field named objectType.
        See Also:
        Constant Field Values
      • toField_OBJECTTYPE

        public static final java.lang.String toField_OBJECTTYPE
        toField ROUTE name for MFString field named objectType.
        See Also:
        Constant Field Values
      • fromField_PICKEDGEOMETRY

        public static final java.lang.String fromField_PICKEDGEOMETRY
        fromField ROUTE name for MFNode field named pickedGeometry.
        See Also:
        Constant Field Values
      • fromField_PICKEDNORMAL

        public static final java.lang.String fromField_PICKEDNORMAL
        fromField ROUTE name for MFVec3f field named pickedNormal.
        See Also:
        Constant Field Values
      • fromField_PICKEDPOINT

        public static final java.lang.String fromField_PICKEDPOINT
        fromField ROUTE name for MFVec3f field named pickedPoint.
        See Also:
        Constant Field Values
      • fromField_PICKEDTEXTURECOORDINATE

        public static final java.lang.String fromField_PICKEDTEXTURECOORDINATE
        fromField ROUTE name for MFVec3f field named pickedTextureCoordinate.
        See Also:
        Constant Field Values
      • fromField_PICKINGGEOMETRY

        public static final java.lang.String fromField_PICKINGGEOMETRY
        fromField ROUTE name for SFNode field named pickingGeometry.
        See Also:
        Constant Field Values
      • toField_PICKINGGEOMETRY

        public static final java.lang.String toField_PICKINGGEOMETRY
        toField ROUTE name for SFNode field named pickingGeometry.
        See Also:
        Constant Field Values
      • fromField_PICKTARGET

        public static final java.lang.String fromField_PICKTARGET
        fromField ROUTE name for MFNode field named pickTarget.
        See Also:
        Constant Field Values
      • toField_PICKTARGET

        public static final java.lang.String toField_PICKTARGET
        toField ROUTE name for MFNode field named pickTarget.
        See Also:
        Constant Field Values
    • Constructor Detail

      • LinePickSensorObject

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

        public LinePickSensorObject​(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 Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: LinePickSensor
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the LinePickSensor 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
      • initialize

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

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

        public LinePickSensorObject 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:
        LinePickSensorObject - 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 LinePickSensor
        Specified by:
        getIntersectionType in interface X3DPickSensorNode
        Returns:
        value of intersectionType field
      • setIntersectionType

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

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

        public LinePickSensorObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        LinePickSensorObject - 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 LinePickSensor
        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 LinePickSensor
        Specified by:
        getMatchCriterion in interface X3DPickSensorNode
        Returns:
        value of matchCriterion field
      • setMatchCriterion

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

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

        public LinePickSensorObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        LinePickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 LinePickSensor
        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 LinePickSensorObject 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 LinePickSensor
        Specified by:
        setObjectType in interface X3DPickSensorNode
        Parameters:
        newValue - is new value for the objectType field.
        Returns:
        LinePickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setObjectType

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

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

        public LinePickSensorObject clearObjectType()
        Utility method to clear MFString value of objectType field.
        Returns:
        LinePickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 LinePickSensor
        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
      • getPickedNormal

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

        Tooltip: Output event containing surface normal vectors computed by the picking intersection computations.
        • 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:
        getPickedNormal in interface LinePickSensor
        Returns:
        value of pickedNormal 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 LinePickSensor
        Returns:
        value of pickedPoint field
      • getPickedTextureCoordinate

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

        Tooltip: Output event containing 3D texture coordinates of surfaces computed by the picking intersection computations. Picked texture coordinates are in three dimensions. If the target texture coordinate has two dimensions, the third coordinate (z component of an SFVec3f) shall be zero.
        • Warning: if the target object has multiple textures defined, only texture coordinates for the first texture are returned and all other textures are ignored.
        • 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:
        getPickedTextureCoordinate in interface LinePickSensor
        Returns:
        value of pickedTextureCoordinate field
      • getPickingGeometry

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

        public LinePickSensorObject clearPickingGeometry()
        Utility method to clear SFNode value of pickingGeometry field.
        Returns:
        LinePickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 LinePickSensor
        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 LinePickSensorObject 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 LinePickSensor
        Specified by:
        setPickTarget in interface X3DPickSensorNode
        Parameters:
        newValue - is new value for the pickTarget field.
        Returns:
        LinePickSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setPickTarget

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

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

        public LinePickSensorObject 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:
        LinePickSensorObject - 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 LinePickSensor
        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 LinePickSensor
        Specified by:
        setPickTarget in interface X3DPickSensorNode
        Parameters:
        newValue - is new node for the pickTarget field (restricted to X3DGroupingNode|X3DShapeNode|Inline)
      • clearPickTarget

        public LinePickSensorObject clearPickTarget()
        Utility method to clear MFNode value of pickTarget field.
        Returns:
        LinePickSensorObject - 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 LinePickSensor
        Specified by:
        getSortOrder in interface X3DPickSensorNode
        Returns:
        value of sortOrder field
      • setSortOrder

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

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

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

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

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

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

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

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