Leap Motion C# API Reference  0.8.0
Leap.InteractionBox Class Reference

The InteractionBox class represents a box-shaped region completely within the field of view of the Leap Motion controller. More...

Inherits Leap.Interface.

Public Member Functions

Vector DenormalizePoint (Vector normalizedPosition)
 Converts a position defined by normalized InteractionBox coordinates into device coordinates in millimeters.
 
bool Equals (InteractionBox arg0)
 Compare InteractionBox object equality.
 
Vector NormalizePoint (Vector position, bool clamp)
 Normalizes the coordinates of a point using the interaction box.
 
Vector NormalizePoint (Vector position)
 Normalizes the coordinates of a point using the interaction box.
 
override string ToString ()
 A string containing a brief, human readable description of the InteractionBox object.
 

Properties

Vector Center [get]
 The center of the InteractionBox in device coordinates (millimeters).
 
float Depth [get]
 The depth of the InteractionBox in millimeters, measured along the z-axis.
 
float Height [get]
 The height of the InteractionBox in millimeters, measured along the y-axis.
 
static Device Invalid [get]
 Returns an invalid InteractionBox object.
 
bool IsValid [get]
 Reports whether this is a valid InteractionBox object.
 
float Width [get]
 The width of the InteractionBox in millimeters, measured along the x-axis.
 

Detailed Description

The InteractionBox class represents a box-shaped region completely within the field of view of the Leap Motion controller.

The interaction box is an axis-aligned rectangular prism and provides normalized coordinates for hands, fingers, and tools within this box. The InteractionBox class can make it easier to map positions in the Leap Motion coordinate system to 2D or 3D coordinate systems used for application drawing.

The InteractionBox region is defined by a center and dimensions along the x, y, and z axes.

Member Function Documentation

Vector Leap.InteractionBox.DenormalizePoint ( Vector  normalizedPosition)
inline

Converts a position defined by normalized InteractionBox coordinates into device coordinates in millimeters.

This function performs the inverse of normalizePoint().

Parameters
normalizedPositionThe input position in InteractionBox coordinates.
Returns
The corresponding denormalized position in device coordinates.
bool Leap.InteractionBox.Equals ( InteractionBox  arg0)
inline

Compare InteractionBox object equality.

Two InteractionBox objects are equal if and only if both InteractionBox objects represent the exact same InteractionBox and both InteractionBoxes are valid.

Vector Leap.InteractionBox.NormalizePoint ( Vector  position,
bool  clamp 
)
inline

Normalizes the coordinates of a point using the interaction box.

Coordinates from the Leap Motion frame of reference (millimeters) are converted to a range of [0..1] such that the minimum value of the InteractionBox maps to 0 and the maximum value of the InteractionBox maps to 1.

Parameters
positionThe input position in device coordinates.
clampWhether or not to limit the output value to the range [0,1] when the input position is outside the InteractionBox. Defaults to true.
Returns
The normalized position.
Vector Leap.InteractionBox.NormalizePoint ( Vector  position)
inline

Normalizes the coordinates of a point using the interaction box.

Coordinates from the Leap Motion frame of reference (millimeters) are converted to a range of [0..1] such that the minimum value of the InteractionBox maps to 0 and the maximum value of the InteractionBox maps to 1.

Parameters
positionThe input position in device coordinates.
Returns
The normalized position.
override string Leap.InteractionBox.ToString ( )
inline

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

Returns
A description of the InteractionBox as a string.

Property Documentation

Vector Leap.InteractionBox.Center
get

The center of the InteractionBox in device coordinates (millimeters).

This point is equidistant from all sides of the box.

Returns
The InteractionBox center in device coordinates.
float Leap.InteractionBox.Depth
get

The depth of the InteractionBox in millimeters, measured along the z-axis.

Returns
The InteractionBox depth in millimeters.
float Leap.InteractionBox.Height
get

The height of the InteractionBox in millimeters, measured along the y-axis.

Returns
The InteractionBox height in millimeters.
Device Leap.InteractionBox.Invalid
staticget

Returns an invalid InteractionBox object.

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

Returns
The invalid InteractionBox instance.
bool Leap.InteractionBox.IsValid
get

Reports whether this is a valid InteractionBox object.

Returns
True, if this InteractionBox object contains valid data.
float Leap.InteractionBox.Width
get

The width of the InteractionBox in millimeters, measured along the x-axis.

Returns
The InteractionBox width in millimeters.