| github_url: | hide |
|---|
Inherits: :ref:`Spatial<class_Spatial>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`
Inherited By: :ref:`VisibilityEnabler<class_VisibilityEnabler>`
Detects when the node is visible on screen.
The VisibilityNotifier detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a :ref:`Camera<class_Camera>`'s view.
| :ref:`AABB<class_AABB>` | :ref:`aabb<class_VisibilityNotifier_property_aabb>` | AABB( -1, -1, -1, 2, 2, 2 ) |
| :ref:`bool<class_bool>` | :ref:`is_on_screen<class_VisibilityNotifier_method_is_on_screen>` ( ) const |
- camera_entered ( :ref:`Camera<class_Camera>` camera )
Emitted when the VisibilityNotifier enters a :ref:`Camera<class_Camera>`'s view.
- camera_exited ( :ref:`Camera<class_Camera>` camera )
Emitted when the VisibilityNotifier exits a :ref:`Camera<class_Camera>`'s view.
- screen_entered ( )
Emitted when the VisibilityNotifier enters the screen.
- screen_exited ( )
Emitted when the VisibilityNotifier exits the screen.
| Default | AABB( -1, -1, -1, 2, 2, 2 ) |
| Setter | set_aabb(value) |
| Getter | get_aabb() |
The VisibilityNotifier's bounding box.
- :ref:`bool<class_bool>` is_on_screen ( ) const
If true, the bounding box is on the screen.
Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return false right after it is instantiated, even if it will be on screen in the draw pass.