Component:LinearRotationMapper: Difference between revisions

Revision as of 05:30, 23 January 2025

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

Component image

**Linear Rotation Mapper** component as seen in the Scene Inspector

The LinearRotationMapper component is used to map a float range to a rotation range using lerp.

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.
`Source`	direct RelayRef`1<IValue`1<Float>>	The source value field to get the source mapped value from.
`Target`	field drive of FloatQ	The rotation to drive with the mapped rotation value.
`SourceMin`	Float	The minimum value for `Source` for mapping.
`SourceMax`	Float	The maximum value for `Source` for mapping.
`TargetMin`	FloatQ	The minumum rotation value when `Source` is at `SourceMin`'s value.
`TargetMax`	FloatQ	The maximum rotation value when `Source` is at `SourceMax`'s value.
`AllowReverseMapping`	Bool	Whether changes to `Target` map in the reverse direction and get applied to target.
`Clamp`	Bool	Whether to allow extrapolation of the lerped data or to keep it within the values specified.

Examples

Can be used to make an object spin as a slider is slid. Then can also be used to rotate the object that in turn affects the slider if AllowReverseMapping is enabled.

@@ Line 7: / Line 7: @@
 |Name=Linear Rotation Mapper
 }}
+The '''LinearRotationMapper''' component is used to map a float range to a rotation range using lerp.
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|Source|{{RootFieldType|RelayRef`1|[[Type:IValue`1|IValue`1]]&lt;[[Type:Float|Float]]&gt;}}|TypeAdv0=true|
+|Source|{{RootFieldType|RelayRef`1|[[Type:IValue`1|IValue`1]]&lt;[[Type:Float|Float]]&gt;}}|TypeAdv0=true| The source value field to get the source mapped value from.
-|Target|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv1=true|
+|Target|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv1=true| The rotation to drive with the mapped rotation value.
-|SourceMin|Float|
+|SourceMin|Float| The minimum value for <code>Source</code> for mapping.
-|SourceMax|Float|
+|SourceMax|Float| The maximum value for <code>Source</code> for mapping.
-|TargetMin|FloatQ|
+|TargetMin|FloatQ| The minumum rotation value when <code>Source</code> is at <code>SourceMin</code>'s value.
-|TargetMax|FloatQ|
+|TargetMax|FloatQ| The maximum rotation value when <code>Source</code> is at <code>SourceMax</code>'s value.
-|AllowReverseMapping|Bool|
+|AllowReverseMapping|Bool| Whether changes to <code>Target</code> map in the reverse direction and get applied to target.
-|Clamp|Bool|
+|Clamp|Bool| Whether to allow extrapolation of the lerped data or to keep it within the values specified.
 }}
-<!--T:3-->
-== Usage ==
 <!--T:4-->
 == Examples ==
+Can be used to make an object spin as a slider is slid. Then can also be used to rotate the object that in turn affects the slider if <code>AllowReverseMapping</code> is enabled.
 <!--T:5-->
-== Related Components ==
+== See Also ==
+* [[Component:LinearAngleMapper]]
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Linear Rotation Mapper]]
 [[Category:Components:Transform:Drivers{{#translation:}}|Linear Rotation Mapper]]