FMAR.Core.CommonHand Class Reference

A "common" hand structure which is capable of representing hands in a universal way, for use in any FMAR modules which use hands. XR Providers can inherit from this class to create a conversion scheme which translates other types of hand structures into a common hand. More...

Inheritance diagram for FMAR.Core.CommonHand:

Classes
struct	Bone
	Contains position/rotation data about an individual bone within the hand. More...

Public Member Functions
	CommonHand ()
void	Update ()
	Called by FMARDeviceManager automatically, overriding classes should use this function to extract hand data from the source and populate bones.
void	PinchUpdate ()
	Called by FMARDeviceManager automatically, handles processing of pinch-detection logic, updates fingerPinchData.
void	Draw ()

Public Attributes
bool	isRight
Bone	rootBone
List< List< Bone > >	fingerBones = new(5)
FingerPinchData[]	fingerPinchData = new FingerPinchData[4]

Protected Attributes
string	name
List< LineRenderer >	lineRends = new(9)
List< LineRenderer >	rootLineRends = new(3)
List< List< Renderer > >	sphereRends = new(5)

Properties
List< Bone >	Thumb [get]
List< Bone >	IndexFinger [get]
List< Bone >	MiddleFinger [get]
List< Bone >	RingFinger [get]
List< Bone >	Pinky [get]

Detailed Description

A "common" hand structure which is capable of representing hands in a universal way, for use in any FMAR modules which use hands. XR Providers can inherit from this class to create a conversion scheme which translates other types of hand structures into a common hand.

Constructor & Destructor Documentation

CommonHand()

FMAR.Core.CommonHand.CommonHand ( )

inline

Member Function Documentation

Draw()

void FMAR.Core.CommonHand.Draw ( )

inline

PinchUpdate()

void FMAR.Core.CommonHand.PinchUpdate ( )

inline

Called by FMARDeviceManager automatically, handles processing of pinch-detection logic, updates fingerPinchData.

Update()

void FMAR.Core.CommonHand.Update ( )

abstract

Called by FMARDeviceManager automatically, overriding classes should use this function to extract hand data from the source and populate bones.

Member Data Documentation

fingerBones

List<List<Bone> > FMAR.Core.CommonHand.fingerBones = new(5)

fingerPinchData

FingerPinchData [] FMAR.Core.CommonHand.fingerPinchData = new FingerPinchData[4]

isRight

bool FMAR.Core.CommonHand.isRight

lineRends

List<LineRenderer> FMAR.Core.CommonHand.lineRends = new(9)

protected

name

string FMAR.Core.CommonHand.name

protected

rootBone

Bone FMAR.Core.CommonHand.rootBone

rootLineRends

List<LineRenderer> FMAR.Core.CommonHand.rootLineRends = new(3)

protected

sphereRends

List<List<Renderer> > FMAR.Core.CommonHand.sphereRends = new(5)

protected

Property Documentation

IndexFinger

List<Bone> FMAR.Core.CommonHand.IndexFinger

get

MiddleFinger

List<Bone> FMAR.Core.CommonHand.MiddleFinger

get

Pinky

List<Bone> FMAR.Core.CommonHand.Pinky

get

RingFinger

List<Bone> FMAR.Core.CommonHand.RingFinger

get

Thumb

List<Bone> FMAR.Core.CommonHand.Thumb

get

---

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

• /github/workspace/Packages/FMAR/Core/Runtime/Scripts/CommonHand.cs