Package org.web3d.x3d.sai.EnvironmentalSensor

Interface VisibilitySensor

All Superinterfaces:
X3DChildNode, X3DEnvironmentalSensorNode, X3DNode, X3DSensorNode
All Known Implementing Classes:
VisibilitySensorObject
public interface VisibilitySensor
extends X3DEnvironmentalSensorNode
VisibilitySensor detects when user can see a specific object or region as they navigate the world.

X3D node tooltip: [X3DEnvironmentalSensorNode] VisibilitySensor detects when user can see a specific object or region as they navigate the world. The region sensed for visibility to the user is bounded by a rectangular box.
  • Hint: often used to attract user attention or improve performance.
  • Hint: this sensor detects user interactions affecting peer nodes and their child geometry.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: VisibilitySensor, X3D Tooltips: VisibilitySensor, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    float[] getCenter()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
    boolean getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    double getEnterTime()
    Provide double value in seconds from outputOnly SFTime field named enterTime.
    double getExitTime()
    Provide double value in seconds from outputOnly SFTime field named exitTime.
    boolean getIsActive()
    Provide boolean value from outputOnly SFBool field named isActive.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[] getSize()
    Provide array of 3-tuple float results within allowed range of [0,infinity) from initializeOnly SFVec3f field named size.
    VisibilitySensor setCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.
    VisibilitySensor setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    VisibilitySensor setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    VisibilitySensor setSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named size.

  • Method Details

    • getCenter

      float[] getCenter()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named center.

      Tooltip: Translation offset from origin of local coordinate system. *
      Returns:
      value of center field

    • setCenter

      VisibilitySensor setCenter​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.

      Tooltip: Translation offset from origin of local coordinate system. *
      Parameters:
      newValue - is new value for the center field.
      Returns:
      VisibilitySensor - 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.

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

    • setEnabled

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

    • getEnterTime

      double getEnterTime()
      Provide double value in seconds from outputOnly SFTime field named enterTime.

      Tooltip: Time event generated when user's camera enters visibility region for sensor.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Returns:
      value of enterTime field

    • getExitTime

      double getExitTime()
      Provide double value in seconds from outputOnly SFTime field named exitTime.

      Tooltip: Time event generated when user's camera exits visibility region for sensor.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Returns:
      value of exitTime field

    • getIsActive

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

      Tooltip: isActive true/false events are sent when triggering the sensor. isActive=true when entering visibility region, isActive=false when exiting visibility region.
      • 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 X3DEnvironmentalSensorNode
      Specified by:
      getIsActive in interface X3DSensorNode
      Returns:
      value of isActive field

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DEnvironmentalSensorNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSensorNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      VisibilitySensor setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DEnvironmentalSensorNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSensorNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      VisibilitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • getSize

      float[] getSize()
      Provide array of 3-tuple float results within allowed range of [0,infinity) from initializeOnly SFVec3f field named size.

      Tooltip: [0,+infinity) size of visibility box, measured from center in meters. *
      Specified by:
      getSize in interface X3DEnvironmentalSensorNode
      Returns:
      value of size field

    • setSize

      VisibilitySensor setSize​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named size.

      Tooltip: [0,+infinity) size of visibility box, measured from center in meters. *
      Specified by:
      setSize in interface X3DEnvironmentalSensorNode
      Parameters:
      newValue - is new value for the size field.
      Returns:
      VisibilitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).