U PeRR@sdZdZddlZddlmZddlmZddlmZddlmZddl m Z Gd d d e Z Gd d d e Zed efiZGdd d eZdS)a] .. _motionevent: Motion Event ============ The :class:`MotionEvent` is the base class used for events provided by pointing devices (touch and non-touch). This class defines all the properties and methods needed to handle 2D and 3D movements but has many more capabilities. Usually you would never need to create the :class:`MotionEvent` yourself as this is the role of the :mod:`~kivy.input.providers`. Flow of the motion events ------------------------- 1. The :class:`MotionEvent` 's are gathered from input providers by :class:`~kivy.base.EventLoopBase`. 2. Post processing is performed by registered processors :mod:`~kivy.input.postproc`. 3. :class:`~kivy.base.EventLoopBase` dispatches all motion events using `on_motion` event to all registered listeners including the :class:`~kivy.core.window.WindowBase`. 4. Once received in :meth:`~kivy.core.window.WindowBase.on_motion` events (touch or non-touch) are all registered managers. If a touch event is not handled by at least one manager, then it is dispatched through :meth:`~kivy.core.window.WindowBase.on_touch_down`, :meth:`~kivy.core.window.WindowBase.on_touch_move` and :meth:`~kivy.core.window.WindowBase.on_touch_up`. 5. Widgets receive events in :meth:`~kivy.uix.widget.Widget.on_motion` method (if passed by a manager) or on `on_touch_xxx` methods. Motion events and event managers -------------------------------- A motion event is a touch event if its :attr:`MotionEvent.is_touch` is set to `True`. Beside `is_touch` attribute, :attr:`MotionEvent.type_id` can be used to check for event's general type. Currently two types are dispatched by input providers: "touch" and "hover". Event managers can be used to dispatch any motion event throughout the widget tree and a manager uses `type_id` to specify which event types it want to receive. See :mod:`~kivy.eventmanager` to learn how to define and register an event manager. A manager can also assign a new `type_id` to :attr:`MotionEvent.type_id` before dispatching it to the widgets. This useful when dispatching a specific event:: class MouseTouchManager(EventManagerBase): type_ids = ('touch',) def dispatch(self, etype, me): accepted = False if me.device == 'mouse': me.push() # Save current type_id and other values me.type_id = 'mouse_touch' self.window.transform_motion_event_2d(me) # Dispatch mouse touch event to widgets which registered # to receive 'mouse_touch' for widget in self.window.children[:]: if widget.dispatch('on_motion', etype, me): accepted = True break me.pop() # Restore return accepted Listening to a motion event --------------------------- If you want to receive all motion events, touch or not, you can bind the MotionEvent from the :class:`~kivy.core.window.Window` to your own callback:: def on_motion(self, etype, me): # will receive all motion events. pass Window.bind(on_motion=on_motion) You can also listen to changes of the mouse position by watching :attr:`~kivy.core.window.WindowBase.mouse_pos`. Profiles -------- The :class:`MotionEvent` stores device specific information in various properties listed in the :attr:`~MotionEvent.profile`. For example, you can receive a MotionEvent that has an angle, a fiducial ID, or even a shape. You can check the :attr:`~MotionEvent.profile` attribute to see what is currently supported by the MotionEvent provider. This is a short list of the profile values supported by default. Please check the :attr:`MotionEvent.profile` property to see what profile values are available. ============== ================================================================ Profile value Description -------------- ---------------------------------------------------------------- angle 2D angle. Accessed via the `a` property. button Mouse button ('left', 'right', 'middle', 'scrollup' or 'scrolldown'). Accessed via the `button` property. markerid Marker or Fiducial ID. Accessed via the `fid` property. pos 2D position. Accessed via the `x`, `y` or `pos` properties. pos3d 3D position. Accessed via the `x`, `y` or `z` properties. pressure Pressure of the contact. Accessed via the `pressure` property. shape Contact shape. Accessed via the `shape` property . ============== ================================================================ If you want to know whether the current :class:`MotionEvent` has an angle:: def on_touch_move(self, touch): if 'angle' in touch.profile: print('The touch angle is', touch.a) If you want to select only the fiducials:: def on_touch_move(self, touch): if 'markerid' not in touch.profile: return ) MotionEventN) isroutine)copy)time)MODE_DEFAULT_DISPATCH)Vectorcs$eZdZfddZddZZS)EnhancedDictionarycs6z ||WStk r0tt||YSXdSN) __getitem__KeyErrorsuperr __getattr__)selfattr __class__:/tmp/pip-unpacked-wheel-xzebddm3/kivy/input/motionevent.pyr s zEnhancedDictionary.__getattr__cCs|||dSr ) __setitem__)rrvaluerrr __setattr__szEnhancedDictionary.__setattr__)__name__ __module__ __qualname__r r __classcell__rrrrrs rcseZdZfddZZS)MotionEventMetaclasscs\g}|D]}t|dr||jqd|kr:||dt||d<tt|||||S)N __attrs__)hasattrextendrtupler r__new__)Zmcsnamebasesattrsrbaserrrr s  zMotionEventMetaclass.__new__)rrrr rrrrrrsrrc@seZdZdZdZdZd1ddZdd Zd2d d Zd d Z ddZ ddZ d3ddZ ddZ d4ddZddZddZddZdd Zd!d"Zed#d$Zed%d&Zed'd(Zed)d*Zd+d,Zd-d.Zed/d0ZdS)5rzAbstract class that represents an input event. :Parameters: `id`: str unique ID of the MotionEvent `args`: list list of parameters, passed to the depack() function r)'device push_attrspush_attrs_stackis_touchtype_idid dispatch_modeshapeprofilesxsyszosxosyoszpsxpsypszdsxdsydszxyzoxoyozpxpypzdxdydz time_start is_double_tapdouble_tap_time is_triple_taptriple_tap_timeudFNcCsh|jtkrtdtjd7_||_||_t|_g|_d|_ tj|_ ||_ g|_ d|_ d|_d|_d|_g|_||_d|_d|_d|_d|_d|_d|_d|_d|_d|_d|_d|_d|_d|_d|_ d|_!d|_"d|_#d|_$d|_%d|_&d|_'d|_(d|_)d|_*d|_+d|_,t-|_.|j.|_/d|_0d|_1d|_2d|_3d|_4t5|_6d |_7d |_8d|_9|:|dS) Nzclass MotionEvent is abstract)r:r;r<rCrDrEr=r>r?r@rArBposr)r+F)rNrNrT);rrNotImplementedError_MotionEvent__uniq_idr(r)rr+r'r&uidr% grab_listgrab_exclusive_classZ grab_stateZ grab_currentbuttonr-r*r,r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rArBrCrDrErMrrF time_updatetime_endrGrIrHrJrrKsync_with_dispatch_keep_prev_pos_first_dispatch_donedepack)rr%r*argsr(r)rrr__init__sn  zMotionEvent.__init__cCsn|jdks|jr@|js@|j|_|_|j|_|_|j|_ |_ |j|j|_ |j|j|_ |j|j |_ dS)z*Depack `args` into attributes of the classN)r1rXrZr.r4r/r2r5r0r3r6r7r8r9rr\rrrr[ks zMotionEvent.depackcCs8|jdk rtdt|j}|r(||_|j|dS)aGrab this motion event. If this event is a touch you can grab it if you want to receive subsequent :meth:`~kivy.uix.widget.Widget.on_touch_move` and :meth:`~kivy.uix.widget.Widget.on_touch_up` events, even if the touch is not dispatched by the parent: .. code-block:: python 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 .. versionchanged:: 2.1.0 Allowed grab for non-touch events. Nz(Event is exclusive and cannot be grabbed)rT Exceptionweakrefref__self__rSappend)rclass_instanceZ exclusiverrrgrabys   zMotionEvent.grabcCs6t|j}|j|krd|_||jkr2|j|dS)z2Ungrab a previously grabbed motion event. N)r`rarbrTrSremove)rrdrrrungrabs    zMotionEvent.ungrabcCsd|_d|_dS)zNotify that dispatch to the listeners is done. Called by the :meth:`EventLoopBase.post_dispatch_input`. .. versionadded:: 2.1.0 TN)rYrZrrrr dispatch_doneszMotionEvent.dispatch_donecCsb|jr0|jrL|j|j|j|_|_|_d|_n|j|j|j|_|_|_t|_ | |dS)z"Move to another position. FN) rXrYr.r/r0r4r5r6rrVr[r^rrrmoveszMotionEvent.moveNonec Cs~td|dtd|d}}|j} | |j|j|||\|_|_| |j|j|||\|_|_ | |j |j |||\|_ |_ |dkrdn td|d} |j| |_|j| |_|j| |_|rB|dks|dkr|j|8_|j |8_ |j |8_ nJ|dkrB||j|||} |j| 7_|j | 7_ |j | 7_ |j|j |_|j|j |_|j|j|_|j|jf|_dS)zScale position for the screen. .. versionchanged:: 2.1.0 Max value for `x`, `y` and `z` is changed respectively to `w` - 1, `h` - 1 and `p` - 1. rrLNZpanZ below_targetZscale)maxto_absolute_posr.r/r:r;r1r2r=r>r4r5r@rAr0r<r3r?r6rBrCrDrErM) rwhprotationZsmodeZkheightx_maxy_maxabsoluteZz_maxoffsetrrrscale_for_screens.    zMotionEvent.scale_for_screencCs|dkr||||fS|dkr4||d||fS|dkrTd||d||fS|dkrpd||||fStd|dS)aTransforms 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 .. versionadded:: 2.1.0 rZrLiz7Invalid rotation %s, valid values are 0, 90, 180 or 270N) ValueError)rZnxnyrrrsrqrrrrms zMotionEvent.to_absolute_poscs4|dkrj}fdd|D}j||fdS)z9Push attribute values in `attrs` onto the stack. Ncsg|]}t|qSr)getattr).0r:rhrr sz$MotionEvent.push..)r&r'rc)rr#valuesrrhrpushszMotionEvent.pushcCs8|j\}}tt|D]}t|||||qdS)z.Pop attributes values from the stack. N)r'poprangelensetattr)rr#r~irrrrszMotionEvent.popcCsh||j|j\|_|_|_||j|j\|_|_||j|j\|_|_|j|j|_|j|j|_dS)zWApply a transformation on x, y, z, px, py, pz, ox, oy, oz, dx, dy, dz. N) r:r;rMr@rAr=r>rCrD)rZ transformrrrapply_transform_2ds zMotionEvent.apply_transform_2dcCs&|jD]}||t||qdS)z3Copy some attribute to another motion event object.N)rrr__getattribute__)rtorrrrcopy_to s zMotionEvent.copy_tocCst|j|jS)z4Return the distance between the two events. )rrMdistance)rZ other_touchrrrrszMotionEvent.distancecCs t|_dSr )rrWrhrrrupdate_time_endszMotionEvent.update_time_endcCs |j|jfS)ztReturn delta between last position and current position, in the screen coordinate system (self.dx, self.dy).)rCrDrhrrrdposszMotionEvent.dposcCs |j|jfS)zkReturn the initial position of the motion event in the screen coordinate system (self.ox, self.oy).)r=r>rhrrropos!szMotionEvent.oposcCs |j|jfS)zlReturn the previous position of the motion event in the screen coordinate system (self.px, self.py).)r@rArhrrrppos'szMotionEvent.pposcCs |j|jfS)zMReturn the position in the 0-1 coordinate system (self.sx, self.sy). )r.r/rhrrrspos-szMotionEvent.sposcCs:t|j}|dddddd}d||j|jfS)N.rO>'z<%s spos=%s pos=%s>)strrsplitreplacerrM)rbasename classnamerrr__str__3s zMotionEvent.__str__cCs\g}t|D]8}t||}|ddkr(q t|r2q |d||fq d|jjd|fS)Nr_z%s="%s"z<%s %s> )dirr{rrcrrjoin)routr:vrrr__repr__8s   zMotionEvent.__repr__cGsd|jkod|jkS)zcReturns True if the touch event is a mousewheel scrolling .. versionadded:: 1.6.0 rUZscroll)r-rUr^rrris_mouse_scrollingEszMotionEvent.is_mouse_scrolling)FN)F)Nrrkr)N)rrr__doc__rQrr]r[rergrirjrvrmrrrrrrpropertyrrrrrrrrrrrrsD  $ %    #       )r__all__r`inspectrrrZkivy.eventmanagerrZ kivy.vectorrdictrtyperobjectZMotionEventBaserrrrrs|