Tanoda
Leap.Arm Class Reference

The Arm class represents the forearm. More...

Inheritance diagram for Leap.Arm:
Leap.Bone

Public Member Functions

 Arm ()
 Constructs a default Arm object. Get valid Arm objects from a Hand object. More...
 
 Arm (Vector elbow, Vector wrist, Vector center, Vector direction, float length, float width, LeapQuaternion rotation)
 Constructs a new Arm object. More...
 
bool Equals (Arm other)
 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. More...
 
override string ToString ()
 A string containing a brief, human readable description of the Arm object. More...
 
- Public Member Functions inherited from Leap.Bone
 Bone ()
 Constructs a default invalid Bone object. More...
 
 Bone (Vector prevJoint, Vector nextJoint, Vector center, Vector direction, float length, float width, Bone.BoneType type, LeapQuaternion rotation)
 Constructs a new Bone object. More...
 
bool Equals (Bone other)
 Compare Bone object equality. More...
 
override string ToString ()
 A string containing a brief, human readable description of the Bone object. More...
 

Properties

Vector ElbowPosition [get]
 The position of the elbow. If not in view, the elbow position is estimated based on typical human anatomical proportions. More...
 
Vector WristPosition [get]
 The position of the wrist. More...
 
- Properties inherited from Leap.Bone
LeapTransform Basis [get]
 The orthonormal basis vectors for this Bone as a Matrix. The orientation of this Bone as a Quaternion. More...
 

Additional Inherited Members

- Public Types inherited from Leap.Bone
enum  BoneType {
  TYPE_INVALID = -1 , TYPE_METACARPAL = 0 , TYPE_PROXIMAL = 1 , TYPE_INTERMEDIATE = 2 ,
  TYPE_DISTAL = 3
}
 Enumerates the type of bones. More...
 
- Public Attributes inherited from Leap.Bone
Vector PrevJoint
 The base of the bone, closest to the wrist. In anatomical terms, this is the proximal end of the bone. More...
 
Vector NextJoint
 The end of the bone, closest to the finger tip. In anatomical terms, this is the distal end of the bone. More...
 
Vector Center
 The midpoint of the bone. More...
 
Vector Direction
 The normalized direction of the bone from base to tip. More...
 
float Length
 The estimated length of the bone. More...
 
float Width
 The average width of the flesh around the bone. More...
 
BoneType Type
 The type of this bone. More...
 
LeapQuaternion Rotation
 The orientation of this Bone as a Quaternion. More...
 

Detailed Description

The Arm class represents the forearm.

Definition at line 16 of file Arm.cs.

Constructor & Destructor Documentation

◆ Arm() [1/2]

Leap.Arm.Arm ( )

Constructs a default Arm object. Get valid Arm objects from a Hand object.

Since
2.0.3

Definition at line 24 of file Arm.cs.

◆ Arm() [2/2]

Leap.Arm.Arm ( Vector  elbow,
Vector  wrist,
Vector  center,
Vector  direction,
float  length,
float  width,
LeapQuaternion  rotation 
)

Constructs a new Arm object.

Since
3.0

Definition at line 30 of file Arm.cs.

Member Function Documentation

◆ Equals()

bool Leap.Arm.Equals ( Arm  other)

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

Definition at line 52 of file Arm.cs.

◆ ToString()

override string Leap.Arm.ToString ( )

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

Since
2.0.3

Definition at line 60 of file Arm.cs.

Property Documentation

◆ ElbowPosition

Vector Leap.Arm.ElbowPosition
get

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

Since
2.0.3

Definition at line 71 of file Arm.cs.

◆ WristPosition

Vector Leap.Arm.WristPosition
get

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

Definition at line 86 of file Arm.cs.


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