Class TKeySensorNode

Description

Hierarchy

Fields

Methods

Properties

Unit

X3DNodes

Declaration

type TKeySensorNode = class(TAbstractKeyDeviceSensorNode)

Description

Generate events when user key presses or releases keys on the keyboard.

Source: src/scene/x3d/x3dnodes_standard_keydevicesensor.inc (line 51).

Hierarchy

Overview

Methods

	`procedure KeyDown(const Key: TKey; const KeyString: String; const Time: TX3DTime); override;`
	`procedure KeyUp(const Key: TKey; const KeyString: String; const Time: TX3DTime); override;`
	`procedure CreateNode; override;`
	`class function ClassX3DType: String; override;`

Properties

	`property EventActionKeyPress: TSFInt32Event read FEventActionKeyPress;`
	`property EventActionKeyRelease: TSFInt32Event read FEventActionKeyRelease;`
	`property EventAltKey: TSFBoolEvent read FEventAltKey;`
	`property EventControlKey: TSFBoolEvent read FEventControlKey;`
	`property EventKeyPress: TSFStringEvent read FEventKeyPress;`
	`property EventKeyRelease: TSFStringEvent read FEventKeyRelease;`
	`property EventShiftKey: TSFBoolEvent read FEventShiftKey;`

Description

Methods

procedure KeyDown(const Key: TKey; const KeyString: String; const Time: TX3DTime); override;

This item has no description. Showing description inherited from TAbstractKeyDeviceSensorNode.KeyDown.

Send key down/up events.

This is used internally by TCastleSceneCore to notify this key sensor that it should generate proper X3D events.

Semantics follow TInputPressRelease behavior for EventType = itKey. This means that

- Key may be keyNone (if not representable as TKey)

- KeyString may be '' (if not representable as String)

- But you cannot have both (Key=keyNone) and (KeyString='') at the same time. At least one of them must contain something useful.

- key presses are affected by the "key repeat" feature of the OS (windowing system actually), so when user holds down a key — we get many key down messages.

- KeyString is a UTF-8 encoded String representation of the key user pressed.

Source: src/scene/x3d/x3dnodes_standard_keydevicesensor.inc (line 55).

procedure KeyUp(const Key: TKey; const KeyString: String; const Time: TX3DTime); override;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_keydevicesensor.inc (line 56).

procedure CreateNode; override;

Create node fields and events.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_keysensor.inc (line 28).

class function ClassX3DType: String; override;

This item has no description. Showing description inherited from TX3DNode.ClassX3DType.

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_keysensor.inc (line 29).