Tanoda
Leap.LeapQuaternion Struct Reference

The LeapQuaternion struct represents a rotation in three-dimensional space. More...

Inheritance diagram for Leap.LeapQuaternion:

Public Member Functions

 LeapQuaternion (float x, float y, float z, float w)
 Creates a new LeapQuaternion with the specified component values. More...
 
 LeapQuaternion (LeapQuaternion quaternion)
 Copies the specified LeapQuaternion. More...
 
 LeapQuaternion (LeapInternal.LEAP_QUATERNION quaternion)
 Copies the specified LEAP_QUATERNION. More...
 
override string ToString ()
 Returns a string containing this quaternion in a human readable format: (x, y, z). More...
 
bool Equals (LeapQuaternion v)
 Compare LeapQuaternion equality component-wise. More...
 
override bool Equals (Object obj)
 
bool IsValid ()
 Returns true if all of the quaternion's components are finite. If any component is NaN or infinite, then this returns false. More...
 
LeapQuaternion Multiply (LeapQuaternion rhs)
 Concatenates the rotation described by this quaternion with the one provided and returns the result. More...
 
override int GetHashCode ()
 

Public Attributes

float x
 
float y
 
float z
 
float w
 

Static Public Attributes

static readonly LeapQuaternion Identity = new LeapQuaternion(0, 0, 0, 1)
 The identity quaternion. More...
 

Properties

float Magnitude [get]
 The magnitude, or length, of this quaternion. More...
 
float MagnitudeSquared [get]
 The square of the magnitude, or length, of this quaternion. More...
 
LeapQuaternion Normalized [get]
 A normalized copy of this quaternion. More...
 

Detailed Description

The LeapQuaternion struct represents a rotation in three-dimensional space.

Since
3.1.2

Definition at line 17 of file LeapQuaternion.cs.

Constructor & Destructor Documentation

◆ LeapQuaternion() [1/3]

Leap.LeapQuaternion.LeapQuaternion ( float  x,
float  y,
float  z,
float  w 
)

Creates a new LeapQuaternion with the specified component values.

Since
3.1.2

Definition at line 24 of file LeapQuaternion.cs.

◆ LeapQuaternion() [2/3]

Leap.LeapQuaternion.LeapQuaternion ( LeapQuaternion  quaternion)

Copies the specified LeapQuaternion.

Since
3.1.2

Definition at line 36 of file LeapQuaternion.cs.

◆ LeapQuaternion() [3/3]

Leap.LeapQuaternion.LeapQuaternion ( LeapInternal.LEAP_QUATERNION  quaternion)

Copies the specified LEAP_QUATERNION.

Since
3.1.2

Definition at line 48 of file LeapQuaternion.cs.

Member Function Documentation

◆ Equals() [1/2]

bool Leap.LeapQuaternion.Equals ( LeapQuaternion  v)

Compare LeapQuaternion equality component-wise.

Since
3.1.2

Definition at line 68 of file LeapQuaternion.cs.

◆ Equals() [2/2]

override bool Leap.LeapQuaternion.Equals ( Object  obj)

Definition at line 71 of file LeapQuaternion.cs.

◆ GetHashCode()

override int Leap.LeapQuaternion.GetHashCode ( )

Definition at line 142 of file LeapQuaternion.cs.

◆ IsValid()

bool Leap.LeapQuaternion.IsValid ( )

Returns true if all of the quaternion's components are finite. If any component is NaN or infinite, then this returns false.

Since
3.1.2

Definition at line 80 of file LeapQuaternion.cs.

◆ Multiply()

LeapQuaternion Leap.LeapQuaternion.Multiply ( LeapQuaternion  rhs)

Concatenates the rotation described by this quaternion with the one provided and returns the result.

Since
3.1.2

Definition at line 128 of file LeapQuaternion.cs.

◆ ToString()

override string Leap.LeapQuaternion.ToString ( )

Returns a string containing this quaternion in a human readable format: (x, y, z).

Since
3.1.2

Definition at line 60 of file LeapQuaternion.cs.

Member Data Documentation

◆ Identity

readonly LeapQuaternion Leap.LeapQuaternion.Identity = new LeapQuaternion(0, 0, 0, 1)
static

The identity quaternion.

Since
3.1.2

Definition at line 140 of file LeapQuaternion.cs.

◆ w

float Leap.LeapQuaternion.w

Definition at line 90 of file LeapQuaternion.cs.

◆ x

float Leap.LeapQuaternion.x

Definition at line 87 of file LeapQuaternion.cs.

◆ y

float Leap.LeapQuaternion.y

Definition at line 88 of file LeapQuaternion.cs.

◆ z

float Leap.LeapQuaternion.z

Definition at line 89 of file LeapQuaternion.cs.

Property Documentation

◆ Magnitude

float Leap.LeapQuaternion.Magnitude
get

The magnitude, or length, of this quaternion.

Since
3.1.2

Definition at line 96 of file LeapQuaternion.cs.

◆ MagnitudeSquared

float Leap.LeapQuaternion.MagnitudeSquared
get

The square of the magnitude, or length, of this quaternion.

Since
3.1.2

Definition at line 104 of file LeapQuaternion.cs.

◆ Normalized

LeapQuaternion Leap.LeapQuaternion.Normalized
get

A normalized copy of this quaternion.

Since
3.1.2

Definition at line 112 of file LeapQuaternion.cs.


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