Component:EyeTrackingStreamManager: Difference between revisions

From Resonite Wiki
Style. Added description, added usage description, Added field descriptions. This is no longer a stub.
fix page
 
Line 8: Line 8:


<!--T:2-->
<!--T:2-->
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]].
The '''EyeTrackingStreamManager''' component uses streaming data from the [[Type:ValueStream`1|ValueStream]] data type (seen in the [[user Inspector]]) to control the left and right eyes on a [[User|user's]] [[Avatar|avatar]].


<!--T:3-->
<!--T:3-->
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|User|User| The focused user to get streaming data from.
|User|User| The focused user to get streaming data from.
Line 19: Line 20:
}}
}}


== EyeStreams ==
{{Table TypeFields
{{Table TypeFields
|IsTracking|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv2=true|Returns if this eye is tracking.
|IsTracking|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv0=true|Returns if this eye is tracking.
|Position|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv2=true|Returns the position of the eye.
|Position|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float3|Float3]]&gt;'''|TypeAdv1=true|Returns the position of the eye.
|Direction|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv3=true|Returns where the eye is looking.
|Direction|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float3|Float3]]&gt;'''|TypeAdv2=true|Returns where the eye is looking.
|Openness|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv4=true|Returns how open the eye is.
|Openness|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv3=true| Returns how open the eye is.
|Widen|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv5=true|Returns how wide the eye is.
|Widen|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv4=true| Returns how wide the eye is.
|Squeeze|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv6=true|Returns how squeezed the eye is.
|Squeeze|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv5=true| Returns how squeezed the eye is.
|Frown|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv7=true|Returns if the eye is frowning.
|Frown|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv6=true| Returns if the eye is frowning.
|InnerBrowVertical|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv8=true|Returns the inner brow data.
|InnerBrowVertical|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv7=true| Returns the inner brow data.
|OuterBrowVertical|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv9=true|Returns the outer brow data.
|OuterBrowVertical|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv8=true| Returns the outer brow data.
|PupilDiameter|'''[[Type:ValueStream|ValueStream]]'''|TypeAdv10=true|Returns the pupil diameter.
|PupilDiameter|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv9=true| Returns the pupil diameter.
}}
}}


Line 40: Line 42:


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
* [[Component:EyeLinearDriver]]
</translate>
</translate>
[[Category:Components{{#translation:}}|Eye Tracking Stream Manager]]
[[Category:Components{{#translation:}}|Eye Tracking Stream Manager]]
[[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 22:34, 17 January 2025

Component image 
EyeTrackingStreamManager component as seen in the Scene Inspector


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

Fields

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. Some components stop their functionality when this field is disabled, but some don't.
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.

EyeStreams

Fields
Name Type Description
IsTracking ValueStream`1<Bool> Returns if this eye is tracking.
Position ValueStream`1<Float3> Returns the position of the eye.
Direction ValueStream`1<Float3> Returns where the eye is looking.
Openness ValueStream`1<Float> Returns how open the eye is.
Widen ValueStream`1<Float> Returns how wide the eye is.
Squeeze ValueStream`1<Float> Returns how squeezed the eye is.
Frown ValueStream`1<Float> Returns if the eye is frowning.
InnerBrowVertical ValueStream`1<Float> Returns the inner brow data.
OuterBrowVertical ValueStream`1<Float> Returns the outer brow data.
PupilDiameter ValueStream`1<Float> Returns the pupil diameter.

Usage

Used for Eye Tracking.

Examples

See Also