Version

Quick search

Table Of Contents

Input management

Our input system is wide and simple at the same time. We are currently able to natively support :

  • Windows multitouch events (pencil and finger)

  • OS X touchpads

  • Linux multitouch events (kernel and mtdev)

  • Linux wacom drivers (pencil and finger)

  • TUIO

All the input management is configurable in the Kivy config. You can easily use many multitouch devices in one Kivy application.

When the events have been read from the devices, they are dispatched through a post processing module before being sent to your application. We also have several default modules for :

  • Double tap detection

  • Decreasing jittering

  • Decreasing the inaccuracy of touch on “bad” DIY hardware

  • Ignoring regions

class kivy.input.MotionEvent(device, id, args, is_touch=False, type_id=None)

Bases: kivy.input.motionevent.MotionEvent

Abstract class that represents an input event.

Parameters:
id: str

unique ID of the MotionEvent

args: list

list of parameters, passed to the depack() function

apply_transform_2d(transform)

Apply a transformation on x, y, z, px, py, pz, ox, oy, oz, dx, dy, dz.

copy_to(to)

Copy some attribute to another motion event object.

depack(args)

Depack args into attributes of the class

dispatch_done()

Notify that dispatch to the listeners is done.

Called by the EventLoopBase.post_dispatch_input().

New in version 2.1.0.

distance(other_touch)

Return the distance between the two events.

property dpos

Return delta between last position and current position, in the screen coordinate system (self.dx, self.dy).

grab(class_instance, exclusive=False)

Grab this motion event.

If this event is a touch you can grab it if you want to receive subsequent on_touch_move() and on_touch_up() events, even if the touch is not dispatched by the parent:

def on_touch_down(self, touch):
    touch.grab(self)

def on_touch_move(self, touch):
    if touch.grab_current is self:
        # I received my grabbed touch
    else:
        # it's a normal touch

def on_touch_up(self, touch):
    if touch.grab_current is self:
        # I receive my grabbed touch, I must ungrab it!
        touch.ungrab(self)
    else:
        # it's a normal touch
        pass

Changed in version 2.1.0: Allowed grab for non-touch events.

property is_mouse_scrolling

Returns True if the touch event is a mousewheel scrolling

New in version 1.6.0.

move(args)

Move to another position.

property opos

Return the initial position of the motion event in the screen coordinate system (self.ox, self.oy).

pop()

Pop attributes values from the stack.

property ppos

Return the previous position of the motion event in the screen coordinate system (self.px, self.py).

push(attrs=None)

Push attribute values in attrs onto the stack.

scale_for_screen(w, h, p=None, rotation=0, smode='None', kheight=0)

Scale position for the screen.

Changed in version 2.1.0: Max value for x, y and z is changed respectively to w - 1, h - 1 and p - 1.

property spos

Return the position in the 0-1 coordinate system (self.sx, self.sy).

to_absolute_pos(nx, ny, x_max, y_max, rotation)

Transforms normalized (0-1) coordinates nx and ny to absolute coordinates using x_max, y_max and rotation.

Raises:

ValueError: If rotation is not one of: 0, 90, 180 or 270

New in version 2.1.0.

ungrab(class_instance)

Ungrab a previously grabbed motion event.

class kivy.input.MotionEventFactory

Bases: builtins.object

MotionEvent factory is a class that registers all availables input factories. If you create a new input factory, you need to register it here:

MotionEventFactory.register('myproviderid', MyInputProvider)
static get(name)

Get a provider class from the provider id

static list()

Get a list of all available providers

static register(name, classname)

Register a input provider in the database

class kivy.input.MotionEventProvider(device, args)[source]

Bases: builtins.object

Base class for a provider.

start()[source]

Start the provider. This method is automatically called when the application is started and if the configuration uses the current provider.

stop()[source]

Stop the provider.

update(dispatch_fn)[source]

Update the provider and dispatch all the new touch events though the dispatch_fn argument.

« Vertex Instructions Input Postprocessing »