From ab2456b7406d34bb446033de6ce76096f4502c9e Mon Sep 17 00:00:00 2001 From: reduz Date: Wed, 16 Jun 2021 21:52:30 -0300 Subject: Rename VisibilityNotifierXD to VisibleOnScreenNotifierXD * Renames for 2D and 3D * Class name was confusing, given both 2D and 3D have a "visible" property that is unrelated to actual on-screen visibility. * New name makes it clear that this is about visibility on screen. --- doc/classes/VisibilityEnabler2D.xml | 25 ------------------ doc/classes/VisibilityEnabler3D.xml | 30 ---------------------- doc/classes/VisibilityNotifier2D.xml | 42 ------------------------------- doc/classes/VisibilityNotifier3D.xml | 42 ------------------------------- doc/classes/VisibleOnScreenEnabler2D.xml | 25 ++++++++++++++++++ doc/classes/VisibleOnScreenEnabler3D.xml | 30 ++++++++++++++++++++++ doc/classes/VisibleOnScreenNotifier2D.xml | 42 +++++++++++++++++++++++++++++++ doc/classes/VisibleOnScreenNotifier3D.xml | 42 +++++++++++++++++++++++++++++++ 8 files changed, 139 insertions(+), 139 deletions(-) delete mode 100644 doc/classes/VisibilityEnabler2D.xml delete mode 100644 doc/classes/VisibilityEnabler3D.xml delete mode 100644 doc/classes/VisibilityNotifier2D.xml delete mode 100644 doc/classes/VisibilityNotifier3D.xml create mode 100644 doc/classes/VisibleOnScreenEnabler2D.xml create mode 100644 doc/classes/VisibleOnScreenEnabler3D.xml create mode 100644 doc/classes/VisibleOnScreenNotifier2D.xml create mode 100644 doc/classes/VisibleOnScreenNotifier3D.xml (limited to 'doc/classes') diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml deleted file mode 100644 index 8eb16ba075..0000000000 --- a/doc/classes/VisibilityEnabler2D.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisibilityEnabler3D.xml b/doc/classes/VisibilityEnabler3D.xml deleted file mode 100644 index 4614859a44..0000000000 --- a/doc/classes/VisibilityEnabler3D.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - Enables certain nodes only when approximately visible. - - - The VisibilityEnabler3D will disable [RigidBody3D] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler3D itself. - If you just want to receive notifications, use [VisibilityNotifier3D] instead. - [b]Note:[/b] VisibilityEnabler3D uses an approximate heuristic for performance reasons. It doesn't take walls and other occlusion into account. The heuristic is an implementation detail and may change in future versions. If you need precise visibility checking, use another method such as adding an [Area3D] node as a child of a [Camera3D] node and/or [method Vector3.dot]. - [b]Note:[/b] VisibilityEnabler3D will not affect nodes added after scene initialization. - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml deleted file mode 100644 index 78983e74ee..0000000000 --- a/doc/classes/VisibilityNotifier2D.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - Detects when the node extents are visible on screen. - - - The VisibilityNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport. - If you want nodes to be disabled automatically when they exit the screen, use [VisibilityEnabler2D] instead. - - - https://godotengine.org/asset-library/asset/515 - - - - - - - If [code]true[/code], the bounding rectangle is on the screen. - [b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. - - - - - - The VisibilityNotifier2D's bounding rectangle. - - - - - - Emitted when the VisibilityNotifier2D enters the screen. - - - - - Emitted when the VisibilityNotifier2D exits the screen. - - - - - - diff --git a/doc/classes/VisibilityNotifier3D.xml b/doc/classes/VisibilityNotifier3D.xml deleted file mode 100644 index bd6c03ea20..0000000000 --- a/doc/classes/VisibilityNotifier3D.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - Detects approximately when the node is visible on screen. - - - The VisibilityNotifier3D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a [Camera3D]'s view. - If you want nodes to be disabled automatically when they exit the screen, use [VisibilityEnabler3D] instead. - [b]Note:[/b] VisibilityNotifier3D uses an approximate heuristic for performance reasons. It doesn't take walls and other occlusion into account. The heuristic is an implementation detail and may change in future versions. If you need precise visibility checking, use another method such as adding an [Area3D] node as a child of a [Camera3D] node and/or [method Vector3.dot]. - - - - - - - - - If [code]true[/code], the bounding box is on the screen. - [b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. - - - - - - The VisibilityNotifier3D's bounding box. - - - - - - Emitted when the VisibilityNotifier3D enters the screen. - - - - - Emitted when the VisibilityNotifier3D exits the screen. - - - - - - diff --git a/doc/classes/VisibleOnScreenEnabler2D.xml b/doc/classes/VisibleOnScreenEnabler2D.xml new file mode 100644 index 0000000000..c6ae8227d2 --- /dev/null +++ b/doc/classes/VisibleOnScreenEnabler2D.xml @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/VisibleOnScreenEnabler3D.xml b/doc/classes/VisibleOnScreenEnabler3D.xml new file mode 100644 index 0000000000..3205d6b415 --- /dev/null +++ b/doc/classes/VisibleOnScreenEnabler3D.xml @@ -0,0 +1,30 @@ + + + + Enables certain nodes only when approximately visible. + + + The VisibleOnScreenEnabler3D will disable [RigidBody3D] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibleOnScreenEnabler3D itself. + If you just want to receive notifications, use [VisibleOnScreenNotifier3D] instead. + [b]Note:[/b] VisibleOnScreenEnabler3D uses an approximate heuristic for performance reasons. It doesn't take walls and other occlusion into account. The heuristic is an implementation detail and may change in future versions. If you need precise visibility checking, use another method such as adding an [Area3D] node as a child of a [Camera3D] node and/or [method Vector3.dot]. + [b]Note:[/b] VisibleOnScreenEnabler3D will not affect nodes added after scene initialization. + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/VisibleOnScreenNotifier2D.xml b/doc/classes/VisibleOnScreenNotifier2D.xml new file mode 100644 index 0000000000..f2f3bc9144 --- /dev/null +++ b/doc/classes/VisibleOnScreenNotifier2D.xml @@ -0,0 +1,42 @@ + + + + Detects when the node extents are visible on screen. + + + The VisibleOnScreenNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport. + If you want nodes to be disabled automatically when they exit the screen, use [VisibleOnScreenEnabler2D] instead. + + + https://godotengine.org/asset-library/asset/515 + + + + + + + If [code]true[/code], the bounding rectangle is on the screen. + [b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. + + + + + + The VisibleOnScreenNotifier2D's bounding rectangle. + + + + + + Emitted when the VisibleOnScreenNotifier2D enters the screen. + + + + + Emitted when the VisibleOnScreenNotifier2D exits the screen. + + + + + + diff --git a/doc/classes/VisibleOnScreenNotifier3D.xml b/doc/classes/VisibleOnScreenNotifier3D.xml new file mode 100644 index 0000000000..859dacd716 --- /dev/null +++ b/doc/classes/VisibleOnScreenNotifier3D.xml @@ -0,0 +1,42 @@ + + + + Detects approximately when the node is visible on screen. + + + The VisibleOnScreenNotifier3D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a [Camera3D]'s view. + If you want nodes to be disabled automatically when they exit the screen, use [VisibleOnScreenEnabler3D] instead. + [b]Note:[/b] VisibleOnScreenNotifier3D uses an approximate heuristic for performance reasons. It doesn't take walls and other occlusion into account. The heuristic is an implementation detail and may change in future versions. If you need precise visibility checking, use another method such as adding an [Area3D] node as a child of a [Camera3D] node and/or [method Vector3.dot]. + + + + + + + + + If [code]true[/code], the bounding box is on the screen. + [b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. + + + + + + The VisibleOnScreenNotifier3D's bounding box. + + + + + + Emitted when the VisibleOnScreenNotifier3D enters the screen. + + + + + Emitted when the VisibleOnScreenNotifier3D exits the screen. + + + + + + -- cgit v1.2.3