Component:TrackedDevicePositioner: Difference between revisions

From Resonite Wiki
imported>Chemicalcrux
Creating the page (with a bot!)
 
add info
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages></languages>
<languages></languages>
<translate>
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=TrackedDevicePositionerComponent.png
|Image=TrackedDevicePositionerComponent.png
|Name=TrackedDevicePositioner
|Name=Tracked Device Positioner
}}
}}
The '''TrackedDevicePositioner''' component is used to get information from the user's input system to get positioning data for tracked objects like headset, hands, and full body trackers.


<!--T:2-->
== Fields ==
== Intoduction ==
 
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|User|User|
|DeviceIndex|Int| The input Device by index to track.
|DeviceIndex|Int|  
|CorrespondingBodyNode|BodyNode| The body node of the found input Device tracker.
|CorrespondingBodyNode|BodyNode|  
|AutoBodyNode|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:BodyNode|BodyNode]]&gt;'''|TypeAdv2=true| If present, use this to find the input Device to track rather than <code>DeviceIndex</code>.
|AutoBodyNode|Nullable`1|TypeString3=Nullable<BodyNode>|
|AlwaysRenderModel|Bool| Whether to always render the tracker Debug model regardless of if its mapped to a 3d model.
|AlwaysRenderModel|Bool|  
|ReferenceModel|Slot| The slot of the debug model visual.
|ReferenceModel|Slot|  
|BodyNodeRoot|Slot| acts as an offset for the actual position of a Tracked object.
|BodyNodeRoot|Slot|  
|ObjectSlot|'''[[Component:AvatarObjectSlot|AvatarObjectSlot]]'''|TypeAdv6=true| The avatar object slot this component is driving.
|ObjectSlot|AvatarObjectSlot|  
|IsTracking|Bool| Whether the input Device is tracking or lost its tracking.
|IsTracking|Bool|  
|IsActive|Bool| Whether the input Device is enabled.
|CreateAvatarObjectSlot|Bool|  
|CreateAvatarObjectSlot|Bool| Whether to create an avatar object slot component on a slot named "BodyNode" under this component slot if <code>BodyNodeRoot</code> is null.
|ScreenFilter|ScreenController|  
|PoseFilter|'''[[Component:UserPoseController|UserPoseController]]'''|TypeAdv10=true| The pose controller for this component to filter its position and movement based on if this component should be filtered.
}}
}}


<!--T:4-->
== Usage ==
== Behavior ==
{{stub}}


<!--T:5-->
== Examples ==
== Examples ==
{{stub}}
== See Also ==
* [[Component:AvatarObjectSlot]]


<!--T:6-->
[[Category:Components{{#translation:}}|Tracked Device Positioner]]
== Related Components ==
[[Category:Components:Users{{#translation:}}|Tracked Device Positioner]]
</translate>
[[Category:Components{{#translation:}}|TrackedDevicePositioner (Component){{#translation:}}]]
[[Category:ComponentStubs]]
[[Category:Components:Users{{#translation:}}|TrackedDevicePositioner (Component){{#translation:}}]]

Latest revision as of 20:34, 5 February 2025

Component image 
Tracked Device Positioner component as seen in the Scene Inspector

The TrackedDevicePositioner component is used to get information from the user's input system to get positioning data for tracked objects like headset, hands, and full body trackers.

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.
DeviceIndex Int The input Device by index to track.
CorrespondingBodyNode BodyNode The body node of the found input Device tracker.
AutoBodyNode Nullable`1<BodyNode> If present, use this to find the input Device to track rather than DeviceIndex.
AlwaysRenderModel Bool Whether to always render the tracker Debug model regardless of if its mapped to a 3d model.
ReferenceModel Slot The slot of the debug model visual.
BodyNodeRoot Slot acts as an offset for the actual position of a Tracked object.
ObjectSlot AvatarObjectSlot The avatar object slot this component is driving.
IsTracking Bool Whether the input Device is tracking or lost its tracking.
IsActive Bool Whether the input Device is enabled.
CreateAvatarObjectSlot Bool Whether to create an avatar object slot component on a slot named "BodyNode" under this component slot if BodyNodeRoot is null.
PoseFilter UserPoseController The pose controller for this component to filter its position and movement based on if this component should be filtered.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


See Also