ListenerΒΆ

Listener Class Reference

The Listener class defines a set of callback functions that you can override in a subclass to respond to events dispatched by the Controller object. More...

Public Member Functions

 Listener ()
 Constructs a Listener object. More...
 
virtual void onConnect (const Controller &)
 Called when the Controller object connects to the Leap Motion software and the Leap Motion hardware device is plugged in, or when this Listener object is added to a Controller that is already connected. More...
 
virtual void onDeviceChange (const Controller &)
 Called when a Leap Motion controller is plugged in, unplugged, or the device changes state. More...
 
virtual void onDeviceFailure (const Controller &)
 Called when a Leap Motion controller device is plugged into the client computer, but fails to operate properly. More...
 
virtual void onDisconnect (const Controller &)
 Called when the Controller object disconnects from the Leap Motion software or the Leap Motion hardware is unplugged. More...
 
virtual void onExit (const Controller &)
 Called when this Listener object is removed from the Controller or the Controller instance is destroyed. More...
 
virtual void onFocusGained (const Controller &)
 Called when this application becomes the foreground application. More...
 
virtual void onFocusLost (const Controller &)
 Called when this application loses the foreground focus. More...
 
virtual void onFrame (const Controller &)
 Called when a new frame of hand and finger tracking data is available. More...
 
virtual void onImages (const Controller &)
 Called when new images are available. More...
 
virtual void onInit (const Controller &)
 Called once, when this Listener object is newly added to a Controller. More...
 
virtual void onLogMessage (const Controller &, MessageSeverity severity, int64_t timestamp, const char *msg)
 Called when the service emits a log message to report an error, warning, or status change. More...
 
virtual void onServiceChange (const Controller &)
 Called when the Leap Motion service is paused or resumed or when a controller policy is changed. More...
 
virtual void onServiceConnect (const Controller &)
 Called when the Leap Motion daemon/service connects to your application Controller. More...
 
virtual void onServiceDisconnect (const Controller &)
 Called if the Leap Motion daemon/service disconnects from your application Controller. More...
 
virtual ~Listener ()
 Destroys this Listener object. More...
 

Detailed Description

The Listener class defines a set of callback functions that you can override in a subclass to respond to events dispatched by the Controller object.

To handle Leap Motion events, create an instance of a Listener subclass and assign it to the Controller instance. The Controller calls the relevant Listener callback function when an event occurs, passing in a reference to itself. You do not have to implement callbacks for events you do not want to handle.

The Controller object calls these Listener functions from a thread created by the Leap Motion library, not the thread used to create or set the Listener instance.

Since
1.0

Constructor & Destructor Documentation

Listener ( )
inline

Constructs a Listener object.

Since
1.0
virtual ~Listener ( )
inlinevirtual

Destroys this Listener object.

Member Function Documentation

virtual void onConnect ( const Controller )
inlinevirtual

Called when the Controller object connects to the Leap Motion software and the Leap Motion hardware device is plugged in, or when this Listener object is added to a Controller that is already connected.

When this callback is invoked, Controller::isServiceConnected is true, Controller::devices() is not empty, and, for at least one of the Device objects in the list, Device::isStreaming() is true.

void SampleListener::onConnect(const Controller& controller) {
std::cout << "Connected" << std::endl;
}
Parameters
controllerThe Controller object invoking this callback function.
Since
1.0
virtual void onDeviceChange ( const Controller )
inlinevirtual

Called when a Leap Motion controller is plugged in, unplugged, or the device changes state.

State changes include entering or leaving robust mode and low resource mode. Note that there is no direct way to query whether the device is in these modes, although you can use Controller::isLightingBad() to check if there are environmental IR lighting problems.

void SampleListener::onDeviceChange(const Controller& controller) {
std::cout << "Device change " << std::endl;
}
Parameters
controllerThe Controller object invoking this callback function.
Since
1.2
virtual void onDeviceFailure ( const Controller )
inlinevirtual

Called when a Leap Motion controller device is plugged into the client computer, but fails to operate properly.

Get the list containing all failed devices using Controller::failedDevices(). The members of this list provide the device pnpID and reason for failure.

Parameters
controllerThe Controller object invoking this callback function.
Since
3.0
virtual void onDisconnect ( const Controller )
inlinevirtual

Called when the Controller object disconnects from the Leap Motion software or the Leap Motion hardware is unplugged.

The controller can disconnect when the Leap Motion device is unplugged, the user shuts the Leap Motion software down, or the Leap Motion software encounters an unrecoverable error.

void SampleListener::onDisconnect(const Controller& controller) {
std::cout << "Disconnected" << std::endl;
}

Note: When you launch a Leap-enabled application in a debugger, the Leap Motion library does not disconnect from the application. This is to allow you to step through code without losing the connection because of time outs.

Parameters
controllerThe Controller object invoking this callback function.
Since
1.0
virtual void onExit ( const Controller )
inlinevirtual

Called when this Listener object is removed from the Controller or the Controller instance is destroyed.

void SampleListener::onExit(const Controller& controller) {
std::cout << "Exited" << std::endl;
}
Parameters
controllerThe Controller object invoking this callback function.
Since
1.0
virtual void onFocusGained ( const Controller )
inlinevirtual

Called when this application becomes the foreground application.

Only the foreground application receives tracking data from the Leap Motion Controller. This function is only called when the controller object is in a connected state.

void SampleListener::onFocusGained(const Controller& controller) {
std::cout << "Focus gained " << std::endl;
}
Parameters
controllerThe Controller object invoking this callback function.
Since
1.0
virtual void onFocusLost ( const Controller )
inlinevirtual

Called when this application loses the foreground focus.

Only the foreground application receives tracking data from the Leap Motion Controller. This function is only called when the controller object is in a connected state.

void SampleListener::onFocusLost(const Controller& controller) {
std::cout << "Focus lost " << std::endl;
}
Parameters
controllerThe Controller object invoking this callback function.
Since
1.0
virtual void onFrame ( const Controller )
inlinevirtual

Called when a new frame of hand and finger tracking data is available.

Access the new frame data using the Controller::frame() function.

void SampleListener::onFrame(const Controller& controller) {
std::cout << "New frame available" << std::endl;
Leap::Frame frame = controller.frame();
}

Note, the Controller skips any pending onFrame events while your onFrame handler executes. If your implementation takes too long to return, one or more frames can be skipped. The Controller still inserts the skipped frames into the frame history. You can access recent frames by setting the history parameter when calling the Controller::frame() function. You can determine if any pending onFrame events were skipped by comparing the ID of the most recent frame with the ID of the last received frame.

Parameters
controllerThe Controller object invoking this callback function.
Since
1.0
virtual void onImages ( const Controller )
inlinevirtual

Called when new images are available.

Access the new frame data using the Controller::images() function.

void SampleListener::onImages(const Controller& controller) {
std::cout << "New images available " << std::endl;
Leap::ImageList images = controller.images();
}
Parameters
controllerThe Controller object invoking this callback function.
Since
2.2.1
virtual void onInit ( const Controller )
inlinevirtual

Called once, when this Listener object is newly added to a Controller.

void SampleListener::onInit(const Controller& controller) {
std::cout << "Initialized" << std::endl;
}
Parameters
controllerThe Controller object invoking this callback function.
Since
1.0
virtual void onLogMessage ( const Controller ,
MessageSeverity  severity,
int64_t  timestamp,
const char *  msg 
)
inlinevirtual

Called when the service emits a log message to report an error, warning, or status change.

Log message text is provided as ASCII-encoded english.

Parameters
controllerThe Controller object invoking this callback function.
severityThe severity of the error, if known.
timestampThe timestamp of the error in microseconds. (Use Controller::now() - timestamp to compute the age of the message.)
msgThe log message.
Since
3.0
virtual void onServiceChange ( const Controller )
inlinevirtual

Called when the Leap Motion service is paused or resumed or when a controller policy is changed.

The service can change states because the computer user changes settings in the Leap Motion Control Panel application or because an application connected to the service triggers a change. Any application can pause or unpause the service, but only runtime policy changes you make apply to your own application.

void SampleListener::onServiceChange(const Controller& controller) {
std::cout << "Service state change " << std::endl;
}

You can query the pause state of the controller with Controller::isPaused(). You can check the state of those policies you are interested in with Controller::isPolicySet().

Parameters
controllerThe Controller object invoking this callback function.
Since
3.0
virtual void onServiceConnect ( const Controller )
inlinevirtual

Called when the Leap Motion daemon/service connects to your application Controller.

void SampleListener::onServiceConnect(const Controller& controller) {
std::cout << "Service connected " << std::endl;
}
Parameters
controllerThe Controller object invoking this callback function.
Since
1.2
virtual void onServiceDisconnect ( const Controller )
inlinevirtual

Called if the Leap Motion daemon/service disconnects from your application Controller.

Normally, this callback is not invoked. It is only called if some external event or problem shuts down the service or otherwise interrupts the connection.

void SampleListener::onServiceDisconnect(const Controller& controller) {
std::cout << "Service disconnected " << std::endl;
}
Parameters
controllerThe Controller object invoking this callback function.
Since
1.2