Class TStringSensorNode

Unit

Declaration

type TStringSensorNode = class(TAbstractKeyDeviceSensorNode)

Description

Generates events as the user inputs a longer string on the keyboard, useful for example to simulate "input fields" in 3D.

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

Hierarchy

Overview

Methods

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

Properties

Public property FdDeletionAllowed: TSFBool read FFdDeletionAllowed;
Public property DeletionAllowed: Boolean read GetDeletionAllowed write SetDeletionAllowed;
Public property EventEnteredText: TSFStringEvent read FEventEnteredText;
Public property EventFinalText: TSFStringEvent read FEventFinalText;

Description

Methods

Public 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 67).

Public procedure CreateNode; override;

Create node fields and events.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_stringsensor.inc (line 31).

Public 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_stringsensor.inc (line 32).

Properties

Public property FdDeletionAllowed: TSFBool read FFdDeletionAllowed;

Internal wrapper for property DeletionAllowed. This wrapper API may change, we advise to access simpler DeletionAllowed instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_stringsensor.inc (line 36).

Public property DeletionAllowed: Boolean read GetDeletionAllowed write SetDeletionAllowed;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_stringsensor.inc (line 38).

Public property EventEnteredText: TSFStringEvent read FEventEnteredText;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_stringsensor.inc (line 42).

Public property EventFinalText: TSFStringEvent read FEventFinalText;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_stringsensor.inc (line 46).


Generated by PasDoc 0.17.0.snapshot.