-
Notifications
You must be signed in to change notification settings - Fork 1
/
hifi.d.ts
3786 lines (3634 loc) · 131 KB
/
hifi.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// TODO: Name collisions between Hifi and browser defaults:
// (location Window Selection)
// Likely need to figure out a tsconfig.json format that excludes the default .d.ts files.
//
// TODO: Signals are not typesafe.
// All return values of Signal should be replaced with
// Signal<(arg:type, arg:type, ...)=>void>
//
// TODO: There are a number of places that the documentation doesn't provide actual types
// Reasonable guesses were made where possible, 'any' was used for the rest.
declare enum ContactEventType {
startCollision = 0,
continuedCollision = 1,
endCollsion = 2
}
declare enum KeyboardModifiers {
Shift = 0x02000000,
Control = 0x04000000,
Alt = 0x08000000,
Meta = 0x010000000,
Keypad = 0x20000000,
Group = 0x40000000
}
declare enum PickType {
Ray,
Stylus,
Parabola,
Collision
}
declare enum ShapeType {
"none",
"box",
"sphere",
"capsule-x",
"capsule-y",
"capsule-z",
"cylinder-x",
"cylinder-y",
"cylinder-z",
"hull",
"compound",
"simple-hull",
"simple-compound",
"static-mesh",
"plane"
}
declare class AACube {
x: number;
y: number;
scale: number;
}
declare class AttachmentData {
modelUrl: string;
jointName: string;
translation: Vec3;
rotation: Vec3;
scale: number;
soft: boolean;
}
declare type BoxFace = "MIN_X_FACE" | "MAX_X_FACE" | "MIN_Y_FACE" |
"MAX_Y_FACE" | "MIN_Z_FACE" | "MAX_Z_FACE" | "UNKNOWN_FACE";
declare class Collision {
type: ContactEventType;
idA: Uuid;
idB: Uuid;
penetration: Vec3;
contactPoint: Vec3;
velocityChange: Vec3;
}
declare class CollisionContact {
pointOnPick: Vec3;
pointOnObject: Vec3;
normalOnPick: Vec3;
}
declare class CollisionPickResult {
intersects: boolean;
intersectingObjects: Array<IntersectingObject>;
collisionRegion: CollisionRegion;
}
declare type CollisionMask = any;
declare class CollisionRegion {
shape: Shape;
position: Vec3;
orientation: Quat;
threshhold: number;
collisionGroup: CollisionMask;
parentID: Uuid;
parentJointIndex: number;
joint: string;
}
type rgbColor = {
r?: number;
g?: number;
b?: number;
}
type xyzColor = {
x?: number;
y?: number;
z?: number;
}
type redGreenBlueColor = {
red?: number;
green?: number;
blue?: number;
}
declare type Color = rgbColor | xyzColor | redGreenBlueColor;
declare type ColorFloat = Color;
declare class FBXAnimationFrame {
rotations: Array<Quat>;
translations: Array<Vec3>;
}
declare class IntersectingObject {
id: Uuid;
type: number;
collisionContacts: Array<CollisionContact>;
}
declare class KeyEvent {
key?: number;
text?: string;
isShifted?: boolean;
isMeta?: boolean;
isControl?: boolean;
isAlt?: boolean;
isKeypad?: boolean;
isAutoRepeat?: boolean;
}
declare class Material {
name?: string;
model?: string;
emissive?: Color | RGBS;
opacity?: number;
unlit?: boolean;
albedo?: Color | RGBS;
roughness?: number;
metallic?: number;
scattering?: number;
emissiveMap?: string;
albedoMap?: string;
opacityMap?: string;
roughnessMap?: string;
glossMap?: string;
metallicMap?: string;
specularMap?: string;
normalMap?: string;
bumpMap?: string;
occlusionMap?: string;
scatteringMap?: string;
lightMap?: string;
}
declare class MaterialResource {
materialVersion?: number;
materials?: Material | Array<Material>;
}
declare class MouseEvent {
x?: number;
y?: number;
button?: string;
isLeftButton?: boolean;
isMiddleButton?: boolean;
isRightButton?: boolean;
isShifted?: boolean;
isMeta?: boolean;
isControl?: boolean;
isAlt?: boolean;
}
declare class ParabolaPickResult {
type: number;
intersects: boolean;
objectID: Uuid;
distance: number;
parabolicDistance: number;
intersection: Vec3;
surfaceNormal: Vec3;
extraInfo: any;
parabola: PickParabola;
}
declare class PointerEvent {
type?: string;
id?: number;
pos2d?: Vec2;
pos3D?: Vec3;
normal?: Vec3;
direction?: Vec3;
button?: string;
isPrimaryButton?: boolean;
isLeftButton?: boolean;
isSecondaryButton?: boolean;
isRightButton?: boolean;
isTertiaryButton?: boolean;
isMiddleButton?: boolean;
isPrimaryHeld?: boolean;
isSecondaryHeld?: boolean;
isTertiaryHeld?: boolean;
keyboardModifiers?: KeyboardModifiers;
}
declare class Pose {
translation: Vec3;
rotation: Quat;
velocity: Vec3;
angularVelocity: Vec3;
valid: boolean;
}
declare class RayPickResult {
type: number;
intersects: boolean;
objectID: Uuid;
distance: number;
intersection: Vec3;
surfaceNormal: Vec3;
extraInfo: any;
searchRay: PickRay;
}
declare type Rect = {
x: number;
y: number;
width: number;
height: number;
}
declare type RGBS = Array<number>;
declare type Shape = {
shapeType?: ShapeType;
dimensions?: Vec3;
}
declare class Size {
height: number;
width: number;
}
declare class StylusPickResult {
type: number;
intersects: boolean;
objectID: Uuid;
distance: number;
intersection: Vec3;
surfaceNormal: Vec3;
extraInfo: any;
stylusTip: StylusTip;
}
declare class StylusTip {
side: number;
position: Vec3;
orientation: Quat;
velocity: Vec3;
}
declare class TouchEvent {
x: number;
y: number;
isPressed: boolean;
isMoved: boolean;
isStationary: boolean;
isReleased: boolean;
isShifted: boolean;
isMeta: boolean;
isControl: boolean;
isAlt: boolean;
touchPoints: number;
points: Array<Vec2>;
radius: number;
isPinching: boolean;
isPinchOpening: boolean;
angle: number;
deltaAngle: number;
angles: Array<number>;
isRotating: boolean;
rotating: string;
}
declare class Vec2 {
x?: number;
y?: number;
}
declare class Vec4 {
x?: number;
y?: number;
z?: number;
w?: number;
}
declare class ViewFrustum {
position: Vec3;
orientation: Quat;
centerRadius: number;
fieldOfView: number;
apsectRatio: number;
projection: Mat4;
}
declare class WheelEvent {
x: number;
y: number;
delta: number;
orientation: string;
isLeftButton: boolean;
isMiddleButton: boolean;
isRightButton: boolean;
isShifted: boolean;
isMeta: boolean;
isControl: boolean;
isAlt: boolean;
}
declare class Signal<F = Function> {
connect(callback: F): void;
disconnect(callback: F): void;
}
declare class PickParabola {
origin: Vec3;
velocity: Vec3;
acceleration: Vec3;
}
declare class PickRay {
origin: Vec3;
direction: Vec3;
}
declare class Agent {
static setIsAvatar(isAvatar: boolean): void;
static isAvatar(): boolean;
static playAvatarSound(avatarSound: object): void;
isAvatar: boolean;
isPlayingAvatarSound: boolean;
isListeningToAudioStream: boolean;
isNoiseGateEnabled: boolean;
lastReceivedAudioLoudness: number;
sessionUUID: Uuid;
}
declare class Avatar {
static startAnimation(url: string, fps: number, priority: number, loop: boolean, hold: boolean, firstFrame: number, lastFrame: number, maskedJoints: Array<string>): void;
static stopAnimation(): void;
static getAnimationDetails(): Avatar.AnimationDetails;
static getDomainMinScale(): number;
static getDomainMaxScale(): number;
static getEyeHeight(): number;
static getHeight(): number;
static setHandState(state: string): void;
static getHandState(): string;
static setRawJointData(data: Array<JointData>): void;
static setJointData(index: number, rotation: Quat, translation: Vec3): void;
static setJointData(name: string, rotation: Quat, translation: Vec3): void;
static setJointRotation(index: number, rotation: Quat): void;
static setJointRotation(name: string, rotation: Quat): void;
static setJointTranslation(index: number, translation: Vec3): void;
static setJointTranslation(name: string, translation: Vec3): void;
static clearJointData(index: number): void;
static clearJointData(name: string): void;
static isJointDataValid(index: number): boolean;
static isJointDataValid(name: string): boolean;
static getJointRotation(index: number): Quat;
static getJointRotation(name: string): Quat;
static getJointTranslation(index: number): Vec3;
static getJointTranslation(name: number): Vec3;
static getJointRotations(): Array<Quat>;
static getJointTranslations(): Array<Vec3>;
static setJointRotations(jointRotations: Array<Quat>): void;
static setJointTranslations(translations: Array<Vec3>): void;
static clearJointsData(): void;
static getJointIndex(name: string): number;
static getJointNames(): Array<string>;
static setBlendshape(name: string, value: number): void;
static getAttachmentsVariant(): object;
static setAttachmentsVariant(variant: object): void;
static updateAvatarEntity(entityID: Uuid, entityData: string): void;
static clearAvatarEntity(entityID: Uuid): void;
static setForceFaceTrackerConnected(connected: boolean): void;
static getAttachmentData(): Array<AttachmentData>;
static setAttachmentData(attachmentData: Array<AttachmentData>): void;
static attach(modelURL: string, jointName: string, translation: Vec3, rotation: Quat, scale: number, isSoft: boolean, allowDuplicates: boolean, useSaved: boolean): void;
static detachOne(modelURL: string, jointName: string): void;
static detachAll(modelURL: string, jointName: string): void;
static getAvatarEntityData(): object;
static setAvatarEntityData(avatarEntityData: object): void;
static getSensorToWorldMatrix(): Mat4;
static getSensorToWorldScale(): number;
static getControllerLeftHandMatrix(): Mat4;
static getControllerRightHandMatrix(): Mat4;
static getDataRate(rateName: string): number;
static getUpdateRate(rateName: string): number;
static displayNameChanged: Signal;
static sessionDisplayNameChanged: Signal;
static skeletonModelURLChanged: Signal;
static lookAtSnappingChanged: Signal;
static sessionUUIDChanged: Signal;
static sendAvatarDataPacket(sendAll: boolean): void;
static sendIdentityPacket(): void;
static setJointMappingsFromNetworkReply(): void;
static setSessionUUID(sessionUUID: Uuid): void;
static getAbsoluteJointRotationInObjectFrame(index: number): Quat;
static getAbsoluteJointTranslationInObjectFrame(index: number): Vec3;
static setAbsoluteJointRotationInObjectFrame(index: number, rotation: Quat): boolean;
static setAbsoluteJointTranslationInObjectFrame(index: number, translation: Vec3): boolean;
static getTargetScale(): number;
static resetLastSent(): void;
position: Vec3;
scale: number;
density: number;
handPosition: Vec3;
bodyYaw: number;
bodyPitch: number;
bodyRoll: number;
orientation: Quat;
headOrientation: Quat;
headPitch: number;
headYaw: number;
headRoll: number;
velocity: Vec3;
angularVelocity: Vec3;
audioLoudness: number;
audioAverageLoudness: number;
displayName: string;
sessionDisplayName: string;
lookAtSnappingEnabled: boolean;
skeletonModelURL: string;
attachmentData: Array<AttachmentData>;
jointNames: Array<string>;
sessionUUID: Uuid;
sensorToWorldMatrix: Mat4;
controllerLeftHandMatrix: Mat4;
controllerRightHandMatrix: Mat4;
sensorToWorldScale: number;
}
declare namespace Avatar {
class AnimationDetails {
role: string;
url: string;
fps: number;
priority: number;
loop: boolean;
hold: boolean;
startAutomatically: boolean;
firstFrame: number;
lastFrame: number;
running: boolean;
currentFrame: number;
allowTranslation: boolean;
}
class AttachmentData {
modelUrl: string;
joinname: string;
translation: Vec3;
rotation: Vec3;
scale: number;
soft: boolean;
}
}
declare class JointData {
}
declare class EntityViewer {
static setPosition(position: Vec3): void;
static setOrientation(orientation: Quat): void;
static setCenterRadius(radius: number): void;
static setKeyholeRadius(radius: number): void;
static setVoxelSizeScale(sizeScale: number): void;
static setBoundaryLevelAdjust(boundaryLevelAdjust: number): void;
static setMaxPacketsPerSecond(maxPacketsPerSecond: number): void;
static getPosition(): Vec3;
static getOrientation(): Quat;
static getVoxelSizeScale(): number;
static getBoundaryLevelAdjust(): number;
static getMaxPacketsPerSecond(): number;
static getOctreeElementsCount(): number;
}
declare class HifiAbout {
static openUrl(url: string): void;
buildDate: string;
buildVersion: string;
qtVersion: string;
}
declare class AvatarBookmarks {
static addBookMark(): void;
static bookmarkLoaded: Signal;
static bookmarkDeleted: Signal;
static bookmarkAdded: Signal;
static deleteBookmark(): void;
}
declare class LocationBookmarks {
static deleteBookmark(): void;
static addBookmark(): void;
static setHomeLocationToAddress(address: string): void;
}
declare class LODManager {
static setAutomaticLODAdjust(value: boolean): void;
static getAutomaticLODAdjust(): boolean;
static setDesktopLODTargetFPS(value: number): void;
static getDesktopLODTargetFPS(): number;
static setHMDLODTargetFPS(value: number): void;
static getHMDLODTargetFPS(): number;
static getLODFeedbackText(): string;
static setOctreeSizeScale(sizeScale: number): void;
static getOctreeSizeScale(): number;
static setBoundaryLevelAdjust(boundaryLevelAdjust: number): void;
static getBoundaryLevelAdjust(): number;
static getLODTargetFPS(): number;
static LODIncreased: Signal;
static LODDecreased: Signal;
presentTime: number;
engineRunTime: number;
gpuTime: number;
avgRenderTime: number;
fps: number;
lodLevel: number;
lodDecreaseFPS: number;
lodIncreaseFPS: number;
}
declare class SpeechRecognizer {
static setEnabled(enabled: boolean): void;
static addCommand(command: string): void;
static removeCommand(command: string): void;
static commandRecognized: Signal;
static enabledUpdated: Signal;
}
declare class AudioScope {
static toggle(): void;
static setVisible(visible: boolean): void;
static getVisible(): boolean;
static togglePause(): void;
static setPause(paused: boolean): void;
static getPause(): boolean;
static toggleTrigger(): void;
static getAutoTrigger(): boolean;
static setAutoTrigger(autoTrigger: boolean): void;
static setTriggerValues(x: number, y: number): void;
static setTriggered(triggered: boolean): void;
static getTriggered(): boolean;
static getFramesPerSecond(): number;
static getFramesPerScope(): number;
static selectAudioScopeFiveFrames(): void;
static selectAudioScopeTwentyFrames(): void;
static selectAudioScopeFiftyFrames(): void;
static getScopeInput(): Array<number>;
static getScopeOutputLeft(): Array<number>;
static getScopeOutputRight(): Array<number>;
static getTriggerInput(): Array<number>;
static getTriggerOutputLeft(): Array<number>;
static getTriggerOutputRight(): Array<number>;
static setLocalEcho(): void;
static setServerEcho(): void;
static pauseChanged: Signal;
static triggered: Signal;
scopeInput: number;
scopeOutputLeft: number;
scopeOutputRight: number;
triggerInput: number;
triggerOutputLeft: number;
triggerOutputRight: number;
}
declare type AvatarData = Avatar;
declare type RayToAvatarIntersectionResult = any;
declare class AvatarManager {
static getAvatar(avatarID: Uuid): AvatarData;
static getAvatarDataRate(sessionID: Uuid, rateName: string): number;
static getAvatarUpdateRate(sessionID: Uuid, rateName: string): number;
static getAvatarSimulationRate(sessionID: Uuid, rateName: string): number;
static findRayIntersection(ray: PickRay, avatarsToInclude: Array<Uuid>, avatarsToDiscard: Array<Uuid>): RayToAvatarIntersectionResult;
static findRayIntersectionVector(ray: PickRay, avatarsToInclude: Array<Uuid>, avatarsToDiscard: Array<Uuid>): RayToAvatarIntersectionResult;
static getAvatarSortCoefficient(name: string): number;
static setAvatarSortCoefficient(name: string, value: number): void;
static getPalData(specificAvatarIdentifiers: Array<string>): object;
static updateAvatarRenderStatus(shouldRenderAvatars: boolean): void;
static getAvatarIdentifiers(): Array<Uuid>;
static getAvatarsInRange(position: Vec3, range: number): Array<Uuid>;
static avatarAddedEvent: Signal;
static avatarRemovedEvent: Signal;
static avatarSessionChangedEvent: Signal;
static isAvatarInRange(position: string, range: string): boolean;
static sessionUUIDChanged(sessionUUID: Uuid, oldSessionUUID: Uuid): void;
static processAvatarDataPacket(message: string, sendingNode: Uuid): void;
static processAvatarIdentityPacket(message: string, sendingNode: Uuid): void;
static processKillAvatar(message: string, sendingNode: Uuid): void;
}
declare type DriveKeys = string;
declare class MyAvatar {
static resetSensorsAndBody(): void;
static centerBody(): void;
static clearIKJointLimitHistory(): void;
static setOrientationVar(newOrientationVar: object): void;
static getOrientationVar(): object;
static getDefaultEyePosition(): Vec3;
static overrideAnimation(url: string, fps: number, loop: boolean, firstFrame: number, lastFrame: number): void;
static restoreAnimation(): void;
static getAnimationRoles(): Array<string>;
static overrideRoleAnimation(role: string, url: string, fps: number, loop: boolean, firstFrame: number, lastFrame: number): void;
static restoreRoleAnimation(role: string): void;
static removeAnimationStateHandler(handler: number): void;
static getSnapTurn(): boolean;
static setSnapTurn(on: boolean): void;
static setDominantHand(hand: string): void;
static getDominantHand(): string;
static setCenterOfGravityModelEnabled(enabled: boolean): void;
static getCenterOfGravityModelEnabled(): boolean;
static setHMDLeanRecenterEnabled(enabled: boolean): void;
static getHMDLeanRecenterEnabled(): boolean;
static requestEnableHandTouch(): void;
static requestDisableHandTouch(): void;
static disableHandTouchForID(entityID: Uuid): void;
static enableHandTouchForID(entityID: Uuid): void;
static getRawDriveKey(key: DriveKeys): number;
static disableDriveKey(key: DriveKeys): void;
static enableDriveKey(key: DriveKeys): void;
static isDriveKeyDisabled(key: DriveKeys): boolean;
static triggerVerticalRecenter(): void;
static triggerRotationRecenter(): void;
static isRecenteringHorizontally(): void;
static getHeadPosition(): Vec3;
static getHeadFinalYaw(): number;
static getHeadFinalRoll(): number;
static getHeadFinalPitch(): number;
static getHeadDeltaPitch(): number;
static getEyePosition(): Vec3;
static getTargetAvatarPosition(): Vec3;
static getTargetAvatar(): AvatarData;
static getLeftHandPosition(): Vec3;
static getRightHandPosition(): Vec3;
static getLeftHandTipPosition(): Vec3;
static getRightHandTipPosition(): Vec3;
static getLeftHandPose(): Pose;
static getRightHandPose(): Pose;
static getLeftHandTipPose(): Pose;
static getRightHandTipPose(): Pose;
static worldToJointPoint(position: Vec3, jointIndex: number): Vec3;
static worldToJointDirection(direction: Vec3, jointIndex: number): Vec3;
static worldToJointRotation(rotation: Quat, jointIndex: number): Quat;
static jointToWorldPoint(position: Vec3, jointIndex: number): Vec3;
static jointToWorldDirection(direction: Vec3, jointIndex: number): Vec3;
static jointToWorldRotation(rotation: Quat, jointIndex: number): Quat;
static pinJoint(index: number, position: Vec3, orientation: Quat): boolean;
static clearPinOnJoint(index: number): boolean;
static getIKErrorOnLastSolve(): number;
static useFullAvatarURL(fullAvatarURL: string, modelName: string): void;
static getFullAvatarURLFromPreferences(): string;
static getFullAvatarModelName(): string;
static getAvatarEntitiesVariant(): Array<object>;
static isFlying(): boolean;
static isInAir(): boolean;
static setFlyingEnabled(enabled: boolean): void;
static getFlyingEnabled(): boolean;
static setFlyingDesktopPref(enabled: boolean): void;
static getFlyingDesktopPref(): boolean;
static setFlyingDesktopPref(enabled: boolean): void;
static getFlyingDesktopPref(): boolean;
static getAvatarScale(): number;
static setAvatarScale(scale: number): void;
static setCollisionsEnabled(enabled: boolean): void;
static getCollisionsEnabled(): boolean;
static getCollisionCapsule(): object;
static setCharacterControllerEnabled(enabled: boolean): void;
static getCharacterControllerEnabled(): boolean;
static isUp(direction: Vec3): boolean;
static isDown(direction: Vec3): boolean;
static increaseSize(): void;
static decreaseSize(): void;
static resetSize(): void;
static animGraphLoaded(): void;
static setGravity(gravity: number): void;
static getGravity(): number;
static goToFeetLocation(position: Vec3, hasOrientation: boolean, orientation: Quat, shouldFaceLocation: boolean): void;
static goToLocation(position: Vec3, hasOrientation: boolean, orientation: Quat, shouldFaceLocation: boolean, withSafeLanding: boolean): void;
static goToLocation(properties: object): void;
static goToLocationAndEnableCollisions(position: Vec3): void;
static safeLanding(position: Vec3): boolean;
static restrictScaleFromDomainSettings(domainSettingsObject: object): void;
static clearScaleRestriction(): void;
static addThrust(thrust: Vec3): void;
static getThrust(): Vec3;
static setThrust(thrust: Vec3): void;
static updateMotionBehaviorFromMenu(): void;
static setToggleHips(enabled: boolean): void;
static setEnableDebugDrawBaseOfSupport(enabled: boolean): void;
static setEnableDebugDrawDefaultPose(enabled: boolean): void;
static setEnableDebugDrawAnimPose(enabled: boolean): void;
static setEnableDebugDrawPosition(enabled: boolean): void;
static setEnableDebugDrawHandControllers(enabled: boolean): void;
static setEnableDebugDrawSensorToWorldMatrix(enabled: boolean): void;
static setEnableDebugDrawIKTargets(enabled: boolean): void;
static setEnableDebugDrawIKConstraints(enabled: boolean): void;
static setEnableDebugDrawIKChains(enabled: boolean): void;
static setEnableDebugDrawDetailedCollision(enabled: boolean): void;
static getEnableMeshVisible(): boolean;
static setEnableMeshVisible(visible: boolean): void;
static setEnableInverseKinematics(enabled: boolean): void;
static getAnimGraphOverrideUrl(): string;
static setAnimGraphOverrideUrl(url: string): void;
static getAnimGraphUrl(): string;
static setAnimGraphUrl(url: string): void;
static getPositionForAudio(): Vec3;
static getOrientationForAudio(): Quat;
static setModelScale(scale: number): void;
static audioListenerModeChanged: Signal;
static transformChanged: Signal;
static newCollisionSoundURL: Signal;
static collisionWithEntity: Signal;
static collisionsEnabledChanged: Signal;
static animGraphUrlChanged: Signal;
static energyChanged: Signal;
static positionGoneTo: Signal;
static onLoadComplete: Signal;
static wentAway: Signal;
static wentActive: Signal;
static skeletonChanged: Signal;
static dominantHandChanged: Signal;
static sensorToWorldScaleChanged: Signal;
static attachmentsChanged: Signal;
static scaleChanged: Signal;
static shouldDisableHandTouchChanged: Signal;
static disableHandTouchForIDChanged: Signal;
static getDomainMinScale(): number;
static getDomainMaxScale(): number;
static getEyeHeight(): number;
static getHeight(): number;
static setHandState(state: string): void;
static getHandState(): string;
static setRawJointData(data: Array<JointData>): void;
static setJointData(index: number, rotation: Quat, translation: Vec3): void;
static setJointRotation(index: number, rotation: Quat): void;
static setJointTranslation(index: number, translation: Vec3): void;
static clearJointData(index: number): void;
static isJointDataValid(index: number): boolean;
static getJointRotation(index: number): Quat;
static getJointTranslation(index: number): Vec3;
static setJointData(name: string, rotation: Quat, translation: Vec3): void;
static setJointRotation(name: string, rotation: Quat): void;
static setJointTranslation(name: string, translation: Vec3): void;
static clearJointData(name: string): void;
static isJointDataValid(name: string): boolean;
static getJointRotation(name: string): Quat;
static getJointTranslation(name: number): Vec3;
static getJointRotations(): Array<Quat>;
static getJointTranslations(): Array<Vec3>;
static setJointRotations(jointRotations: Array<Quat>): void;
static setJointTranslations(translations: Array<Vec3>): void;
static clearJointsData(): void;
static getJointIndex(name: string): number;
static getJointNames(): Array<string>;
static setBlendshape(name: string, value: number): void;
static getAttachmentsVariant(): object;
static setAttachmentsVariant(variant: object): void;
static updateAvatarEntity(entityID: Uuid, entityData: string): void;
static clearAvatarEntity(entityID: Uuid): void;
static setForceFaceTrackerConnected(connected: boolean): void;
static getAttachmentData(): Array<AttachmentData>;
static setAttachmentData(attachmentData: Array<AttachmentData>): void;
static attach(modelURL: string, jointName: string, translation: Vec3, rotation: Quat, scale: number, isSoft: boolean, allowDuplicates: boolean, useSaved: boolean): void;
static detachOne(modelURL: string, jointName: string): void;
static detachAll(modelURL: string, jointName: string): void;
static getAvatarEntityData(): object;
static setAvatarEntityData(avatarEntityData: object): void;
static getSensorToWorldMatrix(): Mat4;
static getSensorToWorldScale(): number;
static getControllerLeftHandMatrix(): Mat4;
static getControllerRightHandMatrix(): Mat4;
static getDataRate(rateName: string): number;
static getUpdateRate(rateName: string): number;
static displayNameChanged: Signal;
static sessionDisplayNameChanged: Signal;
static skeletonModelURLChanged: Signal;
static lookAtSnappingChanged: Signal;
static sessionUUIDChanged: Signal;
static sendAvatarDataPacket(sendAll: boolean): void;
static sendIdentityPacket(): void;
static setJointMappingsFromNetworkReply(): void;
static setSessionUUID(sessionUUID: Uuid): void;
static getAbsoluteJointRotationInObjectFrame(index: number): Quat;
static getAbsoluteJointTranslationInObjectFrame(index: number): Vec3;
static setAbsoluteJointRotationInObjectFrame(index: number, rotation: Quat): boolean;
static setAbsoluteJointTranslationInObjectFrame(index: number, translation: Vec3): boolean;
static getTargetScale(): number;
static resetLastSent(): void;
static getDefaultJointRotation(index: number): Quat;
static getDefaultJointTranslation(index: number): Vec3;
static getAbsoluteDefaultJointRotationInObjectFrame(index: number): Quat;
static getAbsoluteDefaultJointTranslationInObjectFrame(index: number): Vec3;
static setSkeletonOffset(offset: Vec3): void;
static getSkeletonOffset(): Vec3;
static getJointPosition(index: number): Vec3;
static getJointPosition(name: string): Vec3;
static getNeckPosition(): Vec3;
static getAcceleration(): Vec3;
static getWorldFeetPosition(): Vec3;
static getParentID(): Uuid;
static setParentID(parentID: Uuid): void;
static getParentJointIndex(): number;
static setParentJointIndex(parentJointIndex: number): void;
static getSkeleton(): Array<SkeletonJoint>;
static getSimulationRate(rateName: string): number;
static getLeftPalmPosition(): Vec3;
static getLeftPalmRotation(): Quat;
static getRightPalmPosition(): Vec3;
static getRightPalmRotation(): Quat;
static rigReady: Signal;
static rigReset: Signal;
qmlPosition: Vec3;
shouldRenderLocally: boolean;
motorVelocity: Vec3;
motorTimescale: number;
motorReferenceFrame: string;
motorMode: string;
collisionSoundURL: string;
audioListenerMode: number;
audioListenerModeHead: number;
audioListenerModeCamera: number;
audioListenerModeCustom: number;
hasScriptedBlendshapes: boolean;
hasProceduralBlinkFaceMovement: boolean;
hasProceduralEyeFaceMovement: boolean;
hasAudioEnabledFaceMovement: boolean;
customListenPosition: Vec3;
customListenOrientation: Quat;
leftHandPosition: Vec3;
rightHandPosition: Vec3;
leftHandTipPosition: Vec3;
rightHandTipPosition: Vec3;
leftHandPose: Pose;
rightHandPose: Pose;
leftHandTipPose: Pose;
rightHandTipPose: Pose;
centerOfGravityModelEnabled: boolean;
hmdLeanRecenterEnabled: boolean;
collisionsEnabled: boolean;
characterControllerEnabled: boolean;
useAdvancedMovementControls: boolean;
showPlayArea: boolean;
yawSpeed: number;
pitchSpeed: number;
hmdRollControlEnabled: boolean;
hmdRollControlDeadZone: number;
hmdRollControlRate: number;
userHeight: number;
userEyeHeight: number;
static readonly SELF_ID: Uuid;
walkSpeed: number;
walkBackwardSpeed: number;
sprintSpeed: number;
skeletonOffset: Vec3;
position: Vec3;
scale: number;
density: number;
handPosition: Vec3;
bodyYaw: number;
bodyPitch: number;
bodyRoll: number;
orientation: Quat;
headOrientation: Quat;
headPitch: number;
headYaw: number;
headRoll: number;
velocity: Vec3;
angularVelocity: Vec3;
audioLoudness: number;
audioAverageLoudness: number;
displayName: string;
sessionDisplayName: string;
lookAtSnappingEnabled: boolean;
skeletonModelURL: string;
attachmentData: Array<AttachmentData>;
jointNames: Array<string>;
sessionUUID: Uuid;
sensorToWorldMatrix: Mat4;
controllerLeftHandMatrix: Mat4;
controllerRightHandMatrix: Mat4;
sensorToWorldScale: number;
}
declare class SkeletonJoint {
name: string;
index: number;
parentIndex: number;
}
declare class FaceTracker {
static setEnabled(enabled: boolean): void;
static calibrate(): void;
static muteToggled: Signal;
static toggleMute(): void;
static getMuted(): boolean;
}
declare class LaserPointers {
static createLaserPointer(properties: Pointers.LaserPointerProperties): number;
static enableLaserPointer(id: number): void;
static disableLaserPointer(id: number): void;
static removeLaserPointer(id: number): void;
static editRenderState(id: number, renderState: string, properties: Pointers.RayPointerRenderState): void;
static setRenderState(renderState: string, id: number): void;
static getPrevRayPickResult(id: number): RayPickResult;
static setPrecisionPicking(id: number, precisionPicking: boolean): void;
static setLaserLength(id: number, laserLength: number): void;
static setIgnoreItems(id: number, ignoreItems: Array<Uuid>): void;
static setIncludeItems(id: number, includeItems: Array<Uuid>): void;
static setLockEndUUID(id: number, itemID: Uuid, isOverlay: boolean, offsetMat: Mat4): void;
static isLeftHand(id: number): boolean;
static isRightHand(id: number): boolean;
static isMouse(id: number): boolean;
}
declare class Picks {
static createPick(type: PickType, properties: Picks.RayPickProperties): number;
static enablePick(uid: number): void;
static disablePick(uid: number): void;
static removePick(uid: number): void;
static getPrevPickResult(uid: number): RayPickResult;
static setPrecisionPicking(uid: number, precisionPicking: boolean): void;
static setIgnoreItems(uid: number, ignoreItems: Array<Uuid>): void;
static setIncludeItems(uid: number, includeItems: Array<Uuid>): void;
static isLeftHand(uid: number): boolean;
static isRightHand(uid: number): boolean;
static isMouse(uid: number): boolean;
static readonly PICK_NOTHING: number;
static readonly PICK_ENTITIES: number;
static readonly PICK_OVERLAYS: number;
static readonly PICK_AVATARS: number;
static readonly PICK_HUD: number;
static readonly PICK_COARSE: number;
static readonly PICK_INCLUDE_INVISIBLE: number;
static readonly PICK_INCLUDE_NONCOLLIDABLE: number;
static readonly PICK_ALL_INTERSECTIONS: number;
static readonly INTERSECTED_NONE: number;
static readonly INTERSECTED_ENTITY: number;
static readonly INTERSECTED_OVERLAY: number;
static readonly INTERSECTED_AVATAR: number;
static readonly INTERSECTED_HUD: number;
perFrameTimeBudget: number;
}
declare namespace Picks {
class RayPickProperties {
enabled: boolean;
filter: number;
maxDistance: number;
parentID: Uuid;
parentJointIndex: number;
joint: string;
posOffset: Vec3;
dirOffset: Vec3;
position: Vec3;
direction: Vec3;
}
class StylusPickProperties {
hand: number;
enabled: boolean;
filter: number;
maxDistance: number;
}
class ParabolaPickProperties {
enabled: boolean;
filter: number;
maxDistance: number;
parentID: Uuid;
parentJointIndex: number;
joint: string;
posOffset: Vec3;
dirOffset: Vec3;
position: Vec3;
direction: Vec3;