Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Static Private Attributes | Friends
Leap::Arm Class Reference

#include <Leap.h>

Inheritance diagram for Leap::Arm:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __eq__
def __init__
def __ne__
def __str__
 Arm (HandImplementation *)
LEAP_EXPORT Arm ()
LEAP_EXPORT Matrix basis () const
LEAP_EXPORT Vector center () const
LEAP_EXPORT Vector direction () const
LEAP_EXPORT Vector elbowPosition () const
LEAP_EXPORT bool isValid () const
LEAP_EXPORT bool operator!= (const Arm &) const
LEAP_EXPORT bool operator== (const Arm &) const
std::string toString () const
LEAP_EXPORT float width () const
LEAP_EXPORT Vector wristPosition () const

Static Public Member Functions

static LEAP_EXPORT const Arminvalid ()

Public Attributes

 this

Static Public Attributes

tuple basis = _swig_property(LeapPython.Arm_basis_get)
tuple center = _swig_property(LeapPython.Arm_center_get)
tuple direction = _swig_property(LeapPython.Arm_direction_get)
tuple elbow_position = _swig_property(LeapPython.Arm_elbow_position_get)
tuple is_valid = _swig_property(LeapPython.Arm_is_valid_get)
tuple width = _swig_property(LeapPython.Arm_width_get)
tuple wrist_position = _swig_property(LeapPython.Arm_wrist_position_get)

Private Member Functions

LEAP_EXPORT const char * toCString () const

Static Private Attributes

tuple __getattr__ = lambdaself,name:_swig_getattr(self, Arm, name)
 __repr__ = _swig_repr
tuple __setattr__ = lambdaself,name,value:_swig_setattr(self, Arm, name, value)
 __swig_destroy__ = LeapPython.delete_Arm
dictionary __swig_getmethods__ = {}
dictionary __swig_setmethods__ = {}

Friends

LEAP_EXPORT friend std::ostream & operator<< (std::ostream &, const Arm &)

Detailed Description

The Arm class represents the forearm.

Definition at line 470 of file Leap.h.


Constructor & Destructor Documentation

Leap::Arm::Arm ( HandImplementation *  )

Constructs an invalid Arm object.

Get valid Arm objects from a Hand object.

Since:
2.0.3
def Leap::Arm::__init__ (   self)

Definition at line 533 of file Leap.py.


Member Function Documentation

def Leap::Arm::__eq__ (   self,
  arg2 
)

Definition at line 540 of file Leap.py.

def Leap::Arm::__ne__ (   self,
  arg2 
)

Definition at line 543 of file Leap.py.

def Leap::Arm::__str__ (   self)

Definition at line 546 of file Leap.py.

The orthonormal basis vectors for the Arm bone as a Matrix.

Basis vectors specify the orientation of a bone.

**xBasis** Perpendicular to the longitudinal axis of the bone; exits the arm laterally through the sides of the wrist.

**yBasis or up vector** Perpendicular to the longitudinal axis of the bone; exits the top and bottom of the arm. More positive in the upward direction.

**zBasis** Aligned with the longitudinal axis of the arm bone. More positive toward the wrist.

The bases provided for the right arm use the right-hand rule; those for the left arm use the left-hand rule. Thus, the positive direction of the x-basis is to the right for the right arm and to the left for the left arm. You can change from right-hand to left-hand rule by multiplying the z basis vector by -1.

Note that converting the basis vectors directly into a quaternion representation is not mathematically valid. If you use quaternions, create them from the derived rotation matrix not directly from the bases.

Returns:
The basis of the arm bone as a matrix.
Since:
2.0.3

The center of the forearm.

This location represents the midpoint of the arm between the wrist position and the elbow position.

Since:
2.1.0

The normalized direction in which the arm is pointing (from elbow to wrist).

Since:
2.0.3

The position of the elbow.

If not in view, the elbow position is estimated based on typical human anatomical proportions.

Since:
2.0.3
static LEAP_EXPORT const Arm& Leap::Arm::invalid ( ) [static]

Returns an invalid Arm object.

Returns:
The invalid Arm instance.
Since:
2.0.3

Reports whether this is a valid Arm object.

Returns:
True, if this Arm object contains valid tracking data.
Since:
2.0.3
LEAP_EXPORT bool Leap::Arm::operator!= ( const Arm ) const

Compare Arm object inequality.

Two Arm objects are equal if and only if both Arm objects represent the exact same physical arm in the same frame and both Arm objects are valid.

Since:
2.0.3
LEAP_EXPORT bool Leap::Arm::operator== ( const Arm ) const

Compare Arm object equality.

Two Arm objects are equal if and only if both Arm objects represent the exact same physical arm in the same frame and both Arm objects are valid.

Since:
2.0.3
LEAP_EXPORT const char* Leap::Arm::toCString ( ) const [private]
std::string Leap::Arm::toString ( ) const [inline]

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

Returns:
A description of the Arm object as a string.
Since:
2.0.3

Definition at line 630 of file Leap.h.

LEAP_EXPORT float Leap::Arm::width ( ) const

The average width of the arm.

Since:
2.0.3

The position of the wrist.

Note that the wrist position is not collocated with the end of any bone in the hand. There is a gap of a few centimeters since the carpal bones are not included in the skeleton model.

Since:
2.0.3

Friends And Related Function Documentation

LEAP_EXPORT friend std::ostream& operator<< ( std::ostream &  ,
const Arm  
) [friend]

Writes a brief, human readable description of the Arm object to an output stream.

Since:
2.0.3

Member Data Documentation

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

Reimplemented from Leap::Interface.

Definition at line 530 of file Leap.py.

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

Definition at line 531 of file Leap.py.

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

Reimplemented from Leap::Interface.

Definition at line 526 of file Leap.py.

Leap::Arm::__swig_destroy__ = LeapPython.delete_Arm [static, private]

Definition at line 569 of file Leap.py.

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

Reimplemented from Leap::Interface.

Definition at line 527 of file Leap.py.

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

Reimplemented from Leap::Interface.

Definition at line 523 of file Leap.py.

tuple Leap::Arm::basis = _swig_property(LeapPython.Arm_basis_get) [static]

Definition at line 559 of file Leap.py.

tuple Leap::Arm::center = _swig_property(LeapPython.Arm_center_get) [static]

Definition at line 553 of file Leap.py.

tuple Leap::Arm::direction = _swig_property(LeapPython.Arm_direction_get) [static]

Definition at line 556 of file Leap.py.

tuple Leap::Arm::elbow_position = _swig_property(LeapPython.Arm_elbow_position_get) [static]

Definition at line 562 of file Leap.py.

tuple Leap::Arm::is_valid = _swig_property(LeapPython.Arm_is_valid_get) [static]

Definition at line 568 of file Leap.py.

Definition at line 533 of file Leap.py.

tuple Leap::Arm::width = _swig_property(LeapPython.Arm_width_get) [static]

Definition at line 550 of file Leap.py.

tuple Leap::Arm::wrist_position = _swig_property(LeapPython.Arm_wrist_position_get) [static]

Definition at line 565 of file Leap.py.


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


leap_motion
Author(s): Florian Lier , Mirza Shah , Isaac IY Saito
autogenerated on Sat Jun 8 2019 18:47:25