linearConversion: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(syntax)
m (Text replacement - "\] +\[" to "] [")
 
(55 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.50


|0.50|= Game version
|gr1= Math
____________________________________________________________________________________________


| Converts value in interval [min, max] to {{Inline code|newMin + a * (max - min) / (newMax - newMin)}}, potentially clamps the final value.  |= Description
|descr= Converts given value from given "from" range to wanted "to" range. If clipping is set to [[true]], the resulting value is guaranteed to be within "to" range no matter what. {{Feature|arma3|Faster alternative to [[BIS_fnc_linearConversion]].}}
____________________________________________________________________________________________


| '''linearConversion''' [min, max, value, newMin, newMax, clamp] |= Syntax
|s1= [[linearConversion]] [minFrom, maxFrom, value, minTo, maxTo, clip]


|p1= [min, max, value, newMin, newMax, clamp]: [[Array]] |= PARAMETER1
|p1= minFrom: [[Number]] - start "from" range


|p2= min: [[Number]] |= PARAMETER2
|p2= maxFrom: [[Number]] - end "from" range


|p3= max: [[Number]] |= PARAMETER3
|p3= value: [[Number]] - given value from "from" range


|p4= value: [[Number]] |= PARAMETER4
|p4= minTo: [[Number]] - start "to" range


|p5= newMin: [[Number]] |= PARAMETER5
|p5= maxTo: [[Number]] - end "to" range


|p6= newMax: [[Number]] |= PARAMETER6
|p6= clip: [[Boolean]] - (Optional, default [[false]]) if [[true]], resulting value cannot leave "to" range


|p7= clamp (optional): [[Boolean]] (Default is false)  |= PARAMETER7
|r1= [[Number]] - respectful value from "to" range


| [[Number]] |= RETURNVALUE
|x1= <sqf>
// Say given range is 0 to 1 and wanted range is 0 to 100 (percent calculation). Given value 0.55 then will be 55
linearConversion [0, 1, 0.55, 0, 100];


// but if given value is 1.1 it will return 110
linearConversion [0, 1, 1.1, 0, 100, false];


|x1= <code>[[linearConversion]] [4, 8, 5, 0, 1, [[false]]<nowiki>]</nowiki>;</code>|= EXAMPLE1
// or if clipping is true it will return 100
linearConversion [0, 1, 1.1, 0, 100, true];
</sqf>


____________________________________________________________________________________________
|x2= <sqf>linearConversion [4, 8, 5, 0, 1, false];</sqf>


| |= SEEALSO
|x3= <sqf>
// Calculate days from 1/1/1970
fnc_daysFromEpoc =
{
private _year = param [0];
private _days = 0;
for "_i" from 1970 to _year - 1 do
{
_days = _days + round linearConversion [0, 1, dateToNumber [_i, 12, 31, 23, 59], 0, 365, false];
};
_days + linearConversion [0, 1, dateToNumber _this, 0, 365, false];
};


| |= MPBEHAVIOUR
hint str (date call fnc_daysFromEpoc);
____________________________________________________________________________________________
</sqf>
 
|seealso= [[round]] [[floor]] [[ceil]] [[vectorLinearConversion]] [[bezierInterpolation]]
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on Mar 29, 2014 - 09:39
<dt class="note">'''[[User:ffur2007slx2_5|ffur2007slx2_5]]'''<dd class="note">
(A3 0.50) It is recommended to use [[linearConversion]] instead of [[BIS_fnc_linearConversion]]:
<code>[[linearConversion]] [0,100,50,0,50,[[true]] ]; //same as [[0,100],50,[0,50]] [[call]] [[BIS_fnc_linearConversion]]</code>
As for clamp, true will disable new value out of its range while false won't:
<code>[[linearConversion]] [0,100,150,0,50,[[true]] ]; //return 50
[[linearConversion]] [0,100,150,0,50,[[false]] ]; //return 75
</code>
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:46, 5 May 2024

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Converts given value from given "from" range to wanted "to" range. If clipping is set to true, the resulting value is guaranteed to be within "to" range no matter what.
Arma 3
Faster alternative to BIS_fnc_linearConversion.
Groups:
Math

Syntax

Syntax:
linearConversion [minFrom, maxFrom, value, minTo, maxTo, clip]
Parameters:
minFrom: Number - start "from" range
maxFrom: Number - end "from" range
value: Number - given value from "from" range
minTo: Number - start "to" range
maxTo: Number - end "to" range
clip: Boolean - (Optional, default false) if true, resulting value cannot leave "to" range
Return Value:
Number - respectful value from "to" range

Examples

Example 1:
// Say given range is 0 to 1 and wanted range is 0 to 100 (percent calculation). Given value 0.55 then will be 55 linearConversion [0, 1, 0.55, 0, 100]; // but if given value is 1.1 it will return 110 linearConversion [0, 1, 1.1, 0, 100, false]; // or if clipping is true it will return 100 linearConversion [0, 1, 1.1, 0, 100, true];
Example 2:
linearConversion [4, 8, 5, 0, 1, false];
Example 3:
// Calculate days from 1/1/1970 fnc_daysFromEpoc = { private _year = param [0]; private _days = 0; for "_i" from 1970 to _year - 1 do { _days = _days + round linearConversion [0, 1, dateToNumber [_i, 12, 31, 23, 59], 0, 365, false]; }; _days + linearConversion [0, 1, dateToNumber _this, 0, 365, false]; }; hint str (date call fnc_daysFromEpoc);

Additional Information

See also:
round floor ceil vectorLinearConversion bezierInterpolation

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=linearConversion&oldid=364172"