Namespace: InkInput
InkInput
Classes
Interfaces
Type Definitions
Pointer
Input pointer definition
Properties:
| Name | Type | Description |
|---|---|---|
id | int | A unique identifier for the pointer causing the event |
type | string | Pointer type - mouse, touch or pen |
button | int | The button number that was pressed (if applicable) when the mouse event was fired. |
buttons | int | The buttons being depressed (if any) when the mouse event was fired. |
provider | InkInput.InkInputProvider.Type | Pointer type representation |
SensorPoint
Point input definition
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
x | float | Pointer x coordinate | |
y | float | Pointer y coordinate | |
z | float | <optional> | Pointer z coordinate |
timestamp | long | Time when is gathered event | |
pressure | float | <optional> | The normalized pressure of the pointer input in the range of 0 to 1, where 0 and 1 represent the minimum and maximum pressure the hardware is capable of detecting, respectively |
force | float | <optional> | Pressure alias |
radiusX | float | <optional> | Touch radius - x radius of the ellipse that most closely circumscribes the area of contact with the screen. The value is in pixels of the same scale as screenX. |
radiusY | float | <optional> | Touch radius - y radius of the ellipse that most closely circumscribes the area of contact with the screen. The value is in pixels of the same scale as screenY. |
tiltX | float | <optional> | The plane angle (in degrees, in the range of 0 to 2 * Pi) between the Y-Z plane and the plane containing both the transducer (e.g. pen stylus) axis and the Y axis |
tiltY | float | <optional> | The plane angle (in degrees, in the range of 0 to 2 * Pi) between the X-Z plane and the plane containing both the transducer (e.g. pen stylus) axis and the X axis |
rotation | float | <optional> | Value representing the amount of twist, in radians, applied to the transducer (pointer). The value is in the range 0 to 2 * Pi, inclusive.For devices that do not report twist, the value is 0. |
phase | PathBuilding.Pipeline.Phase | Event phase representation | |
pointer | InkInput.Pointer | Describes where this data comes from | |
provider | InkInput.InkInputProvider.Type | Ink input provider type | |
predicted | Array.<SensorPoint> | <optional> | Prediction points provided from input provider, available for pen input only. |
coalesced | Array.<SensorPoint> | <optional> | Coalesced points provided from input provider, available for pen input only. |
SensorPointProps
Sensor point initial props
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
pointerID | int | Pointer identifier | |
x | float | Initial pointer x coordinate | |
y | float | Initial pointer y coordinate | |
z | float | <optional> | Initial pointer z coordinate |