add some info |
add info |
||
| Line 8: | Line 8: | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|PositionStream|'''[[Type:ValueStream`1|ValueStream`1]]<[[Type:Float3|Float3]]>'''|TypeAdv0=true| | |PositionStream|'''[[Type:ValueStream`1|ValueStream`1]]<[[Type:Float3|Float3]]>'''|TypeAdv0=true| The source of float3 values used to position the slot. | ||
|RotationStream|'''[[Type:ValueStream`1|ValueStream`1]]<[[Type:FloatQ|FloatQ]]>'''|TypeAdv1=true| | |RotationStream|'''[[Type:ValueStream`1|ValueStream`1]]<[[Type:FloatQ|FloatQ]]>'''|TypeAdv1=true| The source of floatQ values used to rotate the slot. | ||
|ScaleStream|'''[[Type:ValueStream`1|ValueStream`1]]<[[Type:Float3|Float3]]>'''|TypeAdv2=true| | |ScaleStream|'''[[Type:ValueStream`1|ValueStream`1]]<[[Type:Float3|Float3]]>'''|TypeAdv2=true| The source of float3 values used to scale the slot. | ||
|RootSpaceStream|'''[[Type:ReferenceStream`1|ReferenceStream`1]]<[[Type:Slot|Slot]]>'''|TypeAdv3=true| | |RootSpaceStream|'''[[Type:ReferenceStream`1|ReferenceStream`1]]<[[Type:Slot|Slot]]>'''|TypeAdv3=true| The slot being used for the root space. | ||
|Position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv4=true| | |Position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv4=true| The field to drive with the streamed in position values. | ||
|Rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv5=true| | |Rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv5=true| The field to drive with the streamed in rotation values. | ||
|Scale|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv6=true| | |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|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float3|Float3]]>'''|TypeAdv9=true| | |PositionOffset|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float3|Float3]]>'''|TypeAdv9=true| Offset to the resulting position value this is driving. | ||
|RotationOffset|'''[[Type:Nullable`1|Nullable`1]]<[[Type:FloatQ|FloatQ]]>'''|TypeAdv10=true| | |RotationOffset|'''[[Type:Nullable`1|Nullable`1]]<[[Type:FloatQ|FloatQ]]>'''|TypeAdv10=true| Offset to the resulting rotation value this is driving. | ||
|ScaleOffset|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float3|Float3]]>'''|TypeAdv11=true| | |ScaleOffset|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float3|Float3]]>'''|TypeAdv11=true| Offset to the resulting scale value this is driving. | ||
|RunBeforePhysics|Bool| | |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. | ||
}} | }} | ||
| Line 27: | Line 27: | ||
== See Also == | == See Also == | ||
[[Category:Components{{#translation:}}|Transform Stream Driver]] | [[Category:Components{{#translation:}}|Transform Stream Driver]] | ||
[[Category:Components:Users{{#translation:}}|Transform Stream Driver]] | [[Category:Components:Users{{#translation:}}|Transform Stream Driver]] | ||
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
| 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.