45 |
46 |
core/index.js
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 | /**
57 | * The global API interface for westures-core. Exposes all classes, constants,
58 | * and routines used by the package. Use responsibly.
59 | *
60 | * @namespace westures-core
61 | */
62 |
63 | 'use strict';
64 |
65 | const Gesture = require('./src/Gesture.js');
66 | const Input = require('./src/Input.js');
67 | const Point2D = require('./src/Point2D.js');
68 | const PointerData = require('./src/PointerData.js');
69 | const Region = require('./src/Region.js');
70 | const Smoothable = require('./src/Smoothable.js');
71 | const State = require('./src/State.js');
72 | const constants = require('./src/constants.js');
73 | const utils = require('./src/utils.js');
74 |
75 | module.exports = {
76 | Gesture,
77 | Input,
78 | Point2D,
79 | PointerData,
80 | Region,
81 | Smoothable,
82 | State,
83 | ...constants,
84 | ...utils,
85 | };
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
96 |
45 |
46 |
core/src/PointerData.js
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 | 'use strict';
57 |
58 | const Point2D = require('./Point2D.js');
59 | const { PHASE } = require('./constants.js');
60 |
61 | /**
62 | * @private
63 | * @inner
64 | * @memberof westures-core.PointerData
65 | *
66 | * @return {Event} The Event object which corresponds to the given identifier.
67 | * Contains clientX, clientY values.
68 | */
69 | function getEventObject(event, identifier) {
70 | if (event.changedTouches) {
71 | return Array.from(event.changedTouches).find(touch => {
72 | return touch.identifier === identifier;
73 | });
74 | }
75 | return event;
76 | }
77 |
78 | /**
79 | * Low-level storage of pointer data based on incoming data from an interaction
80 | * event.
81 | *
82 | * @memberof westures-core
83 | *
84 | * @param {Event} event - The event object being wrapped.
85 | * @param {number} identifier - The index of touch if applicable
86 | */
87 | class PointerData {
88 | constructor(event, identifier) {
89 | const { clientX, clientY } = getEventObject(event, identifier);
90 |
91 | /**
92 | * The original event object.
93 | *
94 | * @type {Event}
95 | */
96 | this.event = event;
97 |
98 | /**
99 | * The type or 'phase' of this batch of pointer data. 'start' or 'move' or
100 | * 'end' or 'cancel'
101 | *
102 | * @type {string}
103 | */
104 | this.type = PHASE[event.type];
105 |
106 | /**
107 | * The timestamp of the event in milliseconds elapsed since January 1, 1970,
108 | * 00:00:00 UTC.
109 | *
110 | * @type {number}
111 | */
112 | this.time = Date.now();
113 |
114 | /**
115 | * The (x,y) coordinate of the event, wrapped in a Point2D.
116 | *
117 | * @type {westures-core.Point2D}
118 | */
119 | this.point = new Point2D(clientX, clientY);
120 | }
121 | }
122 |
123 | module.exports = PointerData;
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
45 |
46 |
index.js
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 | /**
57 | * The API interface for Westures. Defines a number of gestures on top of the
58 | * engine provided by {@link
59 | * https://mvanderkamp.github.io/westures-core/index.html|westures-core}.
60 | *
61 | * @namespace westures
62 | */
63 |
64 | 'use strict';
65 |
66 | const core = require('./core');
67 |
68 | const Pan = require('./src/Pan.js');
69 | const Pinch = require('./src/Pinch.js');
70 | const Press = require('./src/Press.js');
71 | const Pull = require('./src/Pull.js');
72 | const Rotate = require('./src/Rotate.js');
73 | const Swipe = require('./src/Swipe.js');
74 | const Swivel = require('./src/Swivel.js');
75 | const Tap = require('./src/Tap.js');
76 | const Track = require('./src/Track.js');
77 |
78 | module.exports = {
79 | Pan,
80 | Pinch,
81 | Press,
82 | Pull,
83 | Rotate,
84 | Swipe,
85 | Swivel,
86 | Tap,
87 | Track,
88 | ...core,
89 | };
90 |
91 | /**
92 | * Here are the return "types" of the gestures that are included in this
93 | * package.
94 | *
95 | * @namespace ReturnTypes
96 | */
97 |
98 | /**
99 | * The base data that is included for all emitted gestures.
100 | *
101 | * @typedef {Object} BaseData
102 | *
103 | * @property {westures-core.Point2D} centroid - The centroid of the input
104 | * points.
105 | * @property {Event} event - The input event which caused the gesture to be
106 | * recognized.
107 | * @property {string} phase - 'start', 'move', 'end', or 'cancel'.
108 | * @property {string} type - The name of the gesture as specified by its
109 | * designer.
110 | * @property {Element} target - The bound target of the gesture.
111 | *
112 | * @memberof ReturnTypes
113 | */
114 |
115 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |