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)
- MacOSX 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)¶
Bases: kivy.input.motionevent.MotionEvent
Abstract class to represent a touch and non-touch object.
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 touch object.
- depack(args)¶
Depack args into attributes of the class
- distance(other_touch)¶
Return the distance between the current touch and another touch.
- 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. You can grab a touch if you absolutly want to receive on_touch_move() and on_touch_up(), even if the touch is not dispatched by your 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
- is_mouse_scrolling¶
Returns True if the touch is a mousewheel scrolling
New in version 1.6.0.
- move(args)¶
Move the touch to another position
- opos¶
Return the initial position of the touch in the screen coordinate system (self.ox, self.oy)
- pop()¶
Pop attributes values from the stack
- ppos¶
Return the previous position of the touch 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)¶
Scale position for the screen
- spos¶
Return the position in the 0-1 coordinate system (self.sx, self.sy)
- ungrab(class_instance)¶
Ungrab a previously grabbed touch
- class kivy.input.MotionEventProvider(device, args)¶
Bases: object
Base class for a provider.
- start()¶
Start the provider. This method is automatically called when the application is started and if the configuration uses the current provider.
- stop()¶
Stop the provider.
- update(dispatch_fn)¶
Update the provider and dispatch all the new touch events though the dispatch_fn argument.
- class kivy.input.MotionEventFactory¶
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
- Input Postprocessing
- Providers
- NO DOCUMENTATION (module kivy.uix)
- Auto Create Input Provider Config Entry for Available MT Hardware (linux only).
- Common definitions for a Windows provider
- Leap Motion - finger only
- Mouse provider implementation
- Native support for HID input from the linux kernel
- Native support for Multitouch devices on Linux, using libmtdev.
- Native support of MultitouchSupport framework for MacBook (MaxOSX platform)
- Native support of Wacom tablet from linuxwacom driver
- Support for WM_PEN messages (Windows platform)
- Support for WM_TOUCH messages (Windows platform)
- TUIO Input Provider
- NO DOCUMENTATION (module kivy.uix)
- Input recorder
- Motion Event
- Motion Event Factory
- Motion Event Provider
- Motion Event Shape