Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

initial Hand-API update #9855

Merged
merged 3 commits into from
Jan 27, 2021
Merged

initial Hand-API update #9855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53601ce
initial Hand-API update
RaananW Jan 27, 2021
5f78a36
revert changes to webxr dec
RaananW Jan 27, 2021
ec949af
missing def
RaananW Jan 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/LibDeclarations/webxr.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ interface XRSession {
* canceling the callback using cancelAnimationFrame(). This method is comparable
* to the Window.requestAnimationFrame() method.
*/
requestAnimationFrame: XRFrameRequestCallback;
requestAnimationFrame: (callback: XRFrameRequestCallback) => void;
/**
* Requests that a new XRReferenceSpace of the specified type be created.
* Returns a promise which resolves with the XRReferenceSpace or
Expand Down Expand Up @@ -315,11 +315,16 @@ interface XRJointPose extends XRPose {
radius: number | undefined;
}

// to be extended
type XRHandJoint = string;

interface XRHand extends Iterable<XRJointSpace> {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

XRHand is not an array anymore; instead it's a map: iterable<XRHandJoint, XRJointSpace>

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is to first get the hands working again.
I am already implementing a new version using the fillXXX functions to create less objects per frame.
XRHandJoint is technically not a string but a collection of predefined strings. To avoid back-compat issues i didn't change it yet, but this is coming together with the new PR as well.

readonly length: number;
readonly size: number;

[index: number]: XRJointSpace;

get(joint: XRHandJoint): XRJointSpace;

readonly WRIST: number;

readonly THUMB_METACARPAL: number;
Expand Down
81 changes: 71 additions & 10 deletions src/XR/features/WebXRHandTracking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,67 @@ export const enum HandPart {
LITTLE = "little",
}

enum XRHandJoint {
"wrist" = "wrist",

"thumb-metacarpal" = "thumb-metacarpal",
"thumb-phalanx-proximal" = "thumb-phalanx-proximal",
"thumb-phalanx-distal" = "thumb-phalanx-distal",
"thumb-tip" = "thumb-tip",

"index-finger-metacarpal" = "index-finger-metacarpal",
"index-finger-phalanx-proximal" = "index-finger-phalanx-proximal",
"index-finger-phalanx-intermediate" = "index-finger-phalanx-intermediate",
"index-finger-phalanx-distal" = "index-finger-phalanx-distal",
"index-finger-tip" = "index-finger-tip",

"middle-finger-metacarpal" = "middle-finger-metacarpal",
"middle-finger-phalanx-proximal" = "middle-finger-phalanx-proximal",
"middle-finger-phalanx-intermediate" = "middle-finger-phalanx-intermediate",
"middle-finger-phalanx-distal" = "middle-finger-phalanx-distal",
"middle-finger-tip" = "middle-finger-tip",

"ring-finger-metacarpal" = "ring-finger-metacarpal",
"ring-finger-phalanx-proximal" = "ring-finger-phalanx-proximal",
"ring-finger-phalanx-intermediate" = "ring-finger-phalanx-intermediate",
"ring-finger-phalanx-distal" = "ring-finger-phalanx-distal",
"ring-finger-tip" = "ring-finger-tip",

"pinky-finger-metacarpal" = "pinky-finger-metacarpal",
"pinky-finger-phalanx-proximal" = "pinky-finger-phalanx-proximal",
"pinky-finger-phalanx-intermediate" = "pinky-finger-phalanx-intermediate",
"pinky-finger-phalanx-distal" = "pinky-finger-phalanx-distal",
"pinky-finger-tip" = "pinky-finger-tip",
}

const handJointReferenceArray: XRHandJoint[] = [
XRHandJoint.wrist,
XRHandJoint["thumb-metacarpal"],
XRHandJoint["thumb-phalanx-proximal"],
XRHandJoint["thumb-phalanx-distal"],
XRHandJoint["thumb-tip"],
XRHandJoint["index-finger-metacarpal"],
XRHandJoint["index-finger-phalanx-proximal"],
XRHandJoint["index-finger-phalanx-intermediate"],
XRHandJoint["index-finger-phalanx-distal"],
XRHandJoint["index-finger-tip"],
XRHandJoint["middle-finger-metacarpal"],
XRHandJoint["middle-finger-phalanx-proximal"],
XRHandJoint["middle-finger-phalanx-intermediate"],
XRHandJoint["middle-finger-phalanx-distal"],
XRHandJoint["middle-finger-tip"],
XRHandJoint["ring-finger-metacarpal"],
XRHandJoint["ring-finger-phalanx-proximal"],
XRHandJoint["ring-finger-phalanx-intermediate"],
XRHandJoint["ring-finger-phalanx-distal"],
XRHandJoint["ring-finger-tip"],
XRHandJoint["pinky-finger-metacarpal"],
XRHandJoint["pinky-finger-phalanx-proximal"],
XRHandJoint["pinky-finger-phalanx-intermediate"],
XRHandJoint["pinky-finger-phalanx-distal"],
XRHandJoint["pinky-finger-tip"],
];

/**
* Representing a single hand (with its corresponding native XRHand object)
*/
Expand All @@ -144,7 +205,7 @@ export class WebXRHand implements IDisposable {
/**
* Hand-parts definition (key is HandPart)
*/
public handPartsDefinition: { [key: string]: number[] };
public handPartsDefinition: { [key: string]: string[] };

/**
* Observers will be triggered when the mesh for this hand was initialized.
Expand All @@ -157,12 +218,12 @@ export class WebXRHand implements IDisposable {
*/
private generateHandPartsDefinition(hand: XRHand) {
return {
[HandPart.WRIST]: [hand.WRIST],
[HandPart.THUMB]: [hand.THUMB_METACARPAL, hand.THUMB_PHALANX_PROXIMAL, hand.THUMB_PHALANX_DISTAL, hand.THUMB_PHALANX_TIP],
[HandPart.INDEX]: [hand.INDEX_METACARPAL, hand.INDEX_PHALANX_PROXIMAL, hand.INDEX_PHALANX_INTERMEDIATE, hand.INDEX_PHALANX_DISTAL, hand.INDEX_PHALANX_TIP],
[HandPart.MIDDLE]: [hand.MIDDLE_METACARPAL, hand.MIDDLE_PHALANX_PROXIMAL, hand.MIDDLE_PHALANX_INTERMEDIATE, hand.MIDDLE_PHALANX_DISTAL, hand.MIDDLE_PHALANX_TIP],
[HandPart.RING]: [hand.RING_METACARPAL, hand.RING_PHALANX_PROXIMAL, hand.RING_PHALANX_INTERMEDIATE, hand.RING_PHALANX_DISTAL, hand.RING_PHALANX_TIP],
[HandPart.LITTLE]: [hand.LITTLE_METACARPAL, hand.LITTLE_PHALANX_PROXIMAL, hand.LITTLE_PHALANX_INTERMEDIATE, hand.LITTLE_PHALANX_DISTAL, hand.LITTLE_PHALANX_TIP],
[HandPart.WRIST]: [XRHandJoint.wrist],
[HandPart.THUMB]: [XRHandJoint["thumb-metacarpal"], XRHandJoint["thumb-phalanx-proximal"], XRHandJoint["thumb-phalanx-distal"], XRHandJoint["thumb-tip"]],
[HandPart.INDEX]: [XRHandJoint["index-finger-metacarpal"], XRHandJoint["index-finger-phalanx-proximal"], XRHandJoint["index-finger-phalanx-intermediate"], XRHandJoint["index-finger-phalanx-distal"], XRHandJoint["index-finger-tip"]],
[HandPart.MIDDLE]: [XRHandJoint["middle-finger-metacarpal"], XRHandJoint["middle-finger-phalanx-proximal"], XRHandJoint["middle-finger-phalanx-intermediate"], XRHandJoint["middle-finger-phalanx-distal"], XRHandJoint["middle-finger-tip"]],
[HandPart.RING]: [XRHandJoint["ring-finger-metacarpal"], XRHandJoint["ring-finger-phalanx-proximal"], XRHandJoint["ring-finger-phalanx-intermediate"], XRHandJoint["ring-finger-phalanx-distal"], XRHandJoint["ring-finger-tip"]],
[HandPart.LITTLE]: [XRHandJoint["pinky-finger-metacarpal"], XRHandJoint["pinky-finger-phalanx-proximal"], XRHandJoint["pinky-finger-phalanx-intermediate"], XRHandJoint["pinky-finger-phalanx-distal"], XRHandJoint["pinky-finger-tip"]],
};
}

Expand Down Expand Up @@ -257,7 +318,7 @@ export class WebXRHand implements IDisposable {
return;
}
this.trackedMeshes.forEach((mesh, idx) => {
const xrJoint = hand[idx];
const xrJoint = hand.get(handJointReferenceArray[idx]);
if (xrJoint) {
let pose = xrFrame.getJointPose!(xrJoint, referenceSpace);
if (!pose || !pose.transform) {
Expand Down Expand Up @@ -322,7 +383,7 @@ export class WebXRHand implements IDisposable {
* @returns An array of meshes that correlate to the hand part requested
*/
public getHandPartMeshes(part: HandPart): AbstractMesh[] {
return this.handPartsDefinition[part].map((idx) => this.trackedMeshes[idx]);
return this.handPartsDefinition[part].map((idx) => this.trackedMeshes[handJointReferenceArray.indexOf(idx as XRHandJoint)]);
}

/**
Expand Down Expand Up @@ -563,7 +624,7 @@ export class WebXRHandTracking extends WebXRAbstractFeature {
const originalMesh = this.options.jointMeshes?.sourceMesh || SphereBuilder.CreateSphere("jointParent", { diameter: 1 });
originalMesh.scaling.set(0.01, 0.01, 0.01);
originalMesh.isVisible = !!this.options.jointMeshes?.keepOriginalVisible;
for (let i = 0; i < hand.length; ++i) {
for (let i = 0; i < hand.size; ++i) {
let newInstance: AbstractMesh = originalMesh.createInstance(`${xrController.uniqueId}-handJoint-${i}`);
if (this.options.jointMeshes?.onHandJointMeshGenerated) {
const returnedMesh = this.options.jointMeshes.onHandJointMeshGenerated(newInstance as InstancedMesh, i, xrController.uniqueId);
Expand Down