Interface X3DSensorNode

All Superinterfaces:
X3DChildNode, X3DNode
All Known Subinterfaces:
Collision, CollisionSensor, CylinderSensor, EspduTransform, GeoProximitySensor, GeoTouchSensor, KeySensor, LinePickSensor, LoadSensor, PlaneSensor, PointPickSensor, PrimitivePickSensor, ProximitySensor, ReceiverPdu, SignalPdu, SphereSensor, StringSensor, TimeSensor, TouchSensor, TransformSensor, TransmitterPdu, VisibilitySensor, VolumePickSensor, X3DDragSensorNode, X3DEnvironmentalSensorNode, X3DKeyDeviceSensorNode, X3DNetworkSensorNode, X3DPickSensorNode, X3DPointingDeviceSensorNode, X3DTouchSensorNode
All Known Implementing Classes:
Collision, CollisionSensor, CylinderSensor, EspduTransform, GeoProximitySensor, GeoTouchSensor, KeySensor, LinePickSensor, LoadSensor, PlaneSensor, PointPickSensor, PrimitivePickSensor, ProximitySensor, ReceiverPdu, SignalPdu, SphereSensor, StringSensor, TimeSensor, TouchSensor, TransformSensor, TransmitterPdu, VisibilitySensor, VolumePickSensor
public interface X3DSensorNode extends X3DChildNode
Base type for all sensors.

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.
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
    String
    getDescription()
    Provide String value from inputOutput SFString field named description.
    boolean
    getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    boolean
    getIsActive()
    Provide boolean value from outputOnly SFBool field named isActive.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    X3DSensorNode
    setDescription(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    X3DSensorNode
    setEnabled(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    X3DSensorNode
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

  • Method Details

    • getDescription

      String getDescription()
      Provide String value from inputOutput SFString field named description.
      Returns:
      value of description field

    • setDescription

      X3DSensorNode setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.
      Parameters:
      newValue - is new value for the description field.
      Returns:
      X3DSensorNode - 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.
      Returns:
      value of enabled field

    • setEnabled

      X3DSensorNode setEnabled(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      X3DSensorNode - 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.
      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
      Returns:
      value of metadata field
      See Also:

    • setMetadata

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