2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "VisibilityNotifier" inherits= "Spatial" category= "Core" version= "3.0.alpha.custom_build" >
<brief_description >
2017-09-17 00:09:13 +08:00
Detects when the node is visible on screen.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2017-09-17 00:09:13 +08:00
The VisibilityNotifier detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a [Camera]'s view.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "get_aabb" qualifiers= "const" >
<return type= "Rect3" >
</return>
<description >
2017-09-17 00:09:13 +08:00
Returns the bounding box of the VisibilityNotifier.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "is_on_screen" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2017-09-17 00:09:13 +08:00
If [code]true[/code] the bounding box is on the screen.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "set_aabb" >
<return type= "void" >
</return>
<argument index= "0" name= "rect" type= "Rect3" >
</argument>
<description >
Set the visibility bounding box of the VisibilityNotifier.
</description>
</method>
</methods>
<members >
2017-09-13 14:49:40 +08:00
<member name= "aabb" type= "Rect3" setter= "set_aabb" getter= "get_aabb" >
2017-09-17 00:09:13 +08:00
The VisibilityNotifier's bounding box.
2017-09-13 04:42:36 +08:00
</member>
</members>
<signals >
<signal name= "camera_entered" >
<argument index= "0" name= "camera" type= "Object" >
</argument>
<description >
Emitted when the VisibilityNotifier enters a [Camera]'s view.
</description>
</signal>
<signal name= "camera_exited" >
<argument index= "0" name= "camera" type= "Object" >
</argument>
<description >
Emitted when the VisibilityNotifier exits a [Camera]'s view.
</description>
</signal>
<signal name= "screen_entered" >
<description >
Emitted when the VisibilityNotifier enters the screen.
</description>
</signal>
<signal name= "screen_exited" >
<description >
Emitted when the VisibilityNotifier exits the screen.
</description>
</signal>
</signals>
<constants >
</constants>
</class>