Tanoda
Leap.Unity.Attachments.AttachmentHand Class Reference

This MonoBehaviour is managed by an AttachmentHands component on a parent MonoBehaviour. Instead of adding AttachmentHand directly to a GameObject, add an AttachmentHands component to a parent GameObject to manage the construction and updating of AttachmentHand objects. More...

Inheritance diagram for Leap.Unity.Attachments.AttachmentHand:

Classes

struct  AttachmentPointsEnumerator
 An enumerator that traverses all of the existing AttachmentPointBehaviours beneath an AttachmentHand. More...
 

Public Member Functions

AttachmentPointBehaviour GetBehaviourForPoint (AttachmentPointFlags singlePoint)
 Returns the AttachmentPointBehaviour child object of this AttachmentHand given a reference to a single AttachmentPointFlags flag, or null if there is no such child object. More...
 
void refreshAttachmentTransforms (AttachmentPointFlags points)
 
void notifyPointBehaviourDeleted (AttachmentPointBehaviour point)
 

Public Attributes

Action OnAttachmentPointsModified = () => { }
 Called when the AttachmentHand refreshes its AttachmentPointBehaviour transforms. If the user unchecks an attachment point in the AttachmentHands inspector, those Transforms will be destroyed; otherwise, existing Transforms will persist, so be careful not to unnecessarily duplicate any objects or components you may want to attach via this callback. More...
 
AttachmentPointBehaviour wrist
 
AttachmentPointBehaviour palm
 
AttachmentPointBehaviour thumbProximalJoint
 
AttachmentPointBehaviour thumbDistalJoint
 
AttachmentPointBehaviour thumbTip
 
AttachmentPointBehaviour indexKnuckle
 
AttachmentPointBehaviour indexMiddleJoint
 
AttachmentPointBehaviour indexDistalJoint
 
AttachmentPointBehaviour indexTip
 
AttachmentPointBehaviour middleKnuckle
 
AttachmentPointBehaviour middleMiddleJoint
 
AttachmentPointBehaviour middleDistalJoint
 
AttachmentPointBehaviour middleTip
 
AttachmentPointBehaviour ringKnuckle
 
AttachmentPointBehaviour ringMiddleJoint
 
AttachmentPointBehaviour ringDistalJoint
 
AttachmentPointBehaviour ringTip
 
AttachmentPointBehaviour pinkyKnuckle
 
AttachmentPointBehaviour pinkyMiddleJoint
 
AttachmentPointBehaviour pinkyDistalJoint
 
AttachmentPointBehaviour pinkyTip
 

Properties

AttachmentPointsEnumerator points [get]
 Gets an enumerator that traverses all of the AttachmentPoints beneath this AttachmentHand. More...
 
Chirality chirality [get, set]
 Gets the chirality of this AttachmentHand. This is set automatically by the AttachmentHands parent object of this AttachmentHand. More...
 
bool isTracked [get, set]
 Gets the chirality of this AttachmentHand. This is set automatically by the AttachmentHands parent object of this AttachmentHand. More...
 

Detailed Description

This MonoBehaviour is managed by an AttachmentHands component on a parent MonoBehaviour. Instead of adding AttachmentHand directly to a GameObject, add an AttachmentHands component to a parent GameObject to manage the construction and updating of AttachmentHand objects.

Definition at line 28 of file AttachmentHand.cs.

Member Function Documentation

◆ GetBehaviourForPoint()

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.GetBehaviourForPoint ( AttachmentPointFlags  singlePoint)

Returns the AttachmentPointBehaviour child object of this AttachmentHand given a reference to a single AttachmentPointFlags flag, or null if there is no such child object.

Definition at line 149 of file AttachmentHand.cs.

◆ notifyPointBehaviourDeleted()

void Leap.Unity.Attachments.AttachmentHand.notifyPointBehaviourDeleted ( AttachmentPointBehaviour  point)

Definition at line 229 of file AttachmentHand.cs.

◆ refreshAttachmentTransforms()

void Leap.Unity.Attachments.AttachmentHand.refreshAttachmentTransforms ( AttachmentPointFlags  points)

Definition at line 186 of file AttachmentHand.cs.

Member Data Documentation

◆ indexDistalJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.indexDistalJoint

Definition at line 60 of file AttachmentHand.cs.

◆ indexKnuckle

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.indexKnuckle

Definition at line 56 of file AttachmentHand.cs.

◆ indexMiddleJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.indexMiddleJoint

Definition at line 58 of file AttachmentHand.cs.

◆ indexTip

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.indexTip

Definition at line 62 of file AttachmentHand.cs.

◆ middleDistalJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.middleDistalJoint

Definition at line 69 of file AttachmentHand.cs.

◆ middleKnuckle

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.middleKnuckle

Definition at line 65 of file AttachmentHand.cs.

◆ middleMiddleJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.middleMiddleJoint

Definition at line 67 of file AttachmentHand.cs.

◆ middleTip

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.middleTip

Definition at line 71 of file AttachmentHand.cs.

◆ OnAttachmentPointsModified

Action Leap.Unity.Attachments.AttachmentHand.OnAttachmentPointsModified = () => { }

Called when the AttachmentHand refreshes its AttachmentPointBehaviour transforms. If the user unchecks an attachment point in the AttachmentHands inspector, those Transforms will be destroyed; otherwise, existing Transforms will persist, so be careful not to unnecessarily duplicate any objects or components you may want to attach via this callback.

Also, you can use AttachmentHand.points for an enumerator of all existing AttachmentPointBehaviour transforms on a given AttachmentHand object.

Definition at line 39 of file AttachmentHand.cs.

◆ palm

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.palm

Definition at line 46 of file AttachmentHand.cs.

◆ pinkyDistalJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.pinkyDistalJoint

Definition at line 87 of file AttachmentHand.cs.

◆ pinkyKnuckle

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.pinkyKnuckle

Definition at line 83 of file AttachmentHand.cs.

◆ pinkyMiddleJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.pinkyMiddleJoint

Definition at line 85 of file AttachmentHand.cs.

◆ pinkyTip

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.pinkyTip

Definition at line 89 of file AttachmentHand.cs.

◆ ringDistalJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.ringDistalJoint

Definition at line 78 of file AttachmentHand.cs.

◆ ringKnuckle

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.ringKnuckle

Definition at line 74 of file AttachmentHand.cs.

◆ ringMiddleJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.ringMiddleJoint

Definition at line 76 of file AttachmentHand.cs.

◆ ringTip

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.ringTip

Definition at line 80 of file AttachmentHand.cs.

◆ thumbDistalJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.thumbDistalJoint

Definition at line 51 of file AttachmentHand.cs.

◆ thumbProximalJoint

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.thumbProximalJoint

Definition at line 49 of file AttachmentHand.cs.

◆ thumbTip

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.thumbTip

Definition at line 53 of file AttachmentHand.cs.

◆ wrist

AttachmentPointBehaviour Leap.Unity.Attachments.AttachmentHand.wrist

Definition at line 44 of file AttachmentHand.cs.

Property Documentation

◆ chirality

Chirality Leap.Unity.Attachments.AttachmentHand.chirality
getset

Gets the chirality of this AttachmentHand. This is set automatically by the AttachmentHands parent object of this AttachmentHand.

Definition at line 111 of file AttachmentHand.cs.

◆ isTracked

bool Leap.Unity.Attachments.AttachmentHand.isTracked
getset

Gets the chirality of this AttachmentHand. This is set automatically by the AttachmentHands parent object of this AttachmentHand.

Definition at line 124 of file AttachmentHand.cs.

◆ points

AttachmentPointsEnumerator Leap.Unity.Attachments.AttachmentHand.points
get

Gets an enumerator that traverses all of the AttachmentPoints beneath this AttachmentHand.

Definition at line 96 of file AttachmentHand.cs.


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