Class CylinderSensor

All Implemented Interfaces:
X3DChildNode, X3DNode, X3DSensorNode, CylinderSensor, X3DDragSensorNode, X3DPointingDeviceSensorNode

public class CylinderSensor extends X3DConcreteNode implements CylinderSensor
CylinderSensor converts pointer motion (for example, a mouse or wand) into rotation values using an invisible cylinder aligned with local Y-axis.

X3D node tooltip: [X3DDragSensorNode] CylinderSensor converts pointer motion (for example, a mouse or wand) into rotation values using an invisible cylinder aligned with local Y-axis.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: CylinderSensor, X3D Tooltips: CylinderSensor, X3D Scene Authoring Hints
  • Field Details

    • NAME

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

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the CylinderSensor element: PointingDeviceSensor
      See Also:
      Constant Field Values
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D PointingDeviceSensor component level for this element: 1
      See Also:
      Constant Field Values
    • 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:
      Constant Field Values
    • AXISROTATION_DEFAULT_VALUE

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

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

      public static final float DISKANGLE_DEFAULT_VALUE
      SFFloat field named diskAngle has default value 0.26179167f (Java syntax) or 0.26179167 (XML syntax).
      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
    • IS_DEFAULT_VALUE

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

      public static final float MAXANGLE_DEFAULT_VALUE
      SFFloat field named maxAngle has default value -1f (Java syntax) or -1 (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).
    • MINANGLE_DEFAULT_VALUE

      public static final float MINANGLE_DEFAULT_VALUE
      SFFloat field named minAngle has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • OFFSET_DEFAULT_VALUE

      public static final float OFFSET_DEFAULT_VALUE
      SFFloat field named offset has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
    • fromField_AUTOOFFSET

      public static final String fromField_AUTOOFFSET
      fromField ROUTE name for SFBool field named autoOffset.
      See Also:
      Constant Field Values
    • toField_AUTOOFFSET

      public static final String toField_AUTOOFFSET
      toField ROUTE name for SFBool field named autoOffset.
      See Also:
      Constant Field Values
    • fromField_AXISROTATION

      public static final String fromField_AXISROTATION
      fromField ROUTE name for SFRotation field named axisRotation.
      See Also:
      Constant Field Values
    • toField_AXISROTATION

      public static final String toField_AXISROTATION
      toField ROUTE name for SFRotation field named axisRotation.
      See Also:
      Constant Field Values
    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:
      Constant Field Values
    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:
      Constant Field Values
    • fromField_DISKANGLE

      public static final String fromField_DISKANGLE
      fromField ROUTE name for SFFloat field named diskAngle.
      See Also:
      Constant Field Values
    • toField_DISKANGLE

      public static final String toField_DISKANGLE
      toField ROUTE name for SFFloat field named diskAngle.
      See Also:
      Constant Field Values
    • fromField_ENABLED

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

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

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

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

      public static final String fromField_ISOVER
      fromField ROUTE name for SFBool field named isOver.
      See Also:
      Constant Field Values
    • fromField_MAXANGLE

      public static final String fromField_MAXANGLE
      fromField ROUTE name for SFFloat field named maxAngle.
      See Also:
      Constant Field Values
    • toField_MAXANGLE

      public static final String toField_MAXANGLE
      toField ROUTE name for SFFloat field named maxAngle.
      See Also:
      Constant Field Values
    • fromField_METADATA

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

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

      public static final String fromField_MINANGLE
      fromField ROUTE name for SFFloat field named minAngle.
      See Also:
      Constant Field Values
    • toField_MINANGLE

      public static final String toField_MINANGLE
      toField ROUTE name for SFFloat field named minAngle.
      See Also:
      Constant Field Values
    • fromField_OFFSET

      public static final String fromField_OFFSET
      fromField ROUTE name for SFFloat field named offset.
      See Also:
      Constant Field Values
    • toField_OFFSET

      public static final String toField_OFFSET
      toField ROUTE name for SFFloat field named offset.
      See Also:
      Constant Field Values
    • fromField_ROTATION_CHANGED

      public static final String fromField_ROTATION_CHANGED
      fromField ROUTE name for SFRotation field named rotation_changed.
      See Also:
      Constant Field Values
    • fromField_TRACKPOINT_CHANGED

      public static final String fromField_TRACKPOINT_CHANGED
      fromField ROUTE name for SFVec3f field named trackPoint_changed.
      See Also:
      Constant Field Values
  • Constructor Details

    • CylinderSensor

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

      public CylinderSensor(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: CylinderSensor
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final String getComponent()
      Defines X3D component for the CylinderSensor 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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

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

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • 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 CylinderSensor
      Specified by:
      getAutoOffset in interface X3DDragSensorNode
      Returns:
      value of autoOffset field
    • setAutoOffset

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

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

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

      Tooltip: axisRotation determines local sensor coordinate system by rotating the local coordinate system. *
      Specified by:
      getAxisRotation in interface CylinderSensor
      Returns:
      value of axisRotation field
    • setAxisRotation

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

      Tooltip: axisRotation determines local sensor coordinate system by rotating the local coordinate system. *
      Specified by:
      setAxisRotation in interface CylinderSensor
      Parameters:
      newValue - is new value for the axisRotation field.
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxisRotation

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

      public CylinderSensor setAxisRotation(float x, float y, float z, float angleRadians)
      Assign values to SFRotation axisRotation field, similar to setAxisRotation(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:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxisRotation

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

      public CylinderSensor setAxisRotation(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAxisRotation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      CylinderSensor - 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 & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      getDescription in interface CylinderSensor
      Specified by:
      getDescription in interface X3DDragSensorNode
      Specified by:
      getDescription in interface X3DPointingDeviceSensorNode
      Returns:
      value of description field
    • setDescription

      public CylinderSensor 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 & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      setDescription in interface CylinderSensor
      Specified by:
      setDescription in interface X3DDragSensorNode
      Specified by:
      setDescription in interface X3DPointingDeviceSensorNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDescription

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

      public float getDiskAngle()
      Provide float value unit axis, angle (in radians) within allowed range of [0,1.5708] from inputOutput SFFloat field named diskAngle.

      Tooltip: Help decide rotation behavior from initial relative bearing of pointer drag: acute angle whether cylinder sides or end-cap disks of virtual-geometry sensor are used for manipulation.
      • Hint: diskAngle 0 forces disk-like behavior, diskAngle 1.570796 (90 degrees) forces cylinder-like behavior.
      Specified by:
      getDiskAngle in interface CylinderSensor
      Returns:
      value of diskAngle field
    • setDiskAngle

      public CylinderSensor setDiskAngle(float newValue)
      Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named diskAngle.

      Tooltip: Help decide rotation behavior from initial relative bearing of pointer drag: acute angle whether cylinder sides or end-cap disks of virtual-geometry sensor are used for manipulation.
      • Hint: diskAngle 0 forces disk-like behavior, diskAngle 1.570796 (90 degrees) forces cylinder-like behavior.
      Specified by:
      setDiskAngle in interface CylinderSensor
      Parameters:
      newValue - is new value for the diskAngle field.
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDiskAngle

      public CylinderSensor setDiskAngle(SFFloat newValue)
      Assign typed object value to SFFloat diskAngle field, similar to setDiskAngle(float).
      Parameters:
      newValue - is new value for the diskAngle field.
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDiskAngle

      public CylinderSensor setDiskAngle(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setDiskAngle(float).
      Parameters:
      newValue - is new value for field
      Returns:
      CylinderSensor - 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 CylinderSensor
      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 CylinderSensor 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 CylinderSensor
      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:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEnabled

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

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

      public CylinderSensor 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:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public CylinderSensor clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      CylinderSensor - 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: 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 CylinderSensor
      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 CylinderSensor
      Specified by:
      getIsOver in interface X3DDragSensorNode
      Specified by:
      getIsOver in interface X3DPointingDeviceSensorNode
      Returns:
      value of isOver field
    • getMaxAngle

      public float getMaxAngle()
      Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from inputOutput SFFloat field named maxAngle.

      Tooltip: clamps rotation_changed events within range of min/max values
      Specified by:
      getMaxAngle in interface CylinderSensor
      Returns:
      value of maxAngle field
    • setMaxAngle

      public CylinderSensor setMaxAngle(float newValue)
      Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named maxAngle.

      Tooltip: clamps rotation_changed events within range of min/max values
      Specified by:
      setMaxAngle in interface CylinderSensor
      Parameters:
      newValue - is new value for the maxAngle field.
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMaxAngle

      public CylinderSensor setMaxAngle(SFFloat newValue)
      Assign typed object value to SFFloat maxAngle field, similar to setMaxAngle(float).
      Parameters:
      newValue - is new value for the maxAngle field.
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMaxAngle

      public CylinderSensor setMaxAngle(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxAngle(float).
      Parameters:
      newValue - is new value for field
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface CylinderSensor
      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 https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public CylinderSensor 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 CylinderSensor
      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:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public CylinderSensor 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:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getMinAngle

      public float getMinAngle()
      Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from inputOutput SFFloat field named minAngle.

      Tooltip: clamps rotation_changed events within range of min/max values
      Specified by:
      getMinAngle in interface CylinderSensor
      Returns:
      value of minAngle field
    • setMinAngle

      public CylinderSensor setMinAngle(float newValue)
      Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named minAngle.

      Tooltip: clamps rotation_changed events within range of min/max values
      Specified by:
      setMinAngle in interface CylinderSensor
      Parameters:
      newValue - is new value for the minAngle field.
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMinAngle

      public CylinderSensor setMinAngle(SFFloat newValue)
      Assign typed object value to SFFloat minAngle field, similar to setMinAngle(float).
      Parameters:
      newValue - is new value for the minAngle field.
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMinAngle

      public CylinderSensor setMinAngle(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinAngle(float).
      Parameters:
      newValue - is new value for field
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getOffset

      public float getOffset()
      Provide float value from inputOutput SFFloat 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 CylinderSensor
      Returns:
      value of offset field
    • setOffset

      public CylinderSensor setOffset(float newValue)
      Accessor method to assign float value to inputOutput SFFloat 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 CylinderSensor
      Parameters:
      newValue - is new value for the offset field.
      Returns:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOffset

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

      public CylinderSensor setOffset(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setOffset(float).
      Parameters:
      newValue - is new value for field
      Returns:
      CylinderSensor - 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 about Y-axis in 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:
      getRotation in interface CylinderSensor
      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 CylinderSensor
      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.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

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

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

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

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

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

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

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

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:
      X3D Architecture Annex L - HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

      public final CylinderSensor 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:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L - HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

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

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:
      X3D Architecture Annex L - HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
    • setHtmlID

      public final CylinderSensor 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:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
      Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references., X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation, HTML 5.2 W3C Recommendation, Document Object Model (DOM) Technical Reports, Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
    • setHtmlID

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

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:
      X3D Architecture Annex L - HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

      public final CylinderSensor 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:
      CylinderSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L - HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

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

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

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

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

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

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

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

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

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

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

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

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

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

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

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

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

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

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