BIS fnc nearestPoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page creation)
 
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(41 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Computes nearest point in a line. |Description=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| [start, end, point, ''is2D''] call [[BIS_fnc_nearestPoint]] |Syntax=
|game4= arma3
|version4= 0.50


|p1= start: [[Position]] - line start |Parameter 1=
|gr1= Geometry


|p2= end: [[Position]] - line end |Parameter 2=
|descr= Computes nearest point in a line.


|p3= point: [[Position]] - point to check against |Parameter 3=
|s1= [start, end, point, ''is2D''] call [[BIS_fnc_nearestPoint]]


|p4= is2D: [[Boolean]] - (Optional, default [[false]]) 2D calculation instead of 3D |Parameter 4=
|p1= start: [[Position]] - line start


| [[Position]] - the line point that is closest to ''point'' |Return value=
|p2= end: [[Position]] - line end
____________________________________________________________________________________________


|x1= <code>_idealLocation = <nowiki>[</nowiki>[[getMarkerPos]] "base", [[getMarkerPos]] "destination", [[getPos]] [[player]], [[true]]] [[call]] [[BIS_fnc_nearestPoint]];</code> |Example 1=
|p3= point: [[Position]] - point to check against
____________________________________________________________________________________________


| [[nearObjects]], [[nearestObject]], [[nearestObjects]], [[BIS_fnc_nearestPosition]], [[BIS_fnc_nearestNum]], [[BIS_fnc_nearestRoad]], [[BIS_fnc_nearestHelipad]], [[BIS_fnc_isPosBlacklisted]] |See also=
|p4= is2D: [[Boolean]] - (Optional, default [[false]]) 2D calculation instead of 3D
}}


<h3 style="display:none">Notes</h3>
|r1= [[Position]] - the line point that is closest to ''point''
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>private _idealLocation = [getMarkerPos "base", getMarkerPos "destination", getPos player, true] call BIS_fnc_nearestPoint;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[nearObjects]] [[nearestObject]] [[nearestObjects]] [[BIS_fnc_nearestPosition]] [[BIS_fnc_nearestNum]] [[BIS_fnc_nearestRoad]] [[BIS_fnc_nearestHelipad]] [[BIS_fnc_isPosBlacklisted]]
[[Category:Function Group: Geometry|{{uc:nearestPoint}}]]
}}
[[Category:Functions|{{uc:nearestPoint}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:nearestPoint}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:nearestPoint}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:nearestPoint}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:nearestPoint}}]]

Latest revision as of 18:00, 13 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Computes nearest point in a line.
Execution:
call
Groups:
Geometry

Syntax

Syntax:
[start, end, point, is2D] call BIS_fnc_nearestPoint
Parameters:
start: Position - line start
end: Position - line end
point: Position - point to check against
is2D: Boolean - (Optional, default false) 2D calculation instead of 3D
Return Value:
Position - the line point that is closest to point

Examples

Example 1:
private _idealLocation = [getMarkerPos "base", getMarkerPos "destination", getPos player, true] call BIS_fnc_nearestPoint;

Additional Information

See also:
nearObjects nearestObject nearestObjects BIS_fnc_nearestPosition BIS_fnc_nearestNum BIS_fnc_nearestRoad BIS_fnc_nearestHelipad BIS_fnc_isPosBlacklisted

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=BIS_fnc_nearestPoint&oldid=328376"