worldToScreen: Difference between revisions

Latest revision as of 17:25, 26 July 2024

1.00

1.50

1.00

0.50

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.

2.18

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

@@ Line 1: / Line 1: @@
-{{Command
+{{RV|type=command
-| arma2
+|game1= arma2
+|version1= 1.00
-|1.00
+|game2= arma2oa
+|version2= 1.50
+|game3= tkoh
+|version3= 1.00
+|game4= arma3
+|version4= 0.50
 |gr1= Positions
-| 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.
+|descr= 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.
+{{Feature | informative | [[SafeZone]]s 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
+}}
-| [[worldToScreen]] position
+|s1= [[worldToScreen]] position
-|p1= position: [[Array]] - World position 2D [x,y] or [[PositionAGL]]
+|p1= position: [[Array]] - world position 2D [x,y] or [[Position#PositionAGL|PositionAGL]]
-| [[Array]] - Screen position [x,y] (see [[SafeZone]] for more info) - [] if not on-screen
+|r1= [[Array]] - screen position in [[SafeZone]] format [x, y]. Returns an empty array {{hl|[]}} if not on-screen.
-|x1= <code>_screenPos = [[worldToScreen]] [[getPos]] soldier1;</code>
+|s2= camera [[worldToScreen]] position
+|s2since= arma3 2.18
-|x2= <code>_screenPos = [[worldToScreen]] ([[player]] [[modelToWorld]] [0,10,0]);</code>
+|p21= camera: [[Object]] - camera object
-| [[screenToWorld]], [[SafeZone]]
+|p22= position: [[Array]] - world position 2D [x,y] or [[Position#PositionAGL|PositionAGL]]
-}}
-<dl class='command_description'>
+|r2= [[Array]] - screen position in [[SafeZone]] format [x, y], for the specified camera. Returns an empty array {{hl|[]}} if not on-screen.
-<!-- Note Section BEGIN -->
-<dd class="notedate">Posted on august 19th, 2012 - 19:19 (GMT+1)
+|x1= <sqf>_screenPos = worldToScreen ASLToAGL getPosASL soldier1;</sqf>
-<dt class="note">[[User:Lou Montana|Lou Montana]]
-<dd class="note"> please take [[SafeZone|safezones]] in consideration: the returned result can be out of the [0,0]..[1,1] range and can also be a filled array even if the position is not displayed on your monitor - this command thinks of triplescreens configurations as well. [] returned = not rendered
-<!-- Note Section END -->
+|x2= <sqf>_screenPos = worldToScreen (player modelToWorld [0,10,0]);</sqf>
-</dl>
-<h3 style='display:none'>Bottom Section</h3>
+|seealso= [[screenToWorld]] [[SafeZone]]
-{{GameCategory|arma3|Scripting Commands}}
+}}
-{{GameCategory|tkoh|Scripting Commands}}