Welcome to the Leap JavaScript framework. This is intended for use with the Leap (https://www.leapmotion.com/).
If you're using npm, you can use npm install leapjs
.
LeapJS works from with Node.js or your browser.
Include the leap.js script included at the root of this package, or, use the minified version provided at leap.min.js.
<script src="./leap.min.js"></script>
Use the following:
var Leap = require('leapjs').Leap
To listen to the frame events, you can use the friendly Leap.loop
function.
This will auto-detect which type of event loop you can accept, and, call your callback with frames.
Leap.loop(function(frame) {
// ... your code here
})
As well, you can call a special version of Leap.loop
where you provide a second argument to the callback.
This allows you to wait until you're ready to receieve further frame events. Here is an exmaple of
this approach.
Leap.loop(function(frame, done) {
// do things
done() // if you don't invoke this, you won't get more events
})
Using v0.7.5 of SDK on onwards, options can now be recognized by the connection.
Currently, the only recognized option is enabledGestures
. This can be set to either true
or false
;
Using the loop
method, you can pass in options in the following way:
Leap.loop({enableGestures: true}, {
// do things
});
To pass in options when constructing the controller, do the following:
var controller = new Leap.Controller({enableGestures: true});
Leap.loop attempts to pick the right event loop to use. Within the
background page of a Chrome extension, Chrome will not use the animationFrame
loop. As well,
in Node.js no animation event exists.
In general, browsers optimize the load of requestAnimationFrame based on load, element visibility, battery status, etc. Chrome has chosen to optimize this by omitting the functionality altogether in the background.js of its extensions.
To manually pick the event type you'd like to use, create a leap controller and listen for the appropriate event
type, either frame
or animationFrame
.
var controller = new Leap.Controller();
// for the frame event
controller.on('frame', function() {
console.log("hello frame")
})
// for the animationFrame event. this is only supported from within the browser
controller.on('animationFrame', function() {
console.log("hello frame")
})
controller.connect()
Inside the examples directory are a few great examples. To get them running, do the following:
- Run
npm install
- Run
make serve
- Point your browser at http://localhost:8080/examples and enjoy
To run the node.js example, run node exmaples/node.js
.
You can build your own leap.js file by using make build
. If you're doing any amount of development, you'll find it
convenient to run make watch
. This takes care of building leap.js for you on every edit. As well, you can both
watch and running make watch-test
.
There are currently rudamentary tests. To get them running, do the following:
- Run
npm install
- Run
make test
Or use make watch-test as noted above.