VisibilityNotifier

Inherits: Spatial < Node < Object

Inherited By: VisibilityEnabler

Category: Core

Brief Description

Detect when the node is visible on screen.

Member Functions

Rect3 get_aabb ( ) const
bool is_on_screen ( ) const
void set_aabb ( Rect3 rect )

Signals

  • enter_camera ( Object camera )

Emitted when the VisibilityNotifier enters a Camera’s view.

  • enter_screen ( )

Emitted when the VisibilityNotifier enters the screen.

  • exit_camera ( Object camera )

Emitted when the VisibilityNotifier exits a Camera’s view.

  • exit_screen ( )

Emitted when the VisibilityNotifier exits the screen.

Description

The VisibilityNotifier is used to notify when its bounding box enters the screen, is visible on the screen, or when it exits the screen.

Member Function Description

  • Rect3 get_aabb ( ) const

Return the visibility bounding box of the VisibilityNotifier.

  • bool is_on_screen ( ) const

Return true if any part of the bounding box is on the screen.

  • void set_aabb ( Rect3 rect )

Set the visibility bounding box of the VisibilityNotifier.