KeySensor (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DKeyDeviceSensorNode, X3DNode, X3DSensorNode

All Known Implementing Classes:

KeySensorObject
```
public interface KeySensor
extends X3DKeyDeviceSensorNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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 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: KeySensor, X3D Tooltips: KeySensor, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getActionKeyPress()` Provide int value from outputOnly SFInt32 field named actionKeyPress.
`int`	`getActionKeyRelease()` Provide int value from outputOnly SFInt32 field named actionKeyRelease.
`boolean`	`getAltKey()` Provide boolean value from outputOnly SFBool field named altKey.
`boolean`	`getControlKey()` Provide boolean value from outputOnly SFBool field named controlKey.
`boolean`	`getEnabled()` Provide boolean value from inputOutput SFBool field named enabled.
`boolean`	`getIsActive()` Provide boolean value from outputOnly SFBool field named isActive.
`java.lang.String`	`getKeyPress()` Provide String value from outputOnly SFString field named keyPress.
`java.lang.String`	`getKeyRelease()` Provide String value from outputOnly SFString field named keyRelease.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`boolean`	`getShiftKey()` Provide boolean value from outputOnly SFBool field named shiftKey.
`KeySensor`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`KeySensor`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`KeySensor`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`KeySensor`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`KeySensor`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getActionKeyPress
```
int getActionKeyPress()
```
    Provide int value from outputOnly SFInt32 field named actionKeyPress.
    
    Tooltip: action key press gives following values: HOME=000 END=1001 PGUP=1002 PGDN=1003 UP=1004 DOWN=1005 LEFT=1006 RIGHT=1007 F1..F12 = 1008..1019.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of actionKeyPress field
  - getActionKeyRelease
```
int getActionKeyRelease()
```
    Provide int value from outputOnly SFInt32 field named actionKeyRelease.
    
    Tooltip: action key release gives following values: HOME=000 END=1001 PGUP=1002 PGDN=1003 UP=1004 DOWN=1005 LEFT=1006 RIGHT=1007 F1..F12 = 1008..1019.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of actionKeyRelease field
  - getAltKey
```
boolean getAltKey()
```
    Provide boolean value from outputOnly SFBool field named altKey.
    
    Tooltip: altKey generates true event when pressed, false event when released.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of altKey field
  - getControlKey
```
boolean getControlKey()
```
    Provide boolean value from outputOnly SFBool field named controlKey.
    
    Tooltip: controlKey generates true event when pressed, false event when released.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of controlKey field
  - getEnabled
```
boolean getEnabled()
```
    Provide boolean value from inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation. *
    
    Specified by:
    
    getEnabled in interface X3DKeyDeviceSensorNode
    
    Specified by:
    
    getEnabled in interface X3DSensorNode
    
    Returns:
    
    value of enabled field
  - setEnabled
```
KeySensor setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Specified by:
    
    setEnabled in interface X3DKeyDeviceSensorNode
    
    Specified by:
    
    setEnabled in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    KeySensor - 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.
    
    Tooltip: Select geometry by activating the pointing device (e.g. clicking the mouse) to generate isActive events. Output event isActive=true is sent when geometry is selected (e.g. when primary mouse button is pressed), output event isActive=false is sent when geometry is deselected (e.g. when primary mouse button is released).
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getIsActive in interface X3DKeyDeviceSensorNode
    
    Specified by:
    
    getIsActive in interface X3DSensorNode
    
    Returns:
    
    value of isActive field
  - getKeyPress
```
java.lang.String getKeyPress()
```
    Provide String value from outputOnly SFString field named keyPress.
    
    Tooltip: Events generated when user presses character-producing keys on keyboard produces integer UTF-8 character values.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of keyPress field
  - getKeyRelease
```
java.lang.String getKeyRelease()
```
    Provide String value from outputOnly SFString field named keyRelease.
    
    Tooltip: Events generated when user releases character-producing keys on keyboard produces integer UTF-8 character values.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of keyRelease field
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DKeyDeviceSensorNode
    
    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
```
KeySensor setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DKeyDeviceSensorNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    KeySensor - 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
  - getShiftKey
```
boolean getShiftKey()
```
    Provide boolean value from outputOnly SFBool field named shiftKey.
    
    Tooltip: shiftKey generates true event when pressed, false event when released.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of shiftKey field
  - setDEF
```
KeySensor setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DKeyDeviceSensorNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    KeySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
KeySensor setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DKeyDeviceSensorNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    KeySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
KeySensor setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DKeyDeviceSensorNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    KeySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface KeySensor

Method Summary

Method Detail

getActionKeyPress

getActionKeyRelease

getAltKey

getControlKey

getEnabled

setEnabled

getIsActive

getKeyPress

getKeyRelease

getMetadata

setMetadata

getShiftKey

setDEF

setUSE

setCssClass