# LeapJS

**Repository Path**: mirrors_deckar01/LeapJS

## Basic Information

- **Project Name**: LeapJS
- **Description**: An adaptation of the Leap API for Javascript
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-04-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![LeapJS](http://deckar01.github.com/images/LeapJS.png)

LeapJS
======

LeapJS is a Javascript library that provides the functionality and object structure of the Leap API to assist developers who are working with the Leap Motion in a browser environment.

## Including

Include Leap.js for debugging and access to "private" variables:
```html
<script src="Leap.js"></script>
```

Include Leap.min.js for deployed applications to reduce load times:
```html
<script src="Leap.min.js"></script>
```

## Tutorial

```javascript
// Create a controller to connect to the Leap Motion
myController = new Leap.Controller("ws://localhost:6437/");

// Create a listener
myListener = new Leap.Listener();

// Listener.onFrame is called each time a frame is received
myListener.onFrame = function(controller){

    var frame = controller.frame();
    var hands = frame.hands();
    var pointables = frame.pointables();
    
    var gestures = frame.gestures();
    
    // Awesome code goes here
}

// Add the listener to the controller
myController.addListener(myListener);

// Enable the screenTap gesture
myController.enableGesture("screenTap", true);

// Listener.onConnect is called when the connection is open
myListener.onConnect = function(controller){
 
    // Calibrate the screen
    calibrate = new Leap.Calibrate(controller);
    calibrate.onComplete = function(screen){
        // Save the screen
        // Or access it later with myController.calibratedScreens()[0]
    }
}
```

## Whats new? Gestures!
* **Gesture.Type**
  * "circle"
  * "keyTap"
  * "screenTap"
  * "swipe"
* **CircleGesture** : _Gesture_
* **KeyTapGesture** : _Gesture_
* **ScreenTapGesture** : _Gesture_
* **SwipeGesture** : _Gesture_
* **Controller**
  * _void_ **enableGesture**( _string_ **type**, _Bool_ **enable** )
  * _Bool_ **isGestureEnabled**( _string_ **type** )
* **Frame**
  * _GestureList_ **gestures**()
  * _GestureList_ **gestures**( _Frame_ **sinceFrame** )

## Whats new? Calibration!
* **Calibrate**
  * **Calibrate**( _Controller_ **controller** )
  * _virtual void_ **onComplete**( _Screen_ **screen** )
* **Screen**
  * **Screen**()
  * _float_ **distanceToPoint**( _Vector_ point )
  * { **position** : _Vector_, **distance** : _float_ } **intersect**( _Pointable_ **pointable**, _Bool_ **normalize** )
  * { **position** : _Vector_, **distance** : _float_ } **intersect**( _Vector_ **position**, _Vector_ **direction**, _Bool_ **normalize** )
  * { **position** : _Vector_, **distance** : _float_ } **project**( _Pointable_ **pointable**, _Bool_ **normalize** )
  * { **position** : _Vector_, **distance** : _float_ } **project**( _Vector_ **position**, _Bool_ **normalize** )
  * _Vector_ **normal**()
  * _void_ **offset**()
  * _Bool_ **isValid**()
  * _static Screen_ **invalid**()

## Where is the API?
[The API has been moved to the wiki page](https://github.com/deckar01/LeapJS/wiki)