Package org.web3d.x3d.jsail.PointingDeviceSensor

Class SphereSensor

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.PointingDeviceSensor.SphereSensor
All Implemented Interfaces:
X3DChildNode, X3DNode, X3DSensorNode, SphereSensor, X3DDragSensorNode, X3DPointingDeviceSensorNode
public class SphereSensor extends X3DConcreteNode implements SphereSensor
SphereSensor converts pointing device motion into a spherical rotation about the origin of the local coordinate system.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. X3D node tooltip: [X3DDragSensorNode] SphereSensor converts pointing device motion into a spherical rotation about the origin of the local coordinate system. Hint: this sensor detects user interactions affecting peer nodes and their child geometry. Hint: add semi-transparent surrounding geometry to see the effect of the sensor. Hint: X3D Architecture 20.2.1 Overview of pointing device sensors <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/pointingDeviceSensor.html#OverviewOfPointingDeviceSensors" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/pointingDeviceSensor.html#OverviewOfPointingDeviceSensors</a> Hint: X3D Architecture 20.2.2 Drag sensors <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/pointingDeviceSensor.html#DragSensors" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/pointingDeviceSensor.html#DragSensors</a> Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/pointingDeviceSensor.html#Activatingandmanipulating" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/pointingDeviceSensor.html#Activatingandmanipulating</a> *


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:

  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: SphereSensor.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the SphereSensor element: PointingDeviceSensor
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D PointingDeviceSensor component level for this element: 1
      See Also:

    • AUTOOFFSET_DEFAULT_VALUE

      public static final boolean AUTOOFFSET_DEFAULT_VALUE
      SFBool field named autoOffset has default value true (Java syntax) or true (XML syntax).
      See Also:

    • DESCRIPTION_DEFAULT_VALUE

      public static final String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:

    • 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:

    • IS_DEFAULT_VALUE

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

    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

    • OFFSET_DEFAULT_VALUE

      public static final float[] OFFSET_DEFAULT_VALUE
      SFRotation field named offset has default value {0f,1f,0f,0f} (Java syntax) or 0 1 0 0 (XML syntax).

    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:

    • fromField_AUTOOFFSET

      public static final String fromField_AUTOOFFSET
      fromField ROUTE name for SFBool field named autoOffset.
      See Also:

    • toField_AUTOOFFSET

      public static final String toField_AUTOOFFSET
      toField ROUTE name for SFBool field named autoOffset.
      See Also:

    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:

    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:

    • fromField_ENABLED

      public static final String fromField_ENABLED
      fromField ROUTE name for SFBool field named enabled.
      See Also:

    • toField_ENABLED

      public static final String toField_ENABLED
      toField ROUTE name for SFBool field named enabled.
      See Also:

    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:

    • fromField_ISACTIVE

      public static final String fromField_ISACTIVE
      fromField ROUTE name for SFBool field named isActive.
      See Also:

    • fromField_ISOVER

      public static final String fromField_ISOVER
      fromField ROUTE name for SFBool field named isOver.
      See Also:

    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:

    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:

    • fromField_OFFSET

      public static final String fromField_OFFSET
      fromField ROUTE name for SFRotation field named offset.
      See Also:

    • toField_OFFSET

      public static final String toField_OFFSET
      toField ROUTE name for SFRotation field named offset.
      See Also:

    • fromField_ROTATION_CHANGED

      public static final String fromField_ROTATION_CHANGED
      fromField ROUTE name for SFRotation field named rotation_changed.
      See Also:

    • fromField_TRACKPOINT_CHANGED

      public static final String fromField_TRACKPOINT_CHANGED
      fromField ROUTE name for SFVec3f field named trackPoint_changed.
      See Also:

  • Constructor Details

    • SphereSensor

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

    • SphereSensor

      public SphereSensor(String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node

  • Method Details

    • getElementName

      public final String getElementName()
      Provides name of this element: SphereSensor
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the SphereSensor element: PointingDeviceSensor
      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 String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:

    • getAccessType

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:

    • getContainerFieldDefault

      public final 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:

    • initialize

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

    • getAutoOffset

      public boolean getAutoOffset()
      Provide boolean value from inputOutput SFBool field named autoOffset.

      Tooltip: Determines whether previous offset values are remembered/accumulated. *
      Specified by:
      getAutoOffset in interface SphereSensor
      Specified by:
      getAutoOffset in interface X3DDragSensorNode
      Returns:
      value of autoOffset field

    • setAutoOffset

      public SphereSensor setAutoOffset(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named autoOffset.

      Tooltip: Determines whether previous offset values are remembered/accumulated. *
      Specified by:
      setAutoOffset in interface SphereSensor
      Specified by:
      setAutoOffset in interface X3DDragSensorNode
      Parameters:
      newValue - is new value for the autoOffset field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setAutoOffset

      public SphereSensor setAutoOffset(SFBool newValue)
      Assign typed object value to SFBool autoOffset field, similar to setAutoOffset(boolean).
      Parameters:
      newValue - is new value for the autoOffset field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

      public String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of this node. Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable. Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character). *
      Specified by:
      getDescription in interface SphereSensor
      Specified by:
      getDescription in interface X3DDragSensorNode
      Specified by:
      getDescription in interface X3DPointingDeviceSensorNode
      Specified by:
      getDescription in interface X3DSensorNode
      Returns:
      value of description field

    • setDescription

      public SphereSensor setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of this node. Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable. Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character). *
      Specified by:
      setDescription in interface SphereSensor
      Specified by:
      setDescription in interface X3DDragSensorNode
      Specified by:
      setDescription in interface X3DPointingDeviceSensorNode
      Specified by:
      setDescription in interface X3DSensorNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDescription

      public SphereSensor setDescription(SFString newValue)
      Assign typed object value to SFString description field, similar to setDescription(String).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getEnabled

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

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface SphereSensor
      Specified by:
      getEnabled in interface X3DDragSensorNode
      Specified by:
      getEnabled in interface X3DPointingDeviceSensorNode
      Specified by:
      getEnabled in interface X3DSensorNode
      Returns:
      value of enabled field

    • setEnabled

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

    • setEnabled

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

    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:

    • setIS

      public SphereSensor setIS(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearIS

      public SphereSensor clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      SphereSensor - 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:

    • getIsActive

      public boolean getIsActive()
      Provide boolean value from outputOnly SFBool field named isActive.

      Tooltip: Select geometry by activating the pointing device (for example, clicking the mouse) to generate isActive events. Output event isActive=true is sent when geometry is selected (for example, when primary mouse button is pressed), output event isActive=false is sent when geometry is deselected (for example, when primary mouse button is released). 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 SphereSensor
      Specified by:
      getIsActive in interface X3DDragSensorNode
      Specified by:
      getIsActive in interface X3DPointingDeviceSensorNode
      Specified by:
      getIsActive in interface X3DSensorNode
      Returns:
      value of isActive field

    • getIsOver

      public boolean getIsOver()
      Provide boolean value from outputOnly SFBool field named isOver.

      Tooltip: Hover over geometry by aiming the mouse (or pointing device) to generate isOver events. Sensor sends output event isOver=true event when pointing device moves over sensor's geometry, and later sends output event isOver=false event when pointing device moves off. 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:
      getIsOver in interface SphereSensor
      Specified by:
      getIsOver in interface X3DDragSensorNode
      Specified by:
      getIsOver in interface X3DPointingDeviceSensorNode
      Returns:
      value of isOver field

    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface SphereSensor
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DDragSensorNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DPointingDeviceSensorNode
      Specified by:
      getMetadata in interface X3DSensorNode
      Returns:
      value of metadata field
      See Also:


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

    • setMetadata

      public SphereSensor setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface SphereSensor
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DDragSensorNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DPointingDeviceSensorNode
      Specified by:
      setMetadata in interface X3DSensorNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearMetadata

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

    • setMetadata

      public SphereSensor setMetadata(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • 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:

    • getOffset

      public float[] getOffset()
      Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named offset.

      Tooltip: Sends event and remembers last value sensed. Warning: ROUTE connecting rotation_changed to set_offset creates a self-reinforcing positive feedback loop and results in unmanageable response. *
      Specified by:
      getOffset in interface SphereSensor
      Returns:
      value of offset field

    • setOffset

      public SphereSensor setOffset(float[] newValue)
      Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named offset.

      Tooltip: Sends event and remembers last value sensed. Warning: ROUTE connecting rotation_changed to set_offset creates a self-reinforcing positive feedback loop and results in unmanageable response. *
      Specified by:
      setOffset in interface SphereSensor
      Parameters:
      newValue - is new value for the offset field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setOffset

      public SphereSensor setOffset(SFRotation newValue)
      Assign typed object value to SFRotation offset field, similar to setOffset(float[]).
      Parameters:
      newValue - is new value for the offset field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setOffset

      public SphereSensor setOffset(float x, float y, float z, float angleRadians)
      Assign values to SFRotation offset field, similar to setOffset(float[]).
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setOffset

      public SphereSensor setOffset(double x, double y, double z, double angleRadians)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setOffset(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      angleRadians - fourth component
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setOffset

      public SphereSensor setOffset(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOffset(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getRotation

      public float[] getRotation()
      Provide array of 4-tuple float results unit axis, angle (in radians) from outputOnly SFRotation field named rotation_changed.

      Tooltip: rotation_changed events equal sum of relative bearing changes plus offset value. 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:
      getRotation in interface SphereSensor
      Returns:
      value of rotation_changed field

    • getTrackPoint

      public float[] getTrackPoint()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named trackPoint_changed.

      Tooltip: trackPoint_changed events give intersection point of bearing with sensor's virtual geometry. 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: trackPoint_changed events represent unclamped intersection points on plane surface. Browsers can interpret drags off of the surface in various ways. Note that translation_changed events are clamped by minPosition/maxPosition and thus may be preferable. *
      Specified by:
      getTrackPoint in interface SphereSensor
      Specified by:
      getTrackPoint in interface X3DDragSensorNode
      Returns:
      value of trackPoint_changed field

    • getDEF

      public String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:

    • setDEF

      public final SphereSensor setDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


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

    • setDEF

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

    • getUSE

      public String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene. *
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:

    • setUSE

      public final SphereSensor setUSE(String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene. *


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

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

    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

      public final SphereSensor setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssClass

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

    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:

    • setHtmlID

      public final SphereSensor setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlID in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setHtmlID

      public SphereSensor setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
      Parameters:
      newValue - is new value for the id field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:

    • setCssStyle

      public final SphereSensor setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssStyle

      public SphereSensor setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
      Parameters:
      newValue - is new value for the style field.
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

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

    • addComments

      public SphereSensor addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      SphereSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addComments

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

    • addComments

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

    • toStringX3D

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:

    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:

    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:

    • findElementByNameValue

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

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

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:

    • findElementByNameValue

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

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

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:

    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

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

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:

    • hasNodeByDEF

      public boolean hasNodeByDEF(String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:

    • validate

      public String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)