lineIntersectsObjs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " " to " ")
(Add alternative syntax for running multiple intersections in parallel. Minor typo corrections. Reordered see also commands to be grouped and consistent across lineIntersects pages)
 
(45 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3
|1.10
|version1= 1.10
 
|arg= global
|arg= global


|gr1= Math - Geometry
|gr1= Math - Geometry


| Returns list of objects intersected by given line from ''begPos'' to ''endPos''.
|descr= Returns a list of objects intersected by the line from ''begPos'' to ''endPos''. Since {{GVI|arma3|2.20|size= 0.75}}, there is an alternative syntax that does multiple checks at once, faster than multiple calls.
 
|s1= [[lineIntersectsObjs]] [begPos, endPos, ignoreObj1, ignoreObj2, sortByDistance, flags]
 
|p1= begPos: [[Array]] format [[Position#PositionASL|PositionASL]] - virtual line start
 
|p2= endPos: [[Array]] format [[Position#PositionASL|PositionASL]] - virtual line end
 
|p3= ignoreObj1: [[Object]] - (Optional) - object to ignore
 
|p4= ignoreObj2: [[Object]] - (Optional) - object to ignore
 
|p5= sortByDistance: [[Boolean]] - (Optional) - [[true]]: furthest object first, closest object last; [[false]]: unsorted


| '''lineIntersectsObjs''' [begPos, endPos, withObj, ignoreObj, sortByDistance, flags]
|p6= flags: [[Number]] - (Optional)
* 1 - CF_ONLY_WATER
* 2 - CF_NEAREST_CONTACT
* 4 - CF_ONLY_STATIC
* 8 - CF_ONLY_DYNAMIC
* 16 - CF_FIRST_CONTACT
* 32 - CF_ALL_OBJECTS (Usable only with CF_FIRST_CONTACT and it will check one contact per object)
Flags can be combined: 2 + 4 = 6 is CF_NEAREST_OBJECT + CF_ONLY_STATIC


|p1= begPos: [[PositionASL]] - virtual line start
|r1= [[Array]] of [[Object]]s - intersecting objects
|p2= endPos: [[PositionASL]] - virtual line end
|p3= withObj: [[Object]]
|p4= ignoreObj: [[Object]]
|p5= sortByDistance: [[Boolean]] - [[true]]: furthest object first, closest object last; [[false]]: unsorted
|p6= flags: [[Number]]
<br>1 - CF_ONLY_WATER
<br>2 - CF_NEAREST_CONTACT
<br>4 - CF_ONLY_STATIC
<br>8 - CF_ONLY_DYNAMIC
<br>16 - CF_FIRST_CONTACT
<br>32 - CF_ALL_OBJECTS (Usable only with CF_FIRST_CONTACT and it will check one contact per object)
<br>Flags can be combined: 2 + 4 = 6 is CF_NEAREST_OBJECT + CF_ONLY_STATIC


| [[Array]] of [[Object|Objects]] - intersecting objects
|s2= [[lineIntersectsObjs]] [element1, element2, ...]
|x1= <code>Sto = [];
 
Fn = {
|s2since= arma3 2.20
  {
 
    Sto [[set]] [_foreachindex,[[lineIntersectsObjs]] [([[eyePos]] [[player]]),([[ATLtoASL]] [[screenToWorld]] [0.5,0.5]),[[objNull]],[[objNull]],[[false]],_x]];
|p21= elementN: [[Array]] format [begPos, endPos, ignoreObj1, ignoreObj2, sortByDistance, flags]
  } [[forEach]] [1,2,4,8,16,32];
* begPos: [[Array]] format [[Position#PositionASL|PositionASL]] - virtual line start
  [[hintSilent]] [[format]] ["
* endPos: [[Array]] format [[Position#PositionASL|PositionASL]] - virtual line end
  ONLY_WATER: %1,
* ignoreObj1: [[Object]] - (Optional) - object to ignore
  NEAREST_CONTACT: %2,
* ignoreObj2: [[Object]] - (Optional) - object to ignore
  ONLY_STATIC: %3,
* sortByDistance: [[Boolean]] - (Optional) - [[true]]: furthest object first, closest object last; [[false]]: unsorted
  ONLY_DYNAMIC: %4,
* flags: [[Number]] - (Optional)
  FIRST_CONTACT: %5,
** 1 - CF_ONLY_WATER
  ALL_OBJECTS: %6",
** 2 - CF_NEAREST_CONTACT
  Sto [[select]] 0,Sto [[select]] 1,Sto [[select]] 2,Sto [[select]] 3,Sto [[select]] 4,Sto [[select]] 5];
** 4 - CF_ONLY_STATIC
** 8 - CF_ONLY_DYNAMIC
** 16 - CF_FIRST_CONTACT
** 32 - CF_ALL_OBJECTS (Usable only with CF_FIRST_CONTACT and it will check one contact per object)
Flags can be combined: 2 + 4 = 6 is CF_NEAREST_OBJECT + CF_ONLY_STATIC
 
|r2= [[Array]] format [result1, result2, ...] - each result is an [[Array]] of intersecting objects for the Nth element
 
|x1= <sqf>
data = [];
displayFunction = {
{
data set [_foreachindex, lineIntersectsObjs [eyePos player, ATLToASL screenToWorld [0.5, 0.5], objNull, objNull, false, _x]];
} forEach [1, 2, 4, 8, 16, 32];
 
hintSilent format ["ONLY_WATER: %1\nNEAREST_CONTACT: %2\nONLY_STATIC: %3\nONLY_DYNAMIC: %4\nFIRST_CONTACT: %5\nALL_OBJECTS: %6",
data select 0, data select 1, data select 2, data select 3, data select 4, data select 5];
};
};
["sample_id","onEachFrame","Fn"] [[call]] [[BIS_fnc_addStackedEventHandler]];
//Example display objects' array in the middle of the screen sorted by 6 flags</code>


| [[lineIntersectsSurfaces]], [[lineIntersectsWith]], [[terrainIntersect]], [[terrainIntersectASL]], [[terrainIntersectAtASL]], [[lineIntersects]], [[intersect]], [[cursorObject]], [[cursorTarget]], [[checkVisibility]]
["sample_id", "onEachFrame", "displayFunction"] call BIS_fnc_addStackedEventHandler;
}}
// example display objects' array in the middle of the screen sorted by 6 flags
</sqf>


|x2= Alternative syntax to check intersections in parallel:
<sqf>
private _enemies = units opfor;
private _enemyDataArray = _enemies apply { [eyePos player, aimPos _x, player, _x, true] };
private _result = lineIntersectsObjs _enemyDataArray;
</sqf>


{{GameCategory|arma3|Scripting Commands}}
|seealso= [[lineIntersectsSurfaces]] [[lineIntersectsWith]] [[lineIntersects]] [[terrainIntersectASL]] [[terrainIntersectAtASL]] [[terrainIntersect]] [[intersect]] [[cursorObject]] [[cursorTarget]] [[checkVisibility]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= AgentRev
<dd class="notedate">Posted on March 29, 2016 - 05:07 (UTC)</dd>
|timestamp= 20160329060700
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
|text= Distance sorting is relative to object model center, and not intersect position.
<dd class="note">
}}
Distance sorting is relative to object model center, and not intersect position.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 02:07, 1 December 2024

Arma 3 logo black.png1.10
GAGlobal
Hover & click on the images for description

Description

Description:
Returns a list of objects intersected by the line from begPos to endPos. Since Arma 3 logo black.png2.20, there is an alternative syntax that does multiple checks at once, faster than multiple calls.
Groups:
Math - Geometry

Syntax

Syntax:
lineIntersectsObjs [begPos, endPos, ignoreObj1, ignoreObj2, sortByDistance, flags]
Parameters:
begPos: Array format PositionASL - virtual line start
endPos: Array format PositionASL - virtual line end
ignoreObj1: Object - (Optional) - object to ignore
ignoreObj2: Object - (Optional) - object to ignore
sortByDistance: Boolean - (Optional) - true: furthest object first, closest object last; false: unsorted
flags: Number - (Optional)
  • 1 - CF_ONLY_WATER
  • 2 - CF_NEAREST_CONTACT
  • 4 - CF_ONLY_STATIC
  • 8 - CF_ONLY_DYNAMIC
  • 16 - CF_FIRST_CONTACT
  • 32 - CF_ALL_OBJECTS (Usable only with CF_FIRST_CONTACT and it will check one contact per object)
Flags can be combined: 2 + 4 = 6 is CF_NEAREST_OBJECT + CF_ONLY_STATIC
Return Value:
Array of Objects - intersecting objects

Alternative Syntax

Syntax:
lineIntersectsObjs [element1, element2, ...]
Parameters:
elementN: Array format [begPos, endPos, ignoreObj1, ignoreObj2, sortByDistance, flags]
  • begPos: Array format PositionASL - virtual line start
  • endPos: Array format PositionASL - virtual line end
  • ignoreObj1: Object - (Optional) - object to ignore
  • ignoreObj2: Object - (Optional) - object to ignore
  • sortByDistance: Boolean - (Optional) - true: furthest object first, closest object last; false: unsorted
  • flags: Number - (Optional)
    • 1 - CF_ONLY_WATER
    • 2 - CF_NEAREST_CONTACT
    • 4 - CF_ONLY_STATIC
    • 8 - CF_ONLY_DYNAMIC
    • 16 - CF_FIRST_CONTACT
    • 32 - CF_ALL_OBJECTS (Usable only with CF_FIRST_CONTACT and it will check one contact per object)
Flags can be combined: 2 + 4 = 6 is CF_NEAREST_OBJECT + CF_ONLY_STATIC
Return Value:
Array format [result1, result2, ...] - each result is an Array of intersecting objects for the Nth element

Examples

Example 1:
data = []; displayFunction = { { data set [_foreachindex, lineIntersectsObjs [eyePos player, ATLToASL screenToWorld [0.5, 0.5], objNull, objNull, false, _x]]; } forEach [1, 2, 4, 8, 16, 32]; hintSilent format ["ONLY_WATER: %1\nNEAREST_CONTACT: %2\nONLY_STATIC: %3\nONLY_DYNAMIC: %4\nFIRST_CONTACT: %5\nALL_OBJECTS: %6", data select 0, data select 1, data select 2, data select 3, data select 4, data select 5]; }; ["sample_id", "onEachFrame", "displayFunction"] call BIS_fnc_addStackedEventHandler; // example display objects' array in the middle of the screen sorted by 6 flags
Example 2:
Alternative syntax to check intersections in parallel:
private _enemies = units opfor; private _enemyDataArray = _enemies apply { [eyePos player, aimPos _x, player, _x, true] }; private _result = lineIntersectsObjs _enemyDataArray;

Additional Information

See also:
lineIntersectsSurfaces lineIntersectsWith lineIntersects terrainIntersectASL terrainIntersectAtASL terrainIntersect intersect cursorObject cursorTarget checkVisibility

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
AgentRev - c
Posted on Mar 29, 2016 - 06:07 (UTC)
Distance sorting is relative to object model center, and not intersect position.
Retrieved from "https://community.bistudio.com/wiki?title=lineIntersectsObjs&oldid=370337"