Leap::Tool Class Reference

#include <Leap.h>

Inheritance diagram for Leap::Tool:

List of all members.

Public Member Functions
def	__init__
def	__str__
	Tool (ToolImplementation *)
LEAP_EXPORT	Tool ()
LEAP_EXPORT	Tool (const Pointable &)
std::string	toString () const
Static Public Member Functions
static LEAP_EXPORT const Tool &	invalid ()
Public Attributes
	this
Private Member Functions
LEAP_EXPORT const char *	toCString () const
Static Private Attributes
tuple	__getattr__ = lambdaself,name:_swig_getattr(self, Tool, name)
	__repr__ = _swig_repr
tuple	__setattr__ = lambdaself,name,value:_swig_setattr(self, Tool, name, value)
	__swig_destroy__ = LeapPython.delete_Tool
dictionary	__swig_getmethods__ = {}
dictionary	__swig_setmethods__ = {}

---

Detailed Description

The Tool class represents a tracked tool.

Tools are Pointable objects that the Leap Motion software has classified as a tool.

Get valid Tool objects from a Frame object.

Note that Tool objects can be invalid, which means that they do not contain valid tracking data and do not correspond to a physical tool. Invalid Tool objects can be the result of asking for a Tool object using an ID from an earlier frame when no Tool objects with that ID exist in the current frame. A Tool object created from the Tool constructor is also invalid. Test for validity with the Tool::isValid() function.

Since:

1.0

Definition at line 1019 of file Leap.h.

---

Constructor & Destructor Documentation

Leap::Tool::Tool

(

ToolImplementation *

)

LEAP_EXPORT Leap::Tool::Tool

(

)

Constructs a Tool object.

An uninitialized tool is considered invalid. Get valid Tool objects from a Frame object.

Since:

1.0

LEAP_EXPORT Leap::Tool::Tool

(

const Pointable &

)

[explicit]

If the specified Pointable object represents a tool, creates a copy of it as a Tool object; otherwise, creates an invalid Tool object.

Since:

1.0

def Leap::Tool::__init__	(		self,
			args
	)

Definition at line 693 of file Leap.py.

---

Member Function Documentation

def Leap::Tool::__str__

(

self

)

Reimplemented from Leap::Pointable.

Definition at line 700 of file Leap.py.

static LEAP_EXPORT const Tool& Leap::Tool::invalid

(

)

[static]

Returns an invalid Tool object.

You can use the instance returned by this function in comparisons testing whether a given Tool instance is valid or invalid. (You can also use the Tool::isValid() function.)

Returns:

The invalid Tool instance.

Since:

1.0

Reimplemented from Leap::Pointable.

LEAP_EXPORT const char* Leap::Tool::toCString

(

)

const [private]

Reimplemented from Leap::Pointable.

std::string Leap::Tool::toString

(

)

const [inline]

A string containing a brief, human readable description of the Tool object.

Returns:

A description of the Tool object as a string.

Since:

1.0

Reimplemented from Leap::Pointable.

Definition at line 1066 of file Leap.h.

---

Member Data Documentation

tuple Leap::Tool::__getattr__ = lambdaself,name:_swig_getattr(self, Tool, name) [static, private]

Reimplemented from Leap::Pointable.

Definition at line 690 of file Leap.py.

Leap::Tool::__repr__ = _swig_repr [static, private]

Reimplemented from Leap::Pointable.

Definition at line 691 of file Leap.py.

tuple Leap::Tool::__setattr__ = lambdaself,name,value:_swig_setattr(self, Tool, name, value) [static, private]

Reimplemented from Leap::Pointable.

Definition at line 686 of file Leap.py.

Leap::Tool::__swig_destroy__ = LeapPython.delete_Tool [static, private]

Reimplemented from Leap::Pointable.

Definition at line 702 of file Leap.py.

dictionary Leap::Tool::__swig_getmethods__ = {} [static, private]

Reimplemented from Leap::Pointable.

Definition at line 687 of file Leap.py.

dictionary Leap::Tool::__swig_setmethods__ = {} [static, private]

Reimplemented from Leap::Pointable.

Definition at line 683 of file Leap.py.

Leap::Tool::this

Reimplemented from Leap::Pointable.

Definition at line 693 of file Leap.py.

---

The documentation for this class was generated from the following files:

• Leap.h
• Leap.py