Component:TransformStreamDriver: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
m ProbablePrime moved page TransformStreamDriver (Component) to Component:TransformStreamDriver: Creating component Namespace
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=TransformStreamDriverComponent.png
|Image=TransformStreamDriverComponent.png
|Name=TransformStreamDriver
|Name=TransformStreamDriver
}}
}}
The '''TransformStreamDriver''' is used to convert a stream of position rotation and scale values into drives which can drive slot transforms. It is used internally by the user positioning system.


<!--T:2-->
== Fields ==
== Intoduction ==
 
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|PositionStream|ValueStream`1|TypeString0=ValueStream<Float3>|  
|PositionStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float3|Float3]]&gt;'''|TypeAdv0=true| The source of float3 values used to position the slot.
|RotationStream|ValueStream`1|TypeString1=ValueStream<FloatQ>|  
|RotationStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:FloatQ|FloatQ]]&gt;'''|TypeAdv1=true| The source of floatQ values used to rotate the slot.
|ScaleStream|ValueStream`1|TypeString2=ValueStream<Float3>|  
|ScaleStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float3|Float3]]&gt;'''|TypeAdv2=true| The source of float3 values used to scale the slot.
|RootSpaceStream|ReferenceStream`1|TypeString3=ReferenceStream<Slot>|  
|RootSpaceStream|'''[[Type:ReferenceStream`1|ReferenceStream`1]]&lt;[[Type:Slot|Slot]]&gt;'''|TypeAdv3=true|  The slot being used for the root space.
|Position|Float3|  
|Position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv4=true| The field to drive with the streamed in position values.
|Rotation|FloatQ|  
|Rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv5=true| The field to drive with the streamed in rotation values.
|Scale|Float3|  
|Scale|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv6=true| The field to drive with the streamed in scale values.
|AllowOffsets|Bool|  
|AllowOffsets|Bool| Whether to allow offsets to the affected slot/object.
|ResetStreamsOnDestroy|Bool|  
|ResetStreamsOnDestroy|Bool| Whether to reset the incoming streams upon destroying this slot.
|PositionOffset|Nullable`1|TypeString9=float3?|  
|PositionOffset|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float3|Float3]]&gt;'''|TypeAdv9=true| Offset to the resulting position value this is driving.
|RotationOffset|Nullable`1|TypeString10=floatQ?|  
|RotationOffset|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:FloatQ|FloatQ]]&gt;'''|TypeAdv10=true| Offset to the resulting rotation value this is driving.
|ScaleOffset|Nullable`1|TypeString11=float3?|  
|ScaleOffset|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float3|Float3]]&gt;'''|TypeAdv11=true| Offset to the resulting scale value this is driving.
|RunBeforePhysics|Bool| Whether or not to run before physics. can fix some issues where users fly off of a platform being driven by this component.
}}
}}


<!--T:4-->
== Behavior ==
<!--T:5-->
== Examples ==
== Examples ==
Part of the user positioning system and IK.


<!--T:6-->
== See Also ==
== Related Components ==
[[Category:Components{{#translation:}}|Transform Stream Driver]]
</translate>
[[Category:Components:Users{{#translation:}}|Transform Stream Driver]]
[[Category:Components{{#translation:}}|TransformStreamDriver (Component){{#translation:}}]]
[[Category:ComponentStubs]]
[[Category:Components:Users{{#translation:}}|TransformStreamDriver (Component){{#translation:}}]]

Latest revision as of 01:35, 3 August 2025

Component image 
TransformStreamDriver component as seen in the Scene Inspector

The TransformStreamDriver is used to convert a stream of position rotation and scale values into drives which can drive slot transforms. It is used internally by the user positioning system.

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.
PositionStream ValueStream`1<Float3> The source of float3 values used to position the slot.
RotationStream ValueStream`1<FloatQ> The source of floatQ values used to rotate the slot.
ScaleStream ValueStream`1<Float3> The source of float3 values used to scale the slot.
RootSpaceStream ReferenceStream`1<Slot> The slot being used for the root space.
Position field drive of Float3 The field to drive with the streamed in position values.
Rotation field drive of FloatQ The field to drive with the streamed in rotation values.
Scale field drive of Float3 The field to drive with the streamed in scale values.
AllowOffsets Bool Whether to allow offsets to the affected slot/object.
ResetStreamsOnDestroy Bool Whether to reset the incoming streams upon destroying this slot.
PositionOffset Nullable`1<Float3> Offset to the resulting position value this is driving.
RotationOffset Nullable`1<FloatQ> Offset to the resulting rotation value this is driving.
ScaleOffset Nullable`1<Float3> Offset to the resulting scale value this is driving.
RunBeforePhysics Bool Whether or not to run before physics. can fix some issues where users fly off of a platform being driven by this component.

Examples

Part of the user positioning system and IK.

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:TransformStreamDriver&oldid=106585"