Class KeySensor

All Implemented Interfaces:
X3DChildNode, X3DNode, X3DSensorNode, KeySensor, X3DKeyDeviceSensorNode

public class KeySensor extends X3DConcreteNode implements KeySensor
KeySensor generates events as the user presses keys on the keyboard.

X3D node tooltip: [X3DKeyDeviceSensorNode] KeySensor generates events as the user presses keys on the keyboard. Browser support includes the notion of "keyboard focus".
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: KeySensor, X3D Tooltips: KeySensor, X3D Scene Authoring Hints
  • Field Details

    • NAME

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

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

      public static final int LEVEL
      Integer constant LEVEL provides default X3D KeyDeviceSensor component level for this element: 1
      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).
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • 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_ACTIONKEYPRESS

      public static final String fromField_ACTIONKEYPRESS
      fromField ROUTE name for SFInt32 field named actionKeyPress.
      See Also:
      Constant Field Values
    • fromField_ACTIONKEYRELEASE

      public static final String fromField_ACTIONKEYRELEASE
      fromField ROUTE name for SFInt32 field named actionKeyRelease.
      See Also:
      Constant Field Values
    • fromField_ALTKEY

      public static final String fromField_ALTKEY
      fromField ROUTE name for SFBool field named altKey.
      See Also:
      Constant Field Values
    • fromField_CONTROLKEY

      public static final String fromField_CONTROLKEY
      fromField ROUTE name for SFBool field named controlKey.
      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_KEYPRESS

      public static final String fromField_KEYPRESS
      fromField ROUTE name for SFString field named keyPress.
      See Also:
      Constant Field Values
    • fromField_KEYRELEASE

      public static final String fromField_KEYRELEASE
      fromField ROUTE name for SFString field named keyRelease.
      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_SHIFTKEY

      public static final String fromField_SHIFTKEY
      fromField ROUTE name for SFBool field named shiftKey.
      See Also:
      Constant Field Values
  • Constructor Details

    • KeySensor

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

      public KeySensor(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