Component:EyeTrackingStreamManager: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
Style. Added description, added usage description, Added field descriptions. This is no longer a stub.
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=EyeTrackingStreamManagerComponent.png
|Image=EyeTrackingStreamManagerComponent.png
Line 9: Line 8:


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''EyeTrackingStreamManager''' component uses streaming data from the [[Component:ValueStream|ValueStream]] component (seen in the [[user Inspector]]) to control the left and right eyes on a [[User|user's]] [[Avatar|avatar]].


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|User|User|
|User|User| The focused user to get streaming data from.
|ConvergenceDistance|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv1=true|
|ConvergenceDistance|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv1=true| The eye distance data from the headset.
|IsEyeTrackingActive|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv2=true|
|IsEyeTrackingActive|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv2=true| Returns true if the eyes are being tracked from the headset.
|LeftEyeStreams|{{RootFieldType|(nested)|[[#EyeStreams|EyeStreams]]}}|TypeAdv3=true|
|LeftEyeStreams|{{RootFieldType|(nested)|[[#EyeStreams|EyeStreams]]}}|TypeAdv3=true| A set of fields for the left eye.
|RightEyeStreams|{{RootFieldType|(nested)|[[#EyeStreams|EyeStreams]]}}|TypeAdv4=true|
|RightEyeStreams|{{RootFieldType|(nested)|[[#EyeStreams|EyeStreams]]}}|TypeAdv4=true| A set of fields for the right eye.
}}
 
{{Table TypeFields
|IsTracking|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv2=true|Returns if this eye is tracking.
|Position|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv2=true|Returns the position of the eye.
|Direction|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv3=true|Returns where the eye is looking.
|Openness|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv4=true|Returns how open the eye is.
|Widen|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv5=true|Returns how wide the eye is.
|Squeeze|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv6=true|Returns how squeezed the eye is.
|Frown|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv7=true|Returns if the eye is frowning.
|InnerBrowVertical|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv8=true|Returns the inner brow data.
|OuterBrowVertical|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv9=true|Returns the outer brow data.
|PupilDiameter|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv10=true|Returns the pupil diameter.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
Used for [[Eye Tracking]].


<!--T:5-->
<!--T:5-->
Line 31: Line 43:
</translate>
</translate>
[[Category:Components{{#translation:}}|Eye Tracking Stream Manager]]
[[Category:Components{{#translation:}}|Eye Tracking Stream Manager]]
[[Category:ComponentStubs]]
[[Category:Components With Nested Types{{#translation:}}|Eye Tracking Stream Manager]]
[[Category:Components With Nested Types{{#translation:}}|Eye Tracking Stream Manager]]
[[Category:Components:Users{{#translation:}}|Eye Tracking Stream Manager]]
[[Category:Components:Users{{#translation:}}|Eye Tracking Stream Manager]]

Latest revision as of 07:51, 28 September 2024

Component image 
EyeTrackingStreamManager component as seen in the Scene Inspector


The EyeTrackingStreamManager component uses streaming data from the ValueStream component (seen in the user Inspector) to control the left and right eyes on a user's avatar.

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
User User The focused user to get streaming data from.
ConvergenceDistance ValueStream`1<Float> The eye distance data from the headset.
IsEyeTrackingActive ValueStream`1<Bool> Returns true if the eyes are being tracked from the headset.
LeftEyeStreams direct EyeStreams A set of fields for the left eye.
RightEyeStreams direct EyeStreams A set of fields for the right eye.
Fields
Name Type Description
IsTracking [[Type:ValueStream|ValueStream]] Returns if this eye is tracking.
Position [[Type:ValueStream|ValueStream]] Returns the position of the eye.
Direction ValueStream Returns where the eye is looking.
Openness ValueStream Returns how open the eye is.
Widen ValueStream Returns how wide the eye is.
Squeeze ValueStream Returns how squeezed the eye is.
Frown ValueStream Returns if the eye is frowning.
InnerBrowVertical ValueStream Returns the inner brow data.
OuterBrowVertical ValueStream Returns the outer brow data.
PupilDiameter ValueStream Returns the pupil diameter.


Usage

Used for Eye Tracking.

Examples

Related Components