Difference between revisions of "lineIntersectsSurfaces"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
m (Some wiki formatting)
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{RV|type=command
 
{{RV|type=command
  
| arma3
+
|game1= arma3
|1.50
+
|version1= 1.50
 
|arg= global
 
|arg= global
  
 
|gr1= Math - Geometry
 
|gr1= Math - Geometry
  
| Returns list of intersections with surfaces from ''begPosASL'' to ''endPosASL''. If there is ground intersection, it is also included. Works on units. Works underwater. Doesn't return intersection with sea surface. Hardcoded max distance: 5000m. By default, for speed purposes, command will return only 1st intersection with unique objects. Since Arma 3 v1.70, this could be tweaked with an optional param.  
+
|descr= Returns a list of intersections with surfaces and ground from ''begPosASL'' to ''endPosASL''. Doesn't return intersection with sea surface. Works underwater, unlike [[lineIntersects]]. Hardcoded max distance: 5000m.
{{Feature | Informative | If ''begPosASL'' is under the ground and ''endPosASL'' is above it, the command will only return intersection with the ground, this is engine limitation and none of the intersectXXX commands will work when initiated from under the ground.}}
+
{{Feature|important|
Since Arma v1.52 it is possible to indicate primary and secondary [[LOD]] to look for intersection. Available options are:
+
* if ''begPosASL'' is under the ground and ''endPosASL'' is above it, the command will only return intersection with the ground, this is an engine limitation and none of the intersectXXX commands will work when initiated from under the ground.
 +
* only a single LOD is checked for intersection. LOD2 will only be checked if LOD1 is unavailable.
 +
}}
 +
 
 +
|s1= [[lineIntersectsSurfaces]] [begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults, LOD1, LOD2, returnUnique]
 +
 
 +
|p1= begPosASL: [[PositionASL]] - virtual line start
 +
 
 +
|p2= endPosASL: [[PositionASL]] - virtual line end
 +
 
 +
|p3= ignoreObj1: [[Object]] - (Optional, default [[objNull]]) first object to ignore
 +
 
 +
|p4= ignoreObj2: [[Object]] - (Optional, default [[objNull]]) second object to ignore
 +
 
 +
|p5= sortMode: [[Boolean]] -  (Optional, default [[true]]) [[true]]: closest to furthest, [[false]]: furthest to closest
 +
 
 +
|p6= maxResults: [[Number]] - (Optional, default 1) max results to return. -1 to return every result
 +
 
 +
|p7= LOD1: [[String]] - (Optional, default "VIEW") primary [[LOD]] to look for intersection. Can be one of:
 
* "FIRE"
 
* "FIRE"
 
* "VIEW"
 
* "VIEW"
 
* "GEOM"
 
* "GEOM"
* "IFIRE" - ("I" stands for Indirect, practically the same as FIRE)
+
* "IFIRE" - ("I" stands for Indirect, ''almost'' identical to "FIRE")
 
* "NONE"
 
* "NONE"
* "PHYSX" - PhysX geometry LOD (since Arma 3 v2.01.146666)
+
* {{GVI|arma3|2.02|size=0.8}} "PHYSX" - PhysX geometry LOD
 
+
|p7since= arma3 1.52
Default [[LOD]]s are "VIEW" and "FIRE"
 
{{Feature | important | Only a single LOD is checked for intersection. LOD1 is Primary LOD and will be checked first. LOD2 is Secondary LOD. If LOD1 is not possible to check, LOD2 will be used.}}
 
  
| '''lineIntersectsSurfaces''' [begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults, LOD1, LOD2, returnUnique]
+
|p8= LOD2: [[String]] - (Optional, default "FIRE") secondary [[LOD]] to look for intersection. See ''LOD1'' for possible values
|p1= [begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults, LOD1, LOD2]: [[Array]]
+
|p8since= arma3 1.52
|p2= begPosASL: [[PositionASL]] - virtual line start
 
  
|p3= endPosASL: [[PositionASL]] - virtual line end
+
|p9= returnUnique: [[Boolean]] - (Optional, default [[true]]) when [[false]], all intersections in the same object are included, otherwise only the first one
|p4= ignoreObj1 (Optional): [[Object]] - first object to ignore or [[objNull]]: Default: [[objNull]]
+
|p9since= arma3 1.70
|p5= ignoreObj2 (Optional): [[Object]] - second object to ignore or [[objNull]]: Default: [[objNull]]
 
|p6= sortMode (Optional): [[Boolean]] - [[true]]: closest to furthest, [[false]]: furthest to closest. Default: [[true]]
 
|p7= maxResults (Optional): [[Number]] - Max results to return. -1 to return every result. Default: 1
 
|p8= LOD1 (Optional): [[String]] (added in v1.52) - Primary [[LOD]] to look for intersection. Default: "VIEW"
 
|p9= LOD2 (Optional): [[String]] (added in v1.52) - Secondary [[LOD]] to look for intersection. Default: "FIRE"
 
|p10= returnUnique (Optional): [[Boolean]] (added in v1.70) - When [[false]], all intersections in the same object are included not just the 1st one. Default: [[true]]
 
  
| [[Array]] of intersections in format [<nowiki/>[intersectPosASL, surfaceNormal, intersectObj, parentObject],...] where:
+
|r1= [[Array]] of intersections in format [<nowiki/>[intersectPosASL, surfaceNormal, intersectObj, parentObject], ...] where:
 
* intersectPosASL - the actual position where line intersects surface
 
* intersectPosASL - the actual position where line intersects surface
 
* [[surfaceNormal]] - a normal to the intersected surface  
 
* [[surfaceNormal]] - a normal to the intersected surface  
 
* intersectObject - the object the surface belongs to (could be proxy object) - [[objNull]] if terrain
 
* intersectObject - the object the surface belongs to (could be proxy object) - [[objNull]] if terrain
* parentObject - the object proxy object belongs to (not always the same as intersect object) - objNull if terrain
+
* parentObject - the object proxy object belongs to (not always the same as intersect object) - [[objNull]] if terrain
 +
 
 
|x1= <code>_intersections = [[lineIntersectsSurfaces]] [<nowiki/>[[eyePos]] [[player]], [[aimPos]] chopper, [[player]], chopper, [[true]], -1];</code>
 
|x1= <code>_intersections = [[lineIntersectsSurfaces]] [<nowiki/>[[eyePos]] [[player]], [[aimPos]] chopper, [[player]], chopper, [[true]], -1];</code>
  
Line 47: Line 57:
 
[[player]]
 
[[player]]
 
];
 
];
[[if]] ([[count]] _ins == 0) [[exitWith]] {arrow [[setPosASL]] [0,0,0]};
+
[[if]] ([[count]] _ins == 0) [[exitWith]] { arrow [[setPosASL]] [0,0,0] };
arrow [[setPosASL]] (_ins [[select]] 0 [[select]] 0);  
+
arrow [[setPosASL]] (_ins [[select]] 0 [[select]] 0);
 
arrow [[setVectorUp]] (_ins [[select]] 0 [[select]] 1);
 
arrow [[setVectorUp]] (_ins [[select]] 0 [[select]] 1);
 
[[hintSilent]] [[str]] _ins;
 
[[hintSilent]] [[str]] _ins;
Line 66: Line 76:
 
"NONE"
 
"NONE"
 
];
 
];
[[if]] ([[count]] _ins == 0) [[exitWith]] {arrow [[setPosASL]] [0,0,0]};
+
[[if]] ([[count]] _ins == 0) [[exitWith]] { arrow [[setPosASL]] [0,0,0] };
arrow [[setPosASL]] (_ins [[select]] 0 [[select]] 0);  
+
arrow [[setPosASL]] (_ins [[select]] 0 [[select]] 0);
 
arrow [[setVectorUp]] (_ins [[select]] 0 [[select]] 1);
 
arrow [[setVectorUp]] (_ins [[select]] 0 [[select]] 1);
 
[[hintSilent]] [[str]] _ins;
 
[[hintSilent]] [[str]] _ins;
Line 76: Line 86:
  
  
 +
<dl class="command_description">
  
{{GameCategory|arma3|Scripting Commands}}
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
 
<dl class="command_description">
 
 
<dt></dt>
 
<dt></dt>
 
<dd class="notedate">Posted on August 27, 2015 - 12:44 (UTC)</dd>
 
<dd class="notedate">Posted on August 27, 2015 - 12:44 (UTC)</dd>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<dd class="note">
 
<dd class="note">
Fast check if object is in a house:<code>KK_fnc_inHouse = {
+
Fast check if the player is in a house:<code>KK_fnc_inHouse = {
 
[[lineIntersectsSurfaces]] [
 
[[lineIntersectsSurfaces]] [
 
[[getPosWorld]] _this,  
 
[[getPosWorld]] _this,  
Line 91: Line 98:
 
_this, [[objNull]], [[true]], 1, "GEOM", "NONE"
 
_this, [[objNull]], [[true]], 1, "GEOM", "NONE"
 
] [[select]] 0 [[params]] ["","","","_house"];
 
] [[select]] 0 [[params]] ["","","","_house"];
[[if]] (_house [[isKindOf]] "House") [[exitWith]] {[[true]]};
+
[[if]] (_house [[isKindOf]] "House") [[exitWith]] { [[true]] };
 
[[false]]
 
[[false]]
 
};
 
};
[[onEachFrame]] {[[hintSilent]] [[str]] ([[player]] [[call]] KK_fnc_inHouse)};</code>
+
[[onEachFrame]] { [[hintSilent]] [[str]] ([[player]] [[call]] KK_fnc_inHouse) };</code>
 
</dd>
 
</dd>
</dl>
 
  
<dl class="command_description">
 
 
<dt></dt>
 
<dt></dt>
 
<dd class="notedate">Posted on January 30, 2016 - 20:10 (UTC)</dd>
 
<dd class="notedate">Posted on January 30, 2016 - 20:10 (UTC)</dd>
Line 105: Line 110:
 
This command is useful to place weaponholder (and then spawned weapons) on floor of houses, correcting  the spawn position (can_collide) to intersect with floor:
 
This command is useful to place weaponholder (and then spawned weapons) on floor of houses, correcting  the spawn position (can_collide) to intersect with floor:
 
<code>MGI_fnc_setPosAGLS = {
 
<code>MGI_fnc_setPosAGLS = {
  [[params]] ["_obj", "_pos"];
+
[[params]] ["_obj", "_pos"];
  _wh_pos = [[getPosASL]] _obj;
+
_wh_pos = [[getPosASL]] _obj;
  
  _pos [[set]] [2, ([[ATLtoASL]] _pos [[select]] 2)-10];
+
_pos [[set]] [2, ([[ATLtoASL]] _pos [[select]] 2) - 10];
_ins = [[lineIntersectsSurfaces]] [_wh_pos, _pos,_obj,[[objNull]], [[true]],1,"VIEW","FIRE"];
+
_ins = [[lineIntersectsSurfaces]] [_wh_pos, _pos,_obj, [[objNull]], [[true]], 1, "VIEW", "FIRE"];
_surface_distance = [[if]] ([[count]] _ins > 0) [[then]] [{(_ins [[select]] 0 [[select]] 0) [[distance]] _wh_pos},{0}];
+
_surface_distance = [[if]] ([[count]] _ins > 0) [[then]] [{ (_ins [[select]] 0 [[select]] 0) [[distance]] _wh_pos }, { 0 }];
_wh_pos [[set]] [2, ([[getPosASL]] _obj [[select]] 2) - (_surface_distance)];
+
_wh_pos [[set]] [2, ([[getPosASL]] _obj [[select]] 2) - (_surface_distance)];
_weaponholder [[setPosASL]] _wh_pos;
+
_weaponholder [[setPosASL]] _wh_pos;
 
};
 
};
 
</code>
 
</code>
 
After the position (_pos) obtained in BIS_fnc_buidingPositions array:
 
After the position (_pos) obtained in BIS_fnc_buidingPositions array:
<code>_weaponholder = [[createVehicle]] ["groundWeaponHolder", _pos, [], 0, "CAN_COLLIDE"];
+
<code>[[private]] _weaponHolder = [[createVehicle]] ["groundWeaponHolder", _pos, [], 0, "CAN_COLLIDE"];
[_weaponholder,_pos] [[call]] MGI_fnc_setPosAGLS;
+
[_weaponHolder, _pos] [[call]] MGI_fnc_setPosAGLS;
 
Then fill your weapon holder.
 
Then fill your weapon holder.
 
</code>
 
</code>
 
</dd>
 
</dd>
 +
 
</dl>
 
</dl>

Latest revision as of 00:50, 11 August 2021

Hover & click on the images for description

Description

Description:
Returns a list of intersections with surfaces and ground from begPosASL to endPosASL. Doesn't return intersection with sea surface. Works underwater, unlike lineIntersects. Hardcoded max distance: 5000m.
  • if begPosASL is under the ground and endPosASL is above it, the command will only return intersection with the ground, this is an engine limitation and none of the intersectXXX commands will work when initiated from under the ground.
  • only a single LOD is checked for intersection. LOD2 will only be checked if LOD1 is unavailable.
Groups:
Math - Geometry

Syntax

Syntax:
lineIntersectsSurfaces [begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults, LOD1, LOD2, returnUnique]
Parameters:
begPosASL: PositionASL - virtual line start
endPosASL: PositionASL - virtual line end
ignoreObj1: Object - (Optional, default objNull) first object to ignore
ignoreObj2: Object - (Optional, default objNull) second object to ignore
sortMode: Boolean - (Optional, default true) true: closest to furthest, false: furthest to closest
maxResults: Number - (Optional, default 1) max results to return. -1 to return every result
since 25.2px1.52
LOD1: String - (Optional, default "VIEW") primary LOD to look for intersection. Can be one of:
  • "FIRE"
  • "VIEW"
  • "GEOM"
  • "IFIRE" - ("I" stands for Indirect, almost identical to "FIRE")
  • "NONE"
  • 23.6px2.02 "PHYSX" - PhysX geometry LOD
since 25.2px1.52
LOD2: String - (Optional, default "FIRE") secondary LOD to look for intersection. See LOD1 for possible values
since 25.2px1.70
returnUnique: Boolean - (Optional, default true) when false, all intersections in the same object are included, otherwise only the first one
Return Value:
Array of intersections in format [[intersectPosASL, surfaceNormal, intersectObj, parentObject], ...] where:
  • intersectPosASL - the actual position where line intersects surface
  • surfaceNormal - a normal to the intersected surface
  • intersectObject - the object the surface belongs to (could be proxy object) - objNull if terrain
  • parentObject - the object proxy object belongs to (not always the same as intersect object) - objNull if terrain

Examples

Example 1:
_intersections = lineIntersectsSurfaces [eyePos player, aimPos chopper, player, chopper, true, -1];
Example 2:
arrow = "Sign_Arrow_F" createVehicle [0,0,0]; onEachFrame { _ins = lineIntersectsSurfaces [ AGLToASL positionCameraToWorld [0,0,0], AGLToASL positionCameraToWorld [0,0,1000], player ]; if (count _ins == 0) exitWith { arrow setPosASL [0,0,0] }; arrow setPosASL (_ins select 0 select 0); arrow setVectorUp (_ins select 0 select 1); hintSilent str _ins; };
Example 3:
This should detect glass windows and wire fences (since Arma v1.52): wirefence = "Land_New_WiredFence_5m_F" createVehicle position player; arrow = "Sign_Arrow_F" createVehicle [0,0,0]; onEachFrame { _ins = lineIntersectsSurfaces [ AGLToASL positionCameraToWorld [0,0,0], AGLToASL positionCameraToWorld [0,0,1000], player, objNull, true, 1, "GEOM", "NONE" ]; if (count _ins == 0) exitWith { arrow setPosASL [0,0,0] }; arrow setPosASL (_ins select 0 select 0); arrow setVectorUp (_ins select 0 select 1); hintSilent str _ins; };

Additional Information

See also:
lineIntersectsWithlineIntersectsObjsterrainIntersectterrainIntersectASLterrainIntersectAtASLlineIntersectsintersectcursorObjectcursorTargetcheckVisibility

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 August 27, 2015 - 12:44 (UTC)
Killzone Kid
Fast check if the player is in a house:KK_fnc_inHouse = { lineIntersectsSurfaces [ getPosWorld _this, getPosWorld _this vectorAdd [0, 0, 50], _this, objNull, true, 1, "GEOM", "NONE" ] select 0 params ["","","","_house"]; if (_house isKindOf "House") exitWith { true }; false }; onEachFrame { hintSilent str (player call KK_fnc_inHouse) };
Posted on January 30, 2016 - 20:10 (UTC)
Pierre MGI
This command is useful to place weaponholder (and then spawned weapons) on floor of houses, correcting the spawn position (can_collide) to intersect with floor: MGI_fnc_setPosAGLS = { params ["_obj", "_pos"]; _wh_pos = getPosASL _obj; _pos set [2, (ATLtoASL _pos select 2) - 10]; _ins = lineIntersectsSurfaces [_wh_pos, _pos,_obj, objNull, true, 1, "VIEW", "FIRE"]; _surface_distance = if (count _ins > 0) then [{ (_ins select 0 select 0) distance _wh_pos }, { 0 }]; _wh_pos set [2, (getPosASL _obj select 2) - (_surface_distance)]; _weaponholder setPosASL _wh_pos; }; After the position (_pos) obtained in BIS_fnc_buidingPositions array: private _weaponHolder = createVehicle ["groundWeaponHolder", _pos, [], 0, "CAN_COLLIDE"]; [_weaponHolder, _pos] call MGI_fnc_setPosAGLS; Then fill your weapon holder.