Interface VisibilitySensor

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

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. VisibilitySensor 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:

  • Method Summary

    Modifier and Type
    Method
    Description
    float[]
    getCenter()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
    String
    getDescription()
    Provide String value from inputOutput SFString field named description.
    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 org.web3d.x3d.sai.Core.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 inputOutput SFVec3f field named size.
    VisibilitySensor
    setCenter(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.
    VisibilitySensor
    setDescription(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    VisibilitySensor
    setEnabled(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    VisibilitySensor
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.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 inputOutput 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).

    • getDescription

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

      Tooltip: Author-provided prose that describes intended purpose of the node.
      • 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 X3DEnvironmentalSensorNode
      Specified by:
      getDescription in interface X3DSensorNode
      Returns:
      value of description field

    • setDescription

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

      Tooltip: Author-provided prose that describes intended purpose of the node.
      • 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 X3DEnvironmentalSensorNode
      Specified by:
      setDescription in interface X3DSensorNode
      Parameters:
      newValue - is new value for the description 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 org.web3d.x3d.sai.Core.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:

    • setMetadata

      VisibilitySensor setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.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:

    • getSize

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

      Tooltip: [0,+infinity) size of visibility box around center location, oriented within local transformation frame. *
      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 inputOutput SFVec3f field named size.

      Tooltip: [0,+infinity) size of visibility box around center location, oriented within local transformation frame. *
      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).