VisibleOnScreenNotifier3D
A box-shaped region of 3D space that detects whether it is visible on screen.
A box-shaped region of 3D space that detects whether it is visible on screen.
VisibleOnScreenNotifier3D represents a box-shaped region of 3D space. When any part of this region becomes visible on screen or in a Camera3D's view, it will emit a VisibleOnScreenNotifier3D.ScreenEntered signal, and likewise it will emit a VisibleOnScreenNotifier3D.ScreenExited signal when no part of it remains visible.
If you want a node to be enabled automatically when this region is visible on screen, use VisibleOnScreenEnabler3D.
Note: VisibleOnScreenNotifier3D uses an approximate heuristic that doesn't take walls and other occlusion into account, unless occlusion culling is used. It also won't function unless Entity3D.Visible is set to true.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
VisibleOnScreenNotifier3DConstructor
public VisibleOnScreenNotifier3D();Properties1
AabbProperty
public Aabb Aabb { get; set; }The VisibleOnScreenNotifier3D's bounding box.
Methods2
IsOnScreenbool
public bool IsOnScreen();Returns true if the bounding box is on the screen.
Note: It takes one frame for the VisibleOnScreenNotifier3D's visibility to be assessed once added to the scene tree, so this method will always return false right after it is instantiated.
boolSetAabbvoid
public void SetAabb(Aabb rect);| Name | Type | Default |
|---|---|---|
rect | Aabb | — |
Signals and events2
ScreenEnteredEvent
public event Action ScreenEntered;Emitted when the VisibleOnScreenNotifier3D enters the screen.
ScreenExitedEvent
public event Action ScreenExited;Emitted when the VisibleOnScreenNotifier3D exits the screen.