SteamVR_Behaviour_Skeleton.cs
45.4 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
//======= Copyright (c) Valve Corporation, All rights reserved. ===============
using System;
using System.Collections;
using UnityEngine;
using UnityEngine.Events;
using Valve.VR;
namespace Valve.VR
{
public class SteamVR_Behaviour_Skeleton : MonoBehaviour
{
[Tooltip("If not set, will try to auto assign this based on 'Skeleton' + inputSource")]
/// <summary>The action this component will use to update the model. Must be a Skeleton type action.</summary>
public SteamVR_Action_Skeleton skeletonAction;
/// <summary>The device this action should apply to. Any if the action is not device specific.</summary>
[Tooltip("The device this action should apply to. Any if the action is not device specific.")]
public SteamVR_Input_Sources inputSource;
/// <summary>The range of motion you'd like the hand to move in. With controller is the best estimate of the fingers wrapped around a controller. Without is from a flat hand to a fist.</summary>
[Tooltip("The range of motion you'd like the hand to move in. With controller is the best estimate of the fingers wrapped around a controller. Without is from a flat hand to a fist.")]
public EVRSkeletalMotionRange rangeOfMotion = EVRSkeletalMotionRange.WithoutController;
/// <summary>The root Transform of the skeleton. Needs to have a child (wrist) then wrist should have children in the order thumb, index, middle, ring, pinky</summary>
[Tooltip("This needs to be in the order of: root -> wrist -> thumb, index, middle, ring, pinky")]
public Transform skeletonRoot;
/// <summary>The transform this transform should be relative to</summary>
[Tooltip("If not set, relative to parent")]
public Transform origin;
/// <summary>Whether or not to update this transform's position and rotation inline with the skeleton transforms or if this is handled in another script</summary>
[Tooltip("Set to true if you want this script to update its position and rotation. False if this will be handled elsewhere")]
public bool updatePose = true;
/// <summary>Check this to not set the positions of the bones. This is helpful for differently scaled skeletons.</summary>
[Tooltip("Check this to not set the positions of the bones. This is helpful for differently scaled skeletons.")]
public bool onlySetRotations = false;
/// <summary>
/// How much of a blend to apply to the transform positions and rotations.
/// Set to 0 for the transform orientation to be set by an animation.
/// Set to 1 for the transform orientation to be set by the skeleton action.
/// </summary>
[Range(0, 1)]
[Tooltip("Modify this to blend between animations setup on the hand")]
public float skeletonBlend = 1f;
/// <summary>This Unity event will fire whenever the position or rotation of the bones are updated.</summary>
public SteamVR_Behaviour_SkeletonEvent onBoneTransformsUpdated;
/// <summary>This Unity event will fire whenever the position or rotation of this transform is updated.</summary>
public SteamVR_Behaviour_SkeletonEvent onTransformUpdated;
/// <summary>This Unity event will fire whenever the position or rotation of this transform is changed.</summary>
public SteamVR_Behaviour_SkeletonEvent onTransformChanged;
/// <summary>This Unity event will fire whenever the device is connected or disconnected</summary>
public SteamVR_Behaviour_Skeleton_ConnectedChangedEvent onConnectedChanged;
/// <summary>This Unity event will fire whenever the device's tracking state changes</summary>
public SteamVR_Behaviour_Skeleton_TrackingChangedEvent onTrackingChanged;
/// <summary>This C# event will fire whenever the position or rotation of this transform is updated.</summary>
public UpdateHandler onBoneTransformsUpdatedEvent;
/// <summary>This C# event will fire whenever the position or rotation of this transform is updated.</summary>
public UpdateHandler onTransformUpdatedEvent;
/// <summary>This C# event will fire whenever the position or rotation of this transform is changed.</summary>
public ChangeHandler onTransformChangedEvent;
/// <summary>This C# event will fire whenever the device is connected or disconnected</summary>
public DeviceConnectedChangeHandler onConnectedChangedEvent;
/// <summary>This C# event will fire whenever the device's tracking state changes</summary>
public TrackingChangeHandler onTrackingChangedEvent;
/// <summary>Can be set to mirror the bone data across the x axis</summary>
[Tooltip("Is this rendermodel a mirror of another one?")]
public MirrorType mirroring;
[Header("No Skeleton - Fallback")]
[Tooltip("The fallback SkeletonPoser to drive hand animation when no skeleton data is available")]
/// <summary>The fallback SkeletonPoser to drive hand animation when no skeleton data is available</summary>
public SteamVR_Skeleton_Poser fallbackPoser;
[Tooltip("The fallback action to drive finger curl values when no skeleton data is available")]
/// <summary>The fallback SkeletonPoser to drive hand animation when no skeleton data is available</summary>
public SteamVR_Action_Single fallbackCurlAction;
/// <summary>
/// Is the skeleton action bound?
/// </summary>
public bool skeletonAvailable { get { return skeletonAction.activeBinding; } }
/// <summary>The current skeletonPoser we're getting pose data from</summary>
protected SteamVR_Skeleton_Poser blendPoser;
/// <summary>The current pose snapshot</summary>
protected SteamVR_Skeleton_PoseSnapshot blendSnapshot = null;
/// <summary>Returns whether this action is bound and the action set is active</summary>
public bool isActive { get { return skeletonAction.GetActive(); } }
/// <summary>An array of five 0-1 values representing how curled a finger is. 0 being straight, 1 being fully curled. 0 being thumb, 4 being pinky</summary>
public float[] fingerCurls
{
get
{
if (skeletonAvailable)
{
return skeletonAction.GetFingerCurls();
}
else
{
//fallback, return array where each finger curl is just the fallback curl action value
float[] curls = new float[5];
for (int i = 0; i < 5; i++)
{
curls[i] = fallbackCurlAction.GetAxis(inputSource);
}
return curls;
}
}
}
/// <summary>An 0-1 value representing how curled a finger is. 0 being straight, 1 being fully curled.</summary>
public float thumbCurl
{
get
{
if (skeletonAvailable)
return skeletonAction.GetFingerCurl(SteamVR_Skeleton_FingerIndexEnum.thumb);
else
return fallbackCurlAction.GetAxis(inputSource);
}
}
/// <summary>An 0-1 value representing how curled a finger is. 0 being straight, 1 being fully curled.</summary>
public float indexCurl
{
get
{
if (skeletonAvailable)
return skeletonAction.GetFingerCurl(SteamVR_Skeleton_FingerIndexEnum.index);
else
return fallbackCurlAction.GetAxis(inputSource);
}
}
/// <summary>An 0-1 value representing how curled a finger is. 0 being straight, 1 being fully curled.</summary>
public float middleCurl
{
get
{
if (skeletonAvailable)
return skeletonAction.GetFingerCurl(SteamVR_Skeleton_FingerIndexEnum.middle);
else
return fallbackCurlAction.GetAxis(inputSource);
}
}
/// <summary>An 0-1 value representing how curled a finger is. 0 being straight, 1 being fully curled.</summary>
public float ringCurl
{
get
{
if (skeletonAvailable)
return skeletonAction.GetFingerCurl(SteamVR_Skeleton_FingerIndexEnum.ring);
else
return fallbackCurlAction.GetAxis(inputSource);
}
}
/// <summary>An 0-1 value representing how curled a finger is. 0 being straight, 1 being fully curled.</summary>
public float pinkyCurl
{
get
{
if (skeletonAvailable)
return skeletonAction.GetFingerCurl(SteamVR_Skeleton_FingerIndexEnum.pinky);
else
return fallbackCurlAction.GetAxis(inputSource);
}
}
public Transform root { get { return bones[SteamVR_Skeleton_JointIndexes.root]; } }
public Transform wrist { get { return bones[SteamVR_Skeleton_JointIndexes.wrist]; } }
public Transform indexMetacarpal { get { return bones[SteamVR_Skeleton_JointIndexes.indexMetacarpal]; } }
public Transform indexProximal { get { return bones[SteamVR_Skeleton_JointIndexes.indexProximal]; } }
public Transform indexMiddle { get { return bones[SteamVR_Skeleton_JointIndexes.indexMiddle]; } }
public Transform indexDistal { get { return bones[SteamVR_Skeleton_JointIndexes.indexDistal]; } }
public Transform indexTip { get { return bones[SteamVR_Skeleton_JointIndexes.indexTip]; } }
public Transform middleMetacarpal { get { return bones[SteamVR_Skeleton_JointIndexes.middleMetacarpal]; } }
public Transform middleProximal { get { return bones[SteamVR_Skeleton_JointIndexes.middleProximal]; } }
public Transform middleMiddle { get { return bones[SteamVR_Skeleton_JointIndexes.middleMiddle]; } }
public Transform middleDistal { get { return bones[SteamVR_Skeleton_JointIndexes.middleDistal]; } }
public Transform middleTip { get { return bones[SteamVR_Skeleton_JointIndexes.middleTip]; } }
public Transform pinkyMetacarpal { get { return bones[SteamVR_Skeleton_JointIndexes.pinkyMetacarpal]; } }
public Transform pinkyProximal { get { return bones[SteamVR_Skeleton_JointIndexes.pinkyProximal]; } }
public Transform pinkyMiddle { get { return bones[SteamVR_Skeleton_JointIndexes.pinkyMiddle]; } }
public Transform pinkyDistal { get { return bones[SteamVR_Skeleton_JointIndexes.pinkyDistal]; } }
public Transform pinkyTip { get { return bones[SteamVR_Skeleton_JointIndexes.pinkyTip]; } }
public Transform ringMetacarpal { get { return bones[SteamVR_Skeleton_JointIndexes.ringMetacarpal]; } }
public Transform ringProximal { get { return bones[SteamVR_Skeleton_JointIndexes.ringProximal]; } }
public Transform ringMiddle { get { return bones[SteamVR_Skeleton_JointIndexes.ringMiddle]; } }
public Transform ringDistal { get { return bones[SteamVR_Skeleton_JointIndexes.ringDistal]; } }
public Transform ringTip { get { return bones[SteamVR_Skeleton_JointIndexes.ringTip]; } }
public Transform thumbMetacarpal { get { return bones[SteamVR_Skeleton_JointIndexes.thumbMetacarpal]; } } //doesn't exist - mapped to proximal
public Transform thumbProximal { get { return bones[SteamVR_Skeleton_JointIndexes.thumbProximal]; } }
public Transform thumbMiddle { get { return bones[SteamVR_Skeleton_JointIndexes.thumbMiddle]; } }
public Transform thumbDistal { get { return bones[SteamVR_Skeleton_JointIndexes.thumbDistal]; } }
public Transform thumbTip { get { return bones[SteamVR_Skeleton_JointIndexes.thumbTip]; } }
public Transform thumbAux { get { return bones[SteamVR_Skeleton_JointIndexes.thumbAux]; } }
public Transform indexAux { get { return bones[SteamVR_Skeleton_JointIndexes.indexAux]; } }
public Transform middleAux { get { return bones[SteamVR_Skeleton_JointIndexes.middleAux]; } }
public Transform ringAux { get { return bones[SteamVR_Skeleton_JointIndexes.ringAux]; } }
public Transform pinkyAux { get { return bones[SteamVR_Skeleton_JointIndexes.pinkyAux]; } }
/// <summary>An array of all the finger proximal joint transforms</summary>
public Transform[] proximals { get; protected set; }
/// <summary>An array of all the finger middle joint transforms</summary>
public Transform[] middles { get; protected set; }
/// <summary>An array of all the finger distal joint transforms</summary>
public Transform[] distals { get; protected set; }
/// <summary>An array of all the finger tip transforms</summary>
public Transform[] tips { get; protected set; }
/// <summary>An array of all the finger aux transforms</summary>
public Transform[] auxs { get; protected set; }
protected Coroutine blendRoutine;
protected Coroutine rangeOfMotionBlendRoutine;
protected Coroutine attachRoutine;
protected Transform[] bones;
/// <summary>The range of motion that is set temporarily (call ResetTemporaryRangeOfMotion to reset to rangeOfMotion)</summary>
protected EVRSkeletalMotionRange? temporaryRangeOfMotion = null;
/// <summary>
/// Get the accuracy level of the skeletal tracking data.
/// <para/>* Estimated: Body part location can’t be directly determined by the device. Any skeletal pose provided by the device is estimated based on the active buttons, triggers, joysticks, or other input sensors. Examples include the Vive Controller and gamepads.
/// <para/>* Partial: Body part location can be measured directly but with fewer degrees of freedom than the actual body part.Certain body part positions may be unmeasured by the device and estimated from other input data.Examples include Knuckles or gloves that only measure finger curl
/// <para/>* Full: Body part location can be measured directly throughout the entire range of motion of the body part.Examples include hi-end mocap systems, or gloves that measure the rotation of each finger segment.
/// </summary>
public EVRSkeletalTrackingLevel skeletalTrackingLevel
{
get
{
if (skeletonAvailable)
{
return skeletonAction.skeletalTrackingLevel;
}
else
{
return EVRSkeletalTrackingLevel.VRSkeletalTracking_Estimated;
}
}
}
/// <summary>Returns true if we are in the process of blending the skeletonBlend field (between animation and bone data)</summary>
public bool isBlending
{
get
{
return blendRoutine != null;
}
}
/*
public float predictedSecondsFromNow
{
get
{
return skeletonAction.predictedSecondsFromNow;
}
set
{
skeletonAction.predictedSecondsFromNow = value;
}
}
*/
public SteamVR_ActionSet actionSet
{
get
{
return skeletonAction.actionSet;
}
}
public SteamVR_ActionDirections direction
{
get
{
return skeletonAction.direction;
}
}
protected virtual void Awake()
{
SteamVR.Initialize();
AssignBonesArray();
proximals = new Transform[] { thumbProximal, indexProximal, middleProximal, ringProximal, pinkyProximal };
middles = new Transform[] { thumbMiddle, indexMiddle, middleMiddle, ringMiddle, pinkyMiddle };
distals = new Transform[] { thumbDistal, indexDistal, middleDistal, ringDistal, pinkyDistal };
tips = new Transform[] { thumbTip, indexTip, middleTip, ringTip, pinkyTip };
auxs = new Transform[] { thumbAux, indexAux, middleAux, ringAux, pinkyAux };
CheckSkeletonAction();
}
protected virtual void CheckSkeletonAction()
{
if (skeletonAction == null)
skeletonAction = SteamVR_Input.GetAction<SteamVR_Action_Skeleton>("Skeleton" + inputSource.ToString());
}
protected virtual void AssignBonesArray()
{
bones = skeletonRoot.GetComponentsInChildren<Transform>();
}
protected virtual void OnEnable()
{
CheckSkeletonAction();
SteamVR_Input.onSkeletonsUpdated += SteamVR_Input_OnSkeletonsUpdated;
if (skeletonAction != null)
{
skeletonAction.onDeviceConnectedChanged += OnDeviceConnectedChanged;
skeletonAction.onTrackingChanged += OnTrackingChanged;
}
}
protected virtual void OnDisable()
{
SteamVR_Input.onSkeletonsUpdated -= SteamVR_Input_OnSkeletonsUpdated;
if (skeletonAction != null)
{
skeletonAction.onDeviceConnectedChanged -= OnDeviceConnectedChanged;
skeletonAction.onTrackingChanged -= OnTrackingChanged;
}
}
private void OnDeviceConnectedChanged(SteamVR_Action_Skeleton fromAction, bool deviceConnected)
{
if (onConnectedChanged != null)
onConnectedChanged.Invoke(this, inputSource, deviceConnected);
if (onConnectedChangedEvent != null)
onConnectedChangedEvent.Invoke(this, inputSource, deviceConnected);
}
private void OnTrackingChanged(SteamVR_Action_Skeleton fromAction, ETrackingResult trackingState)
{
if (onTrackingChanged != null)
onTrackingChanged.Invoke(this, inputSource, trackingState);
if (onTrackingChangedEvent != null)
onTrackingChangedEvent.Invoke(this, inputSource, trackingState);
}
protected virtual void SteamVR_Input_OnSkeletonsUpdated(bool skipSendingEvents)
{
UpdateSkeleton();
}
protected virtual void UpdateSkeleton()
{
if (skeletonAction == null)
return;
if (updatePose)
UpdatePose();
if (blendPoser != null && skeletonBlend < 1)
{
if (blendSnapshot == null) blendSnapshot = blendPoser.GetBlendedPose(this);
blendSnapshot = blendPoser.GetBlendedPose(this);
}
if (rangeOfMotionBlendRoutine == null)
{
if (temporaryRangeOfMotion != null)
skeletonAction.SetRangeOfMotion(temporaryRangeOfMotion.Value);
else
skeletonAction.SetRangeOfMotion(rangeOfMotion); //this may be a frame behind
UpdateSkeletonTransforms();
}
}
/// <summary>
/// Sets a temporary range of motion for this action that can easily be reset (using ResetTemporaryRangeOfMotion).
/// This is useful for short range of motion changes, for example picking up a controller shaped object
/// </summary>
/// <param name="newRangeOfMotion">The new range of motion you want to apply (temporarily)</param>
/// <param name="blendOverSeconds">How long you want the blend to the new range of motion to take (in seconds)</param>
public void SetTemporaryRangeOfMotion(EVRSkeletalMotionRange newRangeOfMotion, float blendOverSeconds = 0.1f)
{
if (rangeOfMotion != newRangeOfMotion || temporaryRangeOfMotion != newRangeOfMotion)
{
TemporaryRangeOfMotionBlend(newRangeOfMotion, blendOverSeconds);
}
}
/// <summary>
/// Resets the previously set temporary range of motion.
/// Will return to the range of motion defined by the rangeOfMotion field.
/// </summary>
/// <param name="blendOverSeconds">How long you want the blend to the standard range of motion to take (in seconds)</param>
public void ResetTemporaryRangeOfMotion(float blendOverSeconds = 0.1f)
{
ResetTemporaryRangeOfMotionBlend(blendOverSeconds);
}
/// <summary>
/// Permanently sets the range of motion for this component.
/// </summary>
/// <param name="newRangeOfMotion">
/// The new range of motion to be set.
/// WithController being the best estimation of where fingers are wrapped around the controller (pressing buttons, etc).
/// WithoutController being a range between a flat hand and a fist.</param>
/// <param name="blendOverSeconds">How long you want the blend to the new range of motion to take (in seconds)</param>
public void SetRangeOfMotion(EVRSkeletalMotionRange newRangeOfMotion, float blendOverSeconds = 0.1f)
{
if (rangeOfMotion != newRangeOfMotion)
{
RangeOfMotionBlend(newRangeOfMotion, blendOverSeconds);
}
}
/// <summary>
/// Blend from the current skeletonBlend amount to full bone data. (skeletonBlend = 1)
/// </summary>
/// <param name="overTime">How long you want the blend to take (in seconds)</param>
public void BlendToSkeleton(float overTime = 0.1f)
{
if (blendPoser != null)
blendSnapshot = blendPoser.GetBlendedPose(this);
blendPoser = null;
BlendTo(1, overTime);
}
/// <summary>
/// Blend from the current skeletonBlend amount to pose animation. (skeletonBlend = 0)
/// Note: This will ignore the root position and rotation of the pose.
/// </summary>
/// <param name="overTime">How long you want the blend to take (in seconds)</param>
public void BlendToPoser(SteamVR_Skeleton_Poser poser, float overTime = 0.1f)
{
if (poser == null)
return;
blendPoser = poser;
BlendTo(0, overTime);
}
/// <summary>
/// Blend from the current skeletonBlend amount to full animation data (no bone data. skeletonBlend = 0)
/// </summary>
/// <param name="overTime">How long you want the blend to take (in seconds)</param>
public void BlendToAnimation(float overTime = 0.1f)
{
BlendTo(0, overTime);
}
/// <summary>
/// Blend from the current skeletonBlend amount to a specified new amount.
/// </summary>
/// <param name="blendToAmount">The amount of blend you want to apply.
/// 0 being fully set by animations, 1 being fully set by bone data from the action.</param>
/// <param name="overTime">How long you want the blend to take (in seconds)</param>
public void BlendTo(float blendToAmount, float overTime)
{
if (blendRoutine != null)
StopCoroutine(blendRoutine);
if (this.gameObject.activeInHierarchy)
blendRoutine = StartCoroutine(DoBlendRoutine(blendToAmount, overTime));
}
protected IEnumerator DoBlendRoutine(float blendToAmount, float overTime)
{
float startTime = Time.time;
float endTime = startTime + overTime;
float startAmount = skeletonBlend;
while (Time.time < endTime)
{
yield return null;
skeletonBlend = Mathf.Lerp(startAmount, blendToAmount, (Time.time - startTime) / overTime);
}
skeletonBlend = blendToAmount;
blendRoutine = null;
}
protected void RangeOfMotionBlend(EVRSkeletalMotionRange newRangeOfMotion, float blendOverSeconds)
{
if (rangeOfMotionBlendRoutine != null)
StopCoroutine(rangeOfMotionBlendRoutine);
EVRSkeletalMotionRange oldRangeOfMotion = rangeOfMotion;
rangeOfMotion = newRangeOfMotion;
if (this.gameObject.activeInHierarchy)
{
rangeOfMotionBlendRoutine = StartCoroutine(DoRangeOfMotionBlend(oldRangeOfMotion, newRangeOfMotion, blendOverSeconds));
}
}
protected void TemporaryRangeOfMotionBlend(EVRSkeletalMotionRange newRangeOfMotion, float blendOverSeconds)
{
if (rangeOfMotionBlendRoutine != null)
StopCoroutine(rangeOfMotionBlendRoutine);
EVRSkeletalMotionRange oldRangeOfMotion = rangeOfMotion;
if (temporaryRangeOfMotion != null)
oldRangeOfMotion = temporaryRangeOfMotion.Value;
temporaryRangeOfMotion = newRangeOfMotion;
if (this.gameObject.activeInHierarchy)
{
rangeOfMotionBlendRoutine = StartCoroutine(DoRangeOfMotionBlend(oldRangeOfMotion, newRangeOfMotion, blendOverSeconds));
}
}
protected void ResetTemporaryRangeOfMotionBlend(float blendOverSeconds)
{
if (temporaryRangeOfMotion != null)
{
if (rangeOfMotionBlendRoutine != null)
StopCoroutine(rangeOfMotionBlendRoutine);
EVRSkeletalMotionRange oldRangeOfMotion = temporaryRangeOfMotion.Value;
EVRSkeletalMotionRange newRangeOfMotion = rangeOfMotion;
temporaryRangeOfMotion = null;
if (this.gameObject.activeInHierarchy)
{
rangeOfMotionBlendRoutine = StartCoroutine(DoRangeOfMotionBlend(oldRangeOfMotion, newRangeOfMotion, blendOverSeconds));
}
}
}
protected IEnumerator DoRangeOfMotionBlend(EVRSkeletalMotionRange oldRangeOfMotion, EVRSkeletalMotionRange newRangeOfMotion, float overTime)
{
float startTime = Time.time;
float endTime = startTime + overTime;
Vector3[] oldBonePositions;
Quaternion[] oldBoneRotations;
Vector3[] newBonePositions;
Quaternion[] newBoneRotations;
while (Time.time < endTime)
{
yield return null;
float lerp = (Time.time - startTime) / overTime;
if (skeletonBlend > 0)
{
skeletonAction.SetRangeOfMotion(oldRangeOfMotion);
skeletonAction.UpdateValueWithoutEvents();
oldBonePositions = (Vector3[])GetBonePositions().Clone();
oldBoneRotations = (Quaternion[])GetBoneRotations().Clone();
skeletonAction.SetRangeOfMotion(newRangeOfMotion);
skeletonAction.UpdateValueWithoutEvents();
newBonePositions = GetBonePositions();
newBoneRotations = GetBoneRotations();
for (int boneIndex = 0; boneIndex < bones.Length; boneIndex++)
{
if (bones[boneIndex] == null)
continue;
if (SteamVR_Utils.IsValid(newBoneRotations[boneIndex]) == false || SteamVR_Utils.IsValid(oldBoneRotations[boneIndex]) == false)
{
continue;
}
Vector3 blendedRangeOfMotionPosition = Vector3.Lerp(oldBonePositions[boneIndex], newBonePositions[boneIndex], lerp);
Quaternion blendedRangeOfMotionRotation = Quaternion.Lerp(oldBoneRotations[boneIndex], newBoneRotations[boneIndex], lerp);
if (skeletonBlend < 1)
{
if (blendPoser != null)
{
SetBonePosition(boneIndex, Vector3.Lerp(blendSnapshot.bonePositions[boneIndex], blendedRangeOfMotionPosition, skeletonBlend));
SetBoneRotation(boneIndex, Quaternion.Lerp(GetBlendPoseForBone(boneIndex, blendedRangeOfMotionRotation), blendedRangeOfMotionRotation, skeletonBlend));
}
else
{
SetBonePosition(boneIndex, Vector3.Lerp(bones[boneIndex].localPosition, blendedRangeOfMotionPosition, skeletonBlend));
SetBoneRotation(boneIndex, Quaternion.Lerp(bones[boneIndex].localRotation, blendedRangeOfMotionRotation, skeletonBlend));
}
}
else
{
SetBonePosition(boneIndex, blendedRangeOfMotionPosition);
SetBoneRotation(boneIndex, blendedRangeOfMotionRotation);
}
}
}
if (onBoneTransformsUpdated != null)
onBoneTransformsUpdated.Invoke(this, inputSource);
if (onBoneTransformsUpdatedEvent != null)
onBoneTransformsUpdatedEvent.Invoke(this, inputSource);
}
rangeOfMotionBlendRoutine = null;
}
//why does this exist
protected virtual Quaternion GetBlendPoseForBone(int boneIndex, Quaternion skeletonRotation)
{
Quaternion poseRotation = blendSnapshot.boneRotations[boneIndex];
return poseRotation;
}
public virtual void UpdateSkeletonTransforms()
{
Vector3[] bonePositions = GetBonePositions();
Quaternion[] boneRotations = GetBoneRotations();
if (skeletonBlend <= 0)
{
if (blendPoser != null)
{
SteamVR_Skeleton_Pose_Hand mainPose = blendPoser.skeletonMainPose.GetHand(inputSource);
for (int boneIndex = 0; boneIndex < bones.Length; boneIndex++)
{
if (bones[boneIndex] == null)
continue;
if ((boneIndex == SteamVR_Skeleton_JointIndexes.wrist && mainPose.ignoreWristPoseData) ||
(boneIndex == SteamVR_Skeleton_JointIndexes.root && mainPose.ignoreRootPoseData))
{
SetBonePosition(boneIndex, bonePositions[boneIndex]);
SetBoneRotation(boneIndex, boneRotations[boneIndex]);
}
else
{
Quaternion poseRotation = GetBlendPoseForBone(boneIndex, boneRotations[boneIndex]);
SetBonePosition(boneIndex, blendSnapshot.bonePositions[boneIndex]);
SetBoneRotation(boneIndex, poseRotation);
}
}
}
else
{
for (int boneIndex = 0; boneIndex < bones.Length; boneIndex++)
{
Quaternion poseRotation = GetBlendPoseForBone(boneIndex, boneRotations[boneIndex]);
SetBonePosition(boneIndex, blendSnapshot.bonePositions[boneIndex]);
SetBoneRotation(boneIndex, poseRotation);
}
}
}
else if (skeletonBlend >= 1)
{
for (int boneIndex = 0; boneIndex < bones.Length; boneIndex++)
{
if (bones[boneIndex] == null)
continue;
SetBonePosition(boneIndex, bonePositions[boneIndex]);
SetBoneRotation(boneIndex, boneRotations[boneIndex]);
}
}
else
{
for (int boneIndex = 0; boneIndex < bones.Length; boneIndex++)
{
if (bones[boneIndex] == null)
continue;
if (blendPoser != null)
{
SteamVR_Skeleton_Pose_Hand mainPose = blendPoser.skeletonMainPose.GetHand(inputSource);
if ((boneIndex == SteamVR_Skeleton_JointIndexes.wrist && mainPose.ignoreWristPoseData) ||
(boneIndex == SteamVR_Skeleton_JointIndexes.root && mainPose.ignoreRootPoseData))
{
SetBonePosition(boneIndex, bonePositions[boneIndex]);
SetBoneRotation(boneIndex, boneRotations[boneIndex]);
}
else
{
//Quaternion poseRotation = GetBlendPoseForBone(boneIndex, boneRotations[boneIndex]);
SetBonePosition(boneIndex, Vector3.Lerp(blendSnapshot.bonePositions[boneIndex], bonePositions[boneIndex], skeletonBlend));
SetBoneRotation(boneIndex, Quaternion.Lerp(blendSnapshot.boneRotations[boneIndex], boneRotations[boneIndex], skeletonBlend));
//SetBoneRotation(boneIndex, GetBlendPoseForBone(boneIndex, boneRotations[boneIndex]));
}
}
else
{
if (blendSnapshot == null)
{
SetBonePosition(boneIndex, Vector3.Lerp(bones[boneIndex].localPosition, bonePositions[boneIndex], skeletonBlend));
SetBoneRotation(boneIndex, Quaternion.Lerp(bones[boneIndex].localRotation, boneRotations[boneIndex], skeletonBlend));
}
else
{
SetBonePosition(boneIndex, Vector3.Lerp(blendSnapshot.bonePositions[boneIndex], bonePositions[boneIndex], skeletonBlend));
SetBoneRotation(boneIndex, Quaternion.Lerp(blendSnapshot.boneRotations[boneIndex], boneRotations[boneIndex], skeletonBlend));
}
}
}
}
if (onBoneTransformsUpdated != null)
onBoneTransformsUpdated.Invoke(this, inputSource);
if (onBoneTransformsUpdatedEvent != null)
onBoneTransformsUpdatedEvent.Invoke(this, inputSource);
}
public virtual void SetBonePosition(int boneIndex, Vector3 localPosition)
{
if (onlySetRotations == false) //ignore position sets if we're only setting rotations
bones[boneIndex].localPosition = localPosition;
}
public virtual void SetBoneRotation(int boneIndex, Quaternion localRotation)
{
bones[boneIndex].localRotation = localRotation;
}
/// <summary>
/// Gets the transform for a bone by the joint index. Joint indexes specified in: SteamVR_Skeleton_JointIndexes
/// </summary>
/// <param name="joint">The joint index of the bone. Specified in SteamVR_Skeleton_JointIndexes</param>
public virtual Transform GetBone(int joint)
{
if (bones == null || bones.Length == 0)
Awake();
return bones[joint];
}
/// <summary>
/// Gets the position of the transform for a bone by the joint index. Joint indexes specified in: SteamVR_Skeleton_JointIndexes
/// </summary>
/// <param name="joint">The joint index of the bone. Specified in SteamVR_Skeleton_JointIndexes</param>
/// <param name="local">true to get the localspace position for the joint (position relative to this joint's parent)</param>
public Vector3 GetBonePosition(int joint, bool local = false)
{
if (local)
return bones[joint].localPosition;
else
return bones[joint].position;
}
/// <summary>
/// Gets the rotation of the transform for a bone by the joint index. Joint indexes specified in: SteamVR_Skeleton_JointIndexes
/// </summary>
/// <param name="joint">The joint index of the bone. Specified in SteamVR_Skeleton_JointIndexes</param>
/// <param name="local">true to get the localspace rotation for the joint (rotation relative to this joint's parent)</param>
public Quaternion GetBoneRotation(int joint, bool local = false)
{
if (local)
return bones[joint].localRotation;
else
return bones[joint].rotation;
}
protected Vector3[] GetBonePositions()
{
if (skeletonAvailable)
{
Vector3[] rawSkeleton = skeletonAction.GetBonePositions();
if (mirroring == MirrorType.LeftToRight || mirroring == MirrorType.RightToLeft)
{
for (int boneIndex = 0; boneIndex < rawSkeleton.Length; boneIndex++)
{
rawSkeleton[boneIndex] = MirrorPosition(boneIndex, rawSkeleton[boneIndex]);
}
}
return rawSkeleton;
}
else
{
//fallback to getting skeleton pose from skeletonPoser
if (fallbackPoser != null)
{
return fallbackPoser.GetBlendedPose(skeletonAction, inputSource).bonePositions;
}
else
{
Debug.LogError("Skeleton Action is not bound, and you have not provided a fallback SkeletonPoser. Please create one to drive hand animation when no skeleton data is available.", this);
return null;
}
}
}
protected static readonly Quaternion rightFlipAngle = Quaternion.AngleAxis(180, Vector3.right);
protected Quaternion[] GetBoneRotations()
{
if (skeletonAvailable)
{
Quaternion[] rawSkeleton = skeletonAction.GetBoneRotations();
if (mirroring == MirrorType.LeftToRight || mirroring == MirrorType.RightToLeft)
{
for (int boneIndex = 0; boneIndex < rawSkeleton.Length; boneIndex++)
{
rawSkeleton[boneIndex] = MirrorRotation(boneIndex, rawSkeleton[boneIndex]);
}
}
return rawSkeleton;
}
else
{
//fallback to getting skeleton pose from skeletonPoser
if (fallbackPoser != null)
{
return fallbackPoser.GetBlendedPose(skeletonAction, inputSource).boneRotations;
}
else
{
Debug.LogError("Skeleton Action is not bound, and you have not provided a fallback SkeletonPoser. Please create one to drive hand animation when no skeleton data is available.", this);
return null;
}
}
}
public static Vector3 MirrorPosition(int boneIndex, Vector3 rawPosition)
{
if (boneIndex == SteamVR_Skeleton_JointIndexes.wrist || IsMetacarpal(boneIndex))
{
rawPosition.Scale(new Vector3(-1, 1, 1));
}
else if (boneIndex != SteamVR_Skeleton_JointIndexes.root)
{
rawPosition = rawPosition * -1;
}
return rawPosition;
}
public static Quaternion MirrorRotation(int boneIndex, Quaternion rawRotation)
{
if (boneIndex == SteamVR_Skeleton_JointIndexes.wrist)
{
rawRotation.y = rawRotation.y * -1;
rawRotation.z = rawRotation.z * -1;
}
if (IsMetacarpal(boneIndex))
{
rawRotation = rightFlipAngle * rawRotation;
}
return rawRotation;
}
protected virtual void UpdatePose()
{
if (skeletonAction == null)
return;
Vector3 skeletonPosition = skeletonAction.GetLocalPosition();
Quaternion skeletonRotation = skeletonAction.GetLocalRotation();
if (origin == null)
{
if (this.transform.parent != null)
{
skeletonPosition = this.transform.parent.TransformPoint(skeletonPosition);
skeletonRotation = this.transform.parent.rotation * skeletonRotation;
}
}
else
{
skeletonPosition = origin.TransformPoint(skeletonPosition);
skeletonRotation = origin.rotation * skeletonRotation;
}
if (skeletonAction.poseChanged)
{
if (onTransformChanged != null)
onTransformChanged.Invoke(this, inputSource);
if (onTransformChangedEvent != null)
onTransformChangedEvent.Invoke(this, inputSource);
}
this.transform.position = skeletonPosition;
this.transform.rotation = skeletonRotation;
if (onTransformUpdated != null)
onTransformUpdated.Invoke(this, inputSource);
}
/// <summary>
/// Returns an array of positions/rotations that represent the state of each bone in a reference pose.
/// </summary>
/// <param name="referencePose">Which reference pose to return</param>
public void ForceToReferencePose(EVRSkeletalReferencePose referencePose)
{
bool temporarySession = false;
if (Application.isEditor && Application.isPlaying == false)
{
temporarySession = SteamVR.InitializeTemporarySession(true);
Awake();
#if UNITY_EDITOR
//gotta wait a bit for steamvr input to startup //todo: implement steamvr_input.isready
string title = "SteamVR";
string text = "Getting reference pose...";
float msToWait = 3000;
float increment = 100;
for (float timer = 0; timer < msToWait; timer += increment)
{
bool cancel = UnityEditor.EditorUtility.DisplayCancelableProgressBar(title, text, timer / msToWait);
if (cancel)
{
UnityEditor.EditorUtility.ClearProgressBar();
if (temporarySession)
SteamVR.ExitTemporarySession();
return;
}
System.Threading.Thread.Sleep((int)increment);
}
UnityEditor.EditorUtility.ClearProgressBar();
#endif
skeletonAction.actionSet.Activate();
SteamVR_ActionSet_Manager.UpdateActionStates(true);
skeletonAction.UpdateValueWithoutEvents();
}
if (skeletonAction.active == false)
{
Debug.LogError("<b>[SteamVR Input]</b> Please turn on your " + inputSource.ToString() + " controller and ensure SteamVR is open.", this);
return;
}
SteamVR_Utils.RigidTransform[] transforms = skeletonAction.GetReferenceTransforms(EVRSkeletalTransformSpace.Parent, referencePose);
if (transforms == null || transforms.Length == 0)
{
Debug.LogError("<b>[SteamVR Input]</b> Unable to get the reference transform for " + inputSource.ToString() + ". Please make sure SteamVR is open and both controllers are connected.", this);
}
if (mirroring == MirrorType.LeftToRight || mirroring == MirrorType.RightToLeft)
{
for (int boneIndex = 0; boneIndex < transforms.Length; boneIndex++)
{
bones[boneIndex].localPosition = MirrorPosition(boneIndex, transforms[boneIndex].pos);
bones[boneIndex].localRotation = MirrorRotation(boneIndex, transforms[boneIndex].rot);
}
}
else
{
for (int boneIndex = 0; boneIndex < transforms.Length; boneIndex++)
{
bones[boneIndex].localPosition = transforms[boneIndex].pos;
bones[boneIndex].localRotation = transforms[boneIndex].rot;
}
}
if (temporarySession)
SteamVR.ExitTemporarySession();
}
protected static bool IsMetacarpal(int boneIndex)
{
return (boneIndex == SteamVR_Skeleton_JointIndexes.indexMetacarpal ||
boneIndex == SteamVR_Skeleton_JointIndexes.middleMetacarpal ||
boneIndex == SteamVR_Skeleton_JointIndexes.ringMetacarpal ||
boneIndex == SteamVR_Skeleton_JointIndexes.pinkyMetacarpal ||
boneIndex == SteamVR_Skeleton_JointIndexes.thumbMetacarpal);
}
public enum MirrorType
{
None,
LeftToRight,
RightToLeft
}
public delegate void ActiveChangeHandler(SteamVR_Behaviour_Skeleton fromAction, SteamVR_Input_Sources inputSource, bool active);
public delegate void ChangeHandler(SteamVR_Behaviour_Skeleton fromAction, SteamVR_Input_Sources inputSource);
public delegate void UpdateHandler(SteamVR_Behaviour_Skeleton fromAction, SteamVR_Input_Sources inputSource);
public delegate void TrackingChangeHandler(SteamVR_Behaviour_Skeleton fromAction, SteamVR_Input_Sources inputSource, ETrackingResult trackingState);
public delegate void ValidPoseChangeHandler(SteamVR_Behaviour_Skeleton fromAction, SteamVR_Input_Sources inputSource, bool validPose);
public delegate void DeviceConnectedChangeHandler(SteamVR_Behaviour_Skeleton fromAction, SteamVR_Input_Sources inputSource, bool deviceConnected);
}
}