VisibilityNotifier.xml 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.1">
  3. <brief_description>
  4. Detects when the node is visible on screen.
  5. </brief_description>
  6. <description>
  7. 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.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="is_on_screen" qualifiers="const">
  15. <return type="bool">
  16. </return>
  17. <description>
  18. If [code]true[/code], the bounding box is on the screen.
  19. </description>
  20. </method>
  21. </methods>
  22. <members>
  23. <member name="aabb" type="AABB" setter="set_aabb" getter="get_aabb">
  24. The VisibilityNotifier's bounding box.
  25. </member>
  26. </members>
  27. <signals>
  28. <signal name="camera_entered">
  29. <argument index="0" name="camera" type="Camera">
  30. </argument>
  31. <description>
  32. Emitted when the VisibilityNotifier enters a [Camera]'s view.
  33. </description>
  34. </signal>
  35. <signal name="camera_exited">
  36. <argument index="0" name="camera" type="Camera">
  37. </argument>
  38. <description>
  39. Emitted when the VisibilityNotifier exits a [Camera]'s view.
  40. </description>
  41. </signal>
  42. <signal name="screen_entered">
  43. <description>
  44. Emitted when the VisibilityNotifier enters the screen.
  45. </description>
  46. </signal>
  47. <signal name="screen_exited">
  48. <description>
  49. Emitted when the VisibilityNotifier exits the screen.
  50. </description>
  51. </signal>
  52. </signals>
  53. <constants>
  54. </constants>
  55. </class>