vectorMagnitudeSqr: Difference between revisions

Latest revision as of 17:34, 18 March 2025

1.22

Hover & click on the images for description

Description

Description:: Squared magnitude of a 3D vector.

2.14
Since 2.14 any count of numbers is valid.
Before 2.14, the argument had to be vector 3D, or 2.00 2D (With z coordinate defaulted to 0)
Groups:: Math - Vectors

Syntax

Syntax:: vectorMagnitudeSqr vector
Parameters:: vector: Array of Numbers
Return Value:: Number

Examples

Example 1:: Copy
_sizeSqr = vectorMagnitudeSqr [0,3,4]; // returns 25

Additional Information

See also:: vectorAdd vectorDiff vectorCrossProduct vectorDotProduct vectorCos vectorMagnitude vectorMultiply vectorDistance vectorDistanceSqr vectorDir vectorUp setVectorDir setVectorUp setVectorDirAndUp vectorNormalized vectorFromTo

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

: Posted on 28 Jun, 2014
ffur2007slx2_5: 1.22 Algorithm:
Copy
Vector = [x,y,z]; Result = (x ^ 2) + (y ^ 2) + (z ^ 2);
It is recommended to use vectorMagnitudeSqr instead of BIS_fnc_magnitudeSqr.

@@ Line 6: / Line 6: @@
 |gr2= Math - Vectors
-|descr=Squared magnitude of a 3D vector.
+|descr=Squared magnitude of a 3D vector.<br>
+{{Feature|GVI|arma3|2.14|Since {{GVI|arma3|2.14|size= 0.75}} any count of numbers is valid.<br>
+Before {{GVI|arma3|2.14|size= 0.75}}, the argument had to be vector 3D, or {{GVI|arma3|2.00|size= 0.75}} 2D (With z coordinate defaulted to 0)}}
 |s1= [[vectorMagnitudeSqr]] vector
-|p1= vector: [[Array]] - vector 3D or 2D (since Arma 3 v2.00, z coordinate is defaulted to 0)
+|p1= vector: [[Array]] of [[Number]]s
 |r1= [[Number]]
-|x1= <code>_sizeSqr = [[vectorMagnitudeSqr]] [0,3,4]; {{cc|returns 25}}</code>
+|x1= <sqf>_sizeSqr = vectorMagnitudeSqr [0,3,4]; // returns 25</sqf>
-|seealso= [[vectorAdd]] [[vectorDiff]] [[vectorCrossProduct]] [[vectorDotProduct]] [[vectorCos]], [[vectorMagnitude]], [[vectorMultiply]], [[vectorDistance]], [[vectorDistanceSqr]], [[vectorDir]], [[vectorUp]], [[setVectorDir]], [[setVectorUp]], [[setVectorDirAndUp]], [[vectorNormalized]], [[vectorFromTo]]
+|seealso= [[vectorAdd]] [[vectorDiff]] [[vectorCrossProduct]] [[vectorDotProduct]] [[vectorCos]] [[vectorMagnitude]] [[vectorMultiply]] [[vectorDistance]] [[vectorDistanceSqr]] [[vectorDir]] [[vectorUp]] [[setVectorDir]] [[setVectorUp]] [[setVectorDirAndUp]] [[vectorNormalized]] [[vectorFromTo]]
 }}
@@ Line 26: / Line 28: @@
 <dd class="note">
 {{GVI|arma3|1.22}} Algorithm:
-<code>Vector = [x,y,z];
+<sqf>
-Result = (x ^ 2) + (y ^ 2) + (z ^ 2);</code>
+Vector = [x,y,z];
+Result = (x ^ 2) + (y ^ 2) + (z ^ 2);
+</sqf>
 It is recommended to use [[vectorMagnitudeSqr]] instead of [[BIS_fnc_magnitudeSqr]].
 </dl>