asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #43139 from Calinou/doc-unproject-position-behind

Browse source 
Document hiding a Control when its reference point is behind the camera
This commit is contained in:
Rémi Verschelde 2020-10-27 23:18:16 +01:00 committed by GitHub
commit 98ee852fd3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/classes/Camera3D.xml
View file

@ -163,6 +163,13 @@
</argument> </argument>
<description> <description>
Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in worldspace. Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in worldspace.
[b]Note:[/b] When using this to position GUI elements over a 3D viewport, use [method is_position_behind] to prevent them from appearing if the 3D point is behind the camera:
[codeblock]
# This code block is part of a script that inherits from Node3D.
# `control` is a reference to a node inheriting from Control.
control.visible = not get_viewport().get_camera().is_position_behind(global_transform.origin)
control.rect_position = get_viewport().get_camera().unproject_position(global_transform.origin)
[/codeblock]
</description> </description>
</method> </method>
</methods> </methods>