summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-10-27 17:35:41 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-10-27 17:37:03 +0100
commitb3a6937c0c36fcca761d4c18a6d711bdb24a967e (patch)
treec716c96ae228b1f8753b793d11a4c8c68fb35d09 /doc/classes
parent67f64ef4fe61d0c9c8f46804448fcf1196cae525 (diff)
Document hiding a Control when its reference point is behind the camera
See https://github.com/godotengine/godot/issues/1725.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Camera3D.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml
index b6a108fb25..b3fe452b12 100644
--- a/doc/classes/Camera3D.xml
+++ b/doc/classes/Camera3D.xml
@@ -163,6 +163,13 @@
</argument>
<description>
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>
</method>
</methods>