lineIntersectsSurfaces: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Please use notes properly. How To is next to Add New Note button)
No edit summary
 
(140 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3dev |= Game name
|game1= arma3
|1.49|= Game version
|version1= 1.50
|arg= global|= Arguments in MP
|arg= global
____________________________________________________________________________________________


| 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.|= Description
|gr1= Math - Geometry
____________________________________________________________________________________________


| '''lineIntersectsSurfaces''' [begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults] |= Syntax
|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.
|p1= [begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults]: [[Array]]|= Parameter 0
{{Feature|important|
|p2= begPosASL: [[PositionASL]] - virtual line start |= Parameter 1
* 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.
|p3= endPosASL: [[PositionASL]] - virtual line end |= Parameter 2
* only a single LOD is checked for intersection. LOD2 will only be checked if LOD1 is unavailable.
|p4= ignoreObj1 (Optional): [[Object]] - first object to ignore or [[objNull]]: Default: [[objNull]]|=Parameter 3
}}
|p5= ignoreObj2 (Optional): [[Object]] - second object to ignore or [[objNull]]: Default: [[objNull]] |= Parameter 4
|p6= sortMode (Optional): [[Boolean]] - [[true]]: closest to furthest, [[false]]: furthest to closest. Default: [[true]]  |= Parameter 5
|p7= maxResults (Optional): [[Number]] - Max results to return. -1 to return every result. Default: 1|= Parameter 6


| [[Array]] of intersections in format <nowiki>[</nowiki>[intersectPosASL, surfaceNormal, intersectObj, parentObject],...] where:
|s1= [[lineIntersectsSurfaces]] [begPosASL, endPosASL, ignoreObj1, ignoreObj2, sortMode, maxResults, LOD1, LOD2, returnUnique]
* intersectPosASL - the actual position where line intersects 1st surface
* [[surfaceNormal]] - a normal to the intersected surface
* intersectObject - the object the surface belongs to (could be proxy object)
* parentObject - the object proxy object belongs to (not always the same as intersect object)|= Return value
____________________________________________________________________________________________
|x1= <code>_intersections = [[lineIntersectsSurfaces]] <nowiki>[</nowiki>[[eyePos]] [[player]], [[aimPos]] chopper, [[player]], chopper, [[true]], -1];</code> |= Example 1


|x2= <code>arrow = "Sign_Arrow_F" [[createVehicle]] [0,0,0];
|p1= begPosASL: [[Array]] format [[Position#PositionASL|PositionASL]] - virtual line start
[[onEachFrame]] {
 
_ins = [[lineIntersectsSurfaces]] [
|p2= endPosASL: [[Array]] format [[Position#PositionASL|PositionASL]] - virtual line end
[[ATLToASL]] [[positionCameraToWorld]] [0,0,0],  
 
[[ATLToASL]] [[positionCameraToWorld]] [0,0,1000],  
|p3= ignoreObj1: [[Object]] - (Optional, default [[objNull]]) first object to ignore
[[player]]
 
|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"
* "VIEW"
* "GEOM"
* "IFIRE" - ("I" stands for Indirect, ''almost'' identical to "FIRE")
* "NONE"
* {{GVI|arma3|2.02|size= 0.75}} "PHYSX" - PhysX geometry LOD
* {{GVI|arma3|2.08|size= 0.75}} "ROADWAY" - only works from the top
|p7since= arma3 1.52
 
|p8= LOD2: [[String]] - (Optional, default "FIRE") secondary [[LOD]] to look for intersection. See ''LOD1'' for possible values
|p8since= arma3 1.52
 
|p9= returnUnique: [[Boolean]] - (Optional, default [[true]]) when [[false]], all intersections in the same object are included, otherwise only the first one
|p9since= arma3 1.70
 
|r1= [[Array]] of intersections in format [<nowiki/>[intersectPosASL, surfaceNormal, intersectObj, parentObject, selectionNames, pathToBisurf], ...] where:
* intersectPosASL: [[PositionASL]] - the actual position where line intersects surface
* [[surfaceNormal]]: [[Vector]] - a normal to the intersected surface
* intersectObject: [[Object]] - the object the surface belongs to (could be proxy object) - [[objNull]] if terrain
* parentObject: [[Object]] - the object proxy object belongs to (not always the same as intersect object) - [[objNull]] if terrain
* {{GVI|arma3|2.10|size= 0.75}} [[selectionNames]]: [[Array]] of [[String]]s - Names of the intersected selections (bones). Returns {{hl|[]}} if there is no intersection with a selection.
* {{GVI|arma3|2.10|size= 0.75}} pathToBisurf: [[String]] - path to intersected surface properties (.bisurf) file. Returns {{hl|""}} if surface has no special properties. Terrain surface properties begin with {{hl|#}}, and the surface properties are defined in {{hl|CfgSurfaces}}. For example, if it returns {{hl|#GdtVRsurface01}}, properties are defined in: <sqf inline>configFile >> "CfgSurfaces" >> "GdtVRsurface01"</sqf>
 
|x1= <sqf>_intersections = lineIntersectsSurfaces [eyePos player, aimPos chopper, player, chopper, true, -1];</sqf>
 
|x2= <sqf>
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;
};
</sqf>
 
|x3= This should detect glass windows and wire fences (since {{arma3}} v1.52):
<sqf>
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]};
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;
};</code> |= Example 2
};
____________________________________________________________________________________________
</sqf>


| [[lineIntersectsWith]], [[lineIntersectsObjs]], [[terrainIntersect]], [[terrainIntersectASL]], [[lineIntersects]], [[intersect]] |= See also
|seealso= [[lineIntersectsWith]] [[lineIntersectsObjs]] [[terrainIntersect]] [[terrainIntersectASL]] [[terrainIntersectAtASL]] [[lineIntersects]] [[intersect]] [[cursorObject]] [[cursorTarget]] [[checkVisibility]]
}}


{{Note
|user= Killzone_Kid
|timestamp= 20150827124400
|text= Fast check if the player is in a house:
<sqf>
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) };
</sqf>
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Pierre MGI
</dl>
|timestamp= 20160130201000
|text= 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:
<sqf>
MGI_fnc_setPosAGLS = {
params ["_obj", "_pos"];
_wh_pos = getPosASL _obj;


<h3 style="display:none">Bottom Section</h3>
_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;
};
</sqf>
After the position (_pos) obtained in BIS_fnc_buidingPositions array:
<sqf>
private _weaponHolder = createVehicle ["groundWeaponHolder", _pos, [], 0, "CAN_COLLIDE"];
[_weaponHolder, _pos] call MGI_fnc_setPosAGLS;
</sqf>
Then fill your weapon holder.
}}


[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
{{Note
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|user= Tankbuster
|timestamp= 20240106154115
|text= Note that dome_big and dome_small objects have glass roof panels which this function can't see if it intersects those windows
}}

Latest revision as of 16:41, 6 January 2024

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: Array format PositionASL - virtual line start
endPosASL: Array format 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 Arma 3 logo black.png1.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"
  • Arma 3 logo black.png2.02 "PHYSX" - PhysX geometry LOD
  • Arma 3 logo black.png2.08 "ROADWAY" - only works from the top
since Arma 3 logo black.png1.52
LOD2: String - (Optional, default "FIRE") secondary LOD to look for intersection. See LOD1 for possible values
since Arma 3 logo black.png1.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, selectionNames, pathToBisurf], ...] where:
  • intersectPosASL: PositionASL - the actual position where line intersects surface
  • surfaceNormal: Vector - a normal to the intersected surface
  • intersectObject: Object - the object the surface belongs to (could be proxy object) - objNull if terrain
  • parentObject: Object - the object proxy object belongs to (not always the same as intersect object) - objNull if terrain
  • Arma 3 logo black.png2.10 selectionNames: Array of Strings - Names of the intersected selections (bones). Returns [] if there is no intersection with a selection.
  • Arma 3 logo black.png2.10 pathToBisurf: String - path to intersected surface properties (.bisurf) file. Returns "" if surface has no special properties. Terrain surface properties begin with #, and the surface properties are defined in CfgSurfaces. For example, if it returns #GdtVRsurface01, properties are defined in: configFile >> "CfgSurfaces" >> "GdtVRsurface01"

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 3 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:
lineIntersectsWith lineIntersectsObjs terrainIntersect terrainIntersectASL terrainIntersectAtASL lineIntersects 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
Killzone_Kid - c
Posted on Aug 27, 2015 - 12:44 (UTC)
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) };
Pierre MGI - c
Posted on Jan 30, 2016 - 20:10 (UTC)
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.
Tankbuster - c
Posted on Jan 06, 2024 - 15:41 (UTC)
Note that dome_big and dome_small objects have glass roof panels which this function can't see if it intersects those windows