Page MenuHomePhabricator

Efl.Input.Value
Open, TODOPublic

Description

enum @beta Efl.Input.Value {
   [[Keys for the generic values of all events.

     @since 1.19
   ]]
   none,       [[Not a valid value type.]]
   timestamp,  [[Timestamp of this event in seconds.]]
   button,     [[ID of the button that triggered this event (unsigned int).
                 Prefer the method $button to read this value. Default: 0.]]
   buttons_pressed, [[32-bit bit mask (unsigned int). Prefer the
                      method $buttons_pressed to read this value. Default: 0.]]
   tool,       [[ID of the finger or tool (eg. pen) that triggered this event.
                 Prefer the property $tool to read this value. Default: 0.]]
   x,          [[Absolute X position where this event occurred, in pixels.
                 Relative to the window. Default: last known position.
                 This value may be smoothed out or even extrapolated by EFL.]]
   y,          [[Absolute Y position where this event occurred, in pixels.
                 Relative to the window. Default: last known position.
                 This value may be smoothed out or even extrapolated by EFL.]]
   dx,         [[Relative X movement, in pixels. Range: unbounded. Default: 0.]]
   dy,         [[Relative Y movement, in pixels. Range: unbounded. Default: 0.]]
   previous_x, [[Previous X position of the pointer, in pixels.
                 Default: last known position, may be equal to x.]]
   previous_y, [[Previous Y position of the pointer, in pixels.
                 Default: last known position, may be equal to y.]]
   raw_x,      [[Absolute X position where this event occurred. Default: 0.
                 This value will be set from the hardware input without any
                 smoothing or extrapolation. For an axis input event, this is
                 the raw value set by the driver (undefined range and unit).]]
   raw_y,      [[Absolute X position where this event occurred. Default: 0.
                 This value will be set from the hardware input without any
                 smoothing or extrapolation. For an axis input event, this is
                 the raw value set by the driver (undefined range and unit).]]
   radius,     [[Average radius of the pressed area under a finger or tool,
                 in pixels. Default is 1.]]
   radius_x,   [[Spread over X of the pressed area under a finger or tool,
                 in pixels. Default is 1.]]
   radius_y,   [[Spread over Y of the pressed area under a finger or tool,
                 in pixels. Default is 1.]]
   pressure,   [[Pressure applied to the button, touch or pen tip.
                 Range: [0, 1]. Default is 1.]]
   distance,   [[Relative distance along physical Z axis. Range: [0, 1].
                 Default is 0.]]
   azimuth,    [[Angle of tool about the Z axis from positive X axis.
                 Range: [-PI, PI]. Unit: Radians.]]
   tilt,       [[Angle of tool about plane of sensor from positive Z axis.
                 Range: [0.0, PI]. Unit: Radians.]]
   tilt_x,     [[Current tilt along the X axis of the tablet's current logical
                 orientation, in radians off the tablet's Z axis.
                 Range: [-PI, PI]. Unit: Radians.]]
   tilt_y,     [[Current tilt along the Y axis of the tablet's current logical
                 orientation, in radians off the tablet's Z axis.
                 Range: [-PI, PI]. Unit: Radians.]]
   twist,      [[Rotation of tool about its major axis from its "natural"
                 position. Range: [-PI, PI] Unit: Radians.]]
   wheel_delta, [[Delta movement of the wheel in discrete steps (int).
                  Default: 0.]]
   wheel_angle, [[Delta movement of the wheel in radians. Default: 0.]]
   wheel_horizontal, [[Direction of the wheel (horizontal = 1 or vertical = 0).
                       Default: 0. Prefer the property $wheel_horizontal to read.]]
   slider,     [[Current position of the slider on the tool. Range: [-1, 1].
                 Default: 0.]]
}

Related Objects

StatusAssignedTask
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
Opencedric
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
OpenNone
segfaultxavi triaged this task as TODO priority.
zmike moved this task from Backlog to Evaluating on the efl: api board.May 16 2019, 10:53 AM
zmike added a comment.Wed, Jun 12, 9:41 AM

This should, at minimum, be renamed to something like Pointer_State or something including the word Pointer.

I'm not sure. This is an enum of all possible data (capabilities, properties, features) that can be attached to any input event. This works for mice and fingers but also for joysticks, tablet orientation sensors and generic sliders. I do not think Pointer matches all these devices.

The word "tool" is used throughout the docs in this enum so maybe: Tool_Value, Tool_Type, Value_Type, Sensor_Type, Tool_Sensor, Capability...?