summaryrefslogtreecommitdiff
path: root/doc/classes/VisibilityNotifier.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/VisibilityNotifier.xml')
-rw-r--r--doc/classes/VisibilityNotifier.xml71
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml
new file mode 100644
index 0000000000..816523fc27
--- /dev/null
+++ b/doc/classes/VisibilityNotifier.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Detects when the node is visible on screen.
+ </brief_description>
+ <description>
+ 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.
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_aabb" qualifiers="const">
+ <return type="Rect3">
+ </return>
+ <description>
+ Returns the bounding box of the VisibilityNotifier.
+ </description>
+ </method>
+ <method name="is_on_screen" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ If [code]true[/code] the bounding box is on the screen.
+ </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>
+ <member name="aabb" type="Rect3" setter="set_aabb" getter="get_aabb">
+ The VisibilityNotifier's bounding box.
+ </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>