Component:LinearMapper3D: Difference between revisions

From Resonite Wiki
Automated: update Fields
add info
Line 7: Line 7:
|Name=Linear Mapper 3D
|Name=Linear Mapper 3D
}}
}}
Linear Mapper 3D 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>.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{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 value to map from <code>SourceMin</code> to <code>SourceMax</code> using <code>Target</code>.
|Target|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv1=true|
|Target|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv1=true| The value to map from <code>TargetMin</code> to <code>TargetMax</code> using <code>Source</code>.
|SourceMin|Float|
|SourceMin|Float| The minimum of the range of the <code>Source</code> value.
|SourceMax|Float|
|SourceMax|Float| The maximum of the range of the <code>Source</code> value.
|TargetMin|Float3|
|TargetMin|Float3| The minimum of the range of the <code>Target</code> value.
|TargetMax|Float3|
|TargetMax|Float3| The maximum of the range of the <code>Target</code> value.
|AllowReverseMapping|Bool|
|AllowReverseMapping|Bool| Allow <code>Target</code> to map it's value to <code>Source</code>'s ranged value when written to.
|Clamp|Bool|
|Clamp|Bool| Whether to prevent <code>Source</code> and <code>Target</code> from going outside their defined ranges.
}}
}}


Line 30: Line 31:
<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components ==
* [[Component:LinearMapper1D|LinearMapper1D]]
* [[Component:LinearMapper2D|LinearMapper2D]]
* [[Component:LinearMapper3D|LinearMapper3D]]
* [[Component:LinearMapper4D|LinearMapper4D]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Linear Mapper 3D]]
[[Category:Components{{#translation:}}|Linear Mapper 3D]]
[[Category:Components:Transform:Drivers{{#translation:}}|Linear Mapper 3D]]
[[Category:Components:Transform:Drivers{{#translation:}}|Linear Mapper 3D]]

Revision as of 19:01, 29 October 2024


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


Component image 
Linear Mapper 3D component as seen in the Scene Inspector

Linear Mapper 3D is a component that draws a line from TargetMin and TargetMax and uses a linear range between the two 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 Float3 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 Float3 The minimum of the range of the Target value.
TargetMax Float3 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

Related Components