Navigation
API > API/Plugins > API/Plugins/StylusInput
Flags denoting the properties supported by a tablet.
| Name | UE::StylusInput::ETabletSupportedProperties |
| Type | enum |
| Header File | /Engine/Plugins/Editor/StylusInput/Source/StylusInput/Public/StylusInputTabletContext.h |
| Include Path | #include "StylusInputTabletContext.h" |
Syntax
namespace UE
{
namespace StylusInput
{
enum ETabletSupportedProperties
{
None = 0,
X = 1 << 0,
Y = 1 << 1,
Z = 1 << 2,
PacketStatus = 1 << 3,
TimerTick = 1 << 4,
SerialNumber = 1 << 5,
NormalPressure = 1 << 6,
TangentPressure = 1 << 7,
ButtonPressure = 1 << 8,
XTiltOrientation = 1 << 9,
YTiltOrientation = 1 << 10,
AzimuthOrientation = 1 << 11,
AltitudeOrientation = 1 << 12,
TwistOrientation = 1 << 13,
PitchRotation = 1 << 14,
RollRotation = 1 << 15,
YawRotation = 1 << 16,
Width = 1 << 17,
Height = 1 << 18,
FingerContactConfidence = 1 << 19,
DeviceContactID = 1 << 20,
}
}
}
Values
| Name | Remarks |
|---|---|
| None | |
| X | The x-coordinate in the coordinate space of the window that was used to create the stylus input instance. Each packet contains this property by default. |
| Y | The y-coordinate in the coordinate space of the window that was used to create the stylus input instance. Each packet contains this property by default. |
| Z | The z-coordinate or distance of the pen tip from the tablet surface. The TabletPropertyMetricUnit enumeration type determines the unit of measurement for this property. |
| PacketStatus | Contains one or more of the following flag values: The cursor is touching the drawing surface (Value = 1). The cursor is inverted. For example, the eraser end of the pen is pointing toward the surface (Value = 2). Not used (Value = 4). The barrel button is pressed (Value = 8). |
| TimerTick | The time the packet was generated in milliseconds since system start. |
| SerialNumber | The packet property for identifying the packet. This is the same value you use to retrieve the packet from the packet queue. |
| NormalPressure | The pressure of the pen tip perpendicular to the tablet surface. The greater the pressure on the pen tip, the more ink that is drawn. |
| TangentPressure | The pressure of the pen tip along the plane of the tablet surface. |
| ButtonPressure | The pressure on a pressure sensitive button. |
| XTiltOrientation | The angle between the y,z-plane and the pen and y-axis plane. Applies to a pen cursor. The value is 0 when the pen is perpendicular to the drawing surface and is positive when the pen is to the right of perpendicular. |
| YTiltOrientation | The angle between the x,z-plane and the pen and x-axis plane. Applies to a pen cursor. The value is 0 when the pen is perpendicular to the drawing surface and is positive when the pen is upward or away from the user. |
| AzimuthOrientation | The clockwise rotation of the cursor about the z-axis through a full circular range. |
| AltitudeOrientation | The angle between the axis of the pen and the surface of the tablet. The value is 0 when the pen is parallel to the surface and 90 when the pen is perpendicular to the surface. The values are negative when the pen is inverted. |
| TwistOrientation | The clockwise rotation of the cursor about its own axis. |
| PitchRotation | The packet property that indicates whether the tip is above or below a horizontal line that is perpendicular to the writing surface. Note: This requires a 3D digitizer. The value is positive if the tip is above the line and negative if it is below the line. For example, if you hold the pen in front of you and write on an imaginary wall, the pitch is positive if the tip is above a line extending from you to the wall. |
| RollRotation | The clockwise rotation of the pen around its own axis. Note: This requires a 3D digitizer. |
| YawRotation | The angle of the pen to the left or right around the center of its horizontal axis when the pen is horizontal. Note: This requires a 3D digitizer. If you hold the pen in front of you and write on an imaginary wall, zero yaw indicates that the pen is perpendicular to the wall. The value is negative if the tip is to the left of perpendicular and positive if the tip is to the right of perpendicular. |
| Width | The width of the contact area on a touch digitizer. |
| Height | The height of the contact area on a touch digitizer. |
| FingerContactConfidence | The level of confidence that there was finger contact on a touch digitizer. |
| DeviceContactID | The device contact identifier for a packet, e.g. to identify individual fingers. |