Component:LinearMapper2D: Difference between revisions

Latest revision as of 19:03, 29 October 2024

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

Component image

**Linear Mapper 2D** component as seen in the Scene Inspector

Linear Mapper 2D is a component that draws a line from TargetMin and TargetMax and uses a linear range between the two with Target to map Source to a range between SourceMin and SourceMax.

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.
`Source`	direct RelayRef`1<IValue`1<Float>>	The value to map from `SourceMin` to `SourceMax` using `Target`.
`Target`	field drive of Float2	The value to map from `TargetMin` to `TargetMax` using `Source`.
`SourceMin`	Float	The minimum of the range of the `Source` value.
`SourceMax`	Float	The maximum of the range of the `Source` value.
`TargetMin`	Float2	The minimum of the range of the `Target` value.
`TargetMax`	Float2	The maximum of the range of the `Target` value.
`AllowReverseMapping`	Bool	Allow `Target` to map it's value to `Source`'s ranged value when written to.
`Clamp`	Bool	Whether to prevent `Source` and `Target` from going outside their defined ranges.

Usage

Examples

LinearMapper tutorial by ProbablePrime

Related Components

@@ Line 7: / Line 7: @@
 |Name=Linear Mapper 2D
 }}
-Linear Mapper 2D is a component that draws a line from <code>TargetMin</code> and <code>TargetMax</code> and uses a linear range between the two to map Source to a range between <code>SourceMin</code> and <code>SourceMax</code>.
+Linear Mapper 2D is a component that draws a line from <code>TargetMin</code> and <code>TargetMax</code> and uses a linear range between the two with <code>Target</code> to map <code>Source</code> to a range between <code>SourceMin</code> and <code>SourceMax</code>.
 <!--T:2-->