worldToScreen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "ASLtoAGL" to "ASLToAGL")
m (Added version to alt syntax)
 
(4 intermediate revisions by 2 users not shown)
Line 23: Line 23:
|s1= [[worldToScreen]] position
|s1= [[worldToScreen]] position


|p1= position: [[Array]] - World position 2D [x,y] or [[Position#PositionAGL|PositionAGL]]
|p1= position: [[Array]] - world position 2D [x,y] or [[Position#PositionAGL|PositionAGL]]


|r1= [[Array]] - Screen position in [[SafeZone]] format [x, y]. Returns an empty array {{hl|[]}} if not on-screen.
|r1= [[Array]] - screen position in [[SafeZone]] format [x, y]. Returns an empty array {{hl|[]}} if not on-screen.
 
|s2= camera [[worldToScreen]] position
|s2since= arma3 2.18
 
|p21= camera: [[Object]] - camera object
 
|p22= position: [[Array]] - world position 2D [x,y] or [[Position#PositionAGL|PositionAGL]]
 
|r2= [[Array]] - screen position in [[SafeZone]] format [x, y], for the specified camera. Returns an empty array {{hl|[]}} if not on-screen.


|x1= <sqf>_screenPos = worldToScreen ASLToAGL getPosASL soldier1;</sqf>
|x1= <sqf>_screenPos = worldToScreen ASLToAGL getPosASL soldier1;</sqf>

Latest revision as of 17:25, 26 July 2024

Hover & click on the images for description

Description

Description:
Converts position in world space into screen (UI) space. If a specified position is not within the current screen view, an empty array is returned.
SafeZones should be considered:
  • the result can be out of the [0,0]..[1,1] range
  • the result can be a filled array even if the position is not displayed on screen if it would appear on a triplescreen setup
Groups:
Positions

Syntax

Syntax:
worldToScreen position
Parameters:
position: Array - world position 2D [x,y] or PositionAGL
Return Value:
Array - screen position in SafeZone format [x, y]. Returns an empty array [] if not on-screen.

Alternative Syntax

Syntax:
camera worldToScreen position
Parameters:
camera: Object - camera object
position: Array - world position 2D [x,y] or PositionAGL
Return Value:
Array - screen position in SafeZone format [x, y], for the specified camera. Returns an empty array [] if not on-screen.

Examples

Example 1:
_screenPos = worldToScreen ASLToAGL getPosASL soldier1;
Example 2:
_screenPos = worldToScreen (player modelToWorld [0,10,0]);

Additional Information

See also:
screenToWorld SafeZone

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