screenToWorld: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(4 intermediate revisions by 2 users not shown)
Line 16: Line 16:


|descr= Returns the position on landscape ([[Position#PositionAGL|PositionAGL]]) corresponding to the given point on screen (in UI coordinates).  
|descr= Returns the position on landscape ([[Position#PositionAGL|PositionAGL]]) corresponding to the given point on screen (in UI coordinates).  
{{Feature | informative | This command performs an intersection with the ground/water surface, from the camera position along the [[screenToWorldVector]] vector. In other words, it's similar to doing:  
{{Feature|informative|
This command performs an intersection with the ground/water surface, from the camera position along the [[screenToWorldDirection]] vector up to {{hl|viewDistance}} for terrain intersection and {{hl|2 * viewDistance}} for water intersection. In other words, it is similar to doing:  
<sqf>
<sqf>
private _p1 = AGLtoASL positionCameraToWorld [0,0,0];                 // camera position ASL
private _p1 = AGLToASL positionCameraToWorld [0, 0, 0]; // camera position ASL
private _vector = screenToWorldVector _screenPos;                     // "aim" vector
private _vector = screenToWorldDirection _screenPos; // "aim" vector
private _p2 = _p1 vectorAdd (_vector vectorMultiply viewDistance * 2); // terminal position is 2 x view distance
private _p2 = _p1 vectorAdd (_vector vectorMultiply viewDistance * 2); // the ray does not go beyond 2 * view distance
ASLtoAGL terrainIntersectAtASL [_p1, _p2]
ASLToAGL terrainIntersectAtASL [_p1, _p2]
</sqf>
</sqf>
}}
}}
Line 27: Line 28:
|s1= [[screenToWorld]] screen
|s1= [[screenToWorld]] screen


|p1= screen: [[Array]] - screen position [x,y] (see [[SafeZone]] for more info)
|p1= screen: [[Array]] - screen position in format [x,y] (see [[SafeZone]] for more info)


|r1= [[Array]] - [[Position#PositionAGL|PositionAGL]], world position on surface [x,y,0]
|r1= [[Array]] format [[Position#PositionAGL|PositionAGL]], world position on surface [x,y,0]


|s2= camera [[screenToWorld]] position
|s2= camera [[screenToWorld]] position
|s2since= arma3 2.18


|p21= camera: [[Object]] - camera object
|p21= camera: [[Object]] - camera object
Line 37: Line 40:
|p22= position: [[Array]] - screen position [x,y] (see [[SafeZone]] for more info)
|p22= position: [[Array]] - screen position [x,y] (see [[SafeZone]] for more info)


|r2= [[Array]] - [[Position#PositionAGL|PositionAGL]], world position on surface [x,y,0]
|r2= [[Array]] format [[Position#PositionAGL|PositionAGL]], world position on surface [x,y,0]
 
|x1= <sqf>private _wPos = screenToWorld [0.5, 0.5];</sqf>


|x1= <sqf>_wPos = screenToWorld [0.5, 0.5];</sqf>
|x2= <sqf>private _wPos = _myCamera screenToWorld [0.5, 0.5]; // since {{arma3}} 2.18</sqf>


|seealso= [[SafeZone]] [[worldToScreen]] [[screenToWorldVector]]
|seealso= [[SafeZone]] [[worldToScreen]] [[screenToWorldDirection]]
}}
}}

Latest revision as of 20:54, 6 August 2024

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:
Returns the position on landscape (PositionAGL) corresponding to the given point on screen (in UI coordinates).
ⓘ
This command performs an intersection with the ground/water surface, from the camera position along the screenToWorldDirection vector up to viewDistance for terrain intersection and 2 * viewDistance for water intersection. In other words, it is similar to doing:
private _p1 = AGLToASL positionCameraToWorld [0, 0, 0]; // camera position ASL private _vector = screenToWorldDirection _screenPos; // "aim" vector private _p2 = _p1 vectorAdd (_vector vectorMultiply viewDistance * 2); // the ray does not go beyond 2 * view distance ASLToAGL terrainIntersectAtASL [_p1, _p2]
Groups:
Positions

Syntax

Syntax:
screenToWorld screen
Parameters:
screen: Array - screen position in format [x,y] (see SafeZone for more info)
Return Value:
Array format PositionAGL, world position on surface [x,y,0]

Alternative Syntax

Syntax:
camera screenToWorld position
Parameters:
camera: Object - camera object
position: Array - screen position [x,y] (see SafeZone for more info)
Return Value:
Array format PositionAGL, world position on surface [x,y,0]

Examples

Example 1:
private _wPos = screenToWorld [0.5, 0.5];
Example 2:
private _wPos = _myCamera screenToWorld [0.5, 0.5]; // since Arma 3 2.18

Additional Information

See also:
SafeZone worldToScreen screenToWorldDirection

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=screenToWorld&oldid=366288"