Interface KeySensor
- All Superinterfaces:
X3DChildNode
,X3DKeyDeviceSensorNode
,X3DNode
,X3DSensorNode
- All Known Implementing Classes:
KeySensor
public interface KeySensor extends X3DKeyDeviceSensorNode
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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: [X3DKeyDeviceSensorNode] KeySensor generates events as the user presses keys on the keyboard. Browser support includes the notion of "keyboard focus".
- Hint: example scenes and authoring assets at https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter08UserInteractivity
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method 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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.boolean
getShiftKey()
Provide boolean value from outputOnly SFBool field named shiftKey.KeySensor
setEnabled(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named enabled.KeySensor
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
-
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, instead only use it a source for ROUTE events.
- 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, instead only use it a source for ROUTE events.
- 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, instead only use it a source for ROUTE events.
- 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, instead only use it a source for ROUTE events.
- 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 interfaceX3DKeyDeviceSensorNode
- Specified by:
getEnabled
in interfaceX3DSensorNode
- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
setEnabled
in interfaceX3DKeyDeviceSensorNode
- Specified by:
setEnabled
in interfaceX3DSensorNode
- 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, instead only use it a source for ROUTE events.
- Specified by:
getIsActive
in interfaceX3DKeyDeviceSensorNode
- Specified by:
getIsActive
in interfaceX3DSensorNode
- 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, instead only use it a source for ROUTE events.
- 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, instead only use it a source for ROUTE events.
- Returns:
- value of keyRelease 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.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DKeyDeviceSensorNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DSensorNode
- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
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.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DKeyDeviceSensorNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DSensorNode
- 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, instead only use it a source for ROUTE events.
- Returns:
- value of shiftKey field
-