Interface X3DEnvironmentalSensorNode

All Superinterfaces:
X3DChildNode, X3DNode, X3DSensorNode
All Known Subinterfaces:
GeoProximitySensor, ProximitySensor, TransformSensor, VisibilitySensor
All Known Implementing Classes:
GeoProximitySensor, ProximitySensor, TransformSensor, VisibilitySensor

public interface X3DEnvironmentalSensorNode extends X3DSensorNode
Base type for the environmental sensor nodes ProximitySensor, TransformSensor and VisibilitySensor.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    Provide String value from inputOutput SFString field named description.
    boolean
    Provide boolean value from inputOutput SFBool field named enabled.
    boolean
    Provide boolean value from outputOnly SFBool field named isActive.
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[]
    Provide array of 3-tuple float results within allowed range of [0,infinity) from inputOutput SFVec3f field named size.
    Accessor method to assign String value to inputOutput SFString field named description.
    setEnabled(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    setSize(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named size.
  • Method Details

    • getDescription

      String getDescription()
      Provide String value from inputOutput SFString field named description.
      Specified by:
      getDescription in interface X3DSensorNode
      Returns:
      value of description field
    • setDescription

      X3DEnvironmentalSensorNode setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.
      Specified by:
      setDescription in interface X3DSensorNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      X3DEnvironmentalSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getEnabled

      boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.
      Specified by:
      getEnabled in interface X3DSensorNode
      Returns:
      value of enabled field
    • setEnabled

      X3DEnvironmentalSensorNode setEnabled(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.
      Specified by:
      setEnabled in interface X3DSensorNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      X3DEnvironmentalSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIsActive

      boolean getIsActive()
      Provide boolean value from outputOnly SFBool field named isActive.
      Specified by:
      getIsActive in interface X3DSensorNode
      Returns:
      value of isActive field
    • getMetadata

      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 X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSensorNode
      Returns:
      value of metadata field
      See Also:
    • setMetadata

      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 X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSensorNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      X3DEnvironmentalSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • getSize

      float[] getSize()
      Provide array of 3-tuple float results within allowed range of [0,infinity) from inputOutput SFVec3f field named size.
      Returns:
      value of size field
    • setSize

      X3DEnvironmentalSensorNode setSize(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named size.
      Parameters:
      newValue - is new value for the size field.
      Returns:
      X3DEnvironmentalSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).