Merge pull request #49670 from reduz/rename-visibility-notifiers
Rename VisibilityNotifier2D/3D to VisibleOnScreenNotifier2D/3D
This commit is contained in:
Rémi Verschelde
GitHub
commit
085e1d3c03
21 changed files with 164 additions and 156 deletions
|
|
@ -1,30 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisibilityEnabler3D" inherits="VisibilityNotifier3D" version="4.0">
|
||||
<brief_description>
|
||||
Enables certain nodes only when approximately visible.
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="enable_mode" type="int" setter="set_enable_mode" getter="get_enable_mode" enum="VisibilityEnabler3D.EnableMode" default="0">
|
||||
</member>
|
||||
<member name="enable_node_path" type="NodePath" setter="set_enable_node_path" getter="get_enable_node_path" default="NodePath("..")">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
<constant name="ENABLE_MODE_INHERIT" value="0" enum="EnableMode">
|
||||
</constant>
|
||||
<constant name="ENABLE_MODE_ALWAYS" value="1" enum="EnableMode">
|
||||
</constant>
|
||||
<constant name="ENABLE_MODE_WHEN_PAUSED" value="2" enum="EnableMode">
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" version="4.0">
|
||||
<class name="VisibleOnScreenEnabler2D" inherits="VisibleOnScreenNotifier2D" version="4.0">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
|
|
@ -9,7 +9,7 @@
|
|||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="enable_mode" type="int" setter="set_enable_mode" getter="get_enable_mode" enum="VisibilityEnabler2D.EnableMode" default="0">
|
||||
<member name="enable_mode" type="int" setter="set_enable_mode" getter="get_enable_mode" enum="VisibleOnScreenEnabler2D.EnableMode" default="0">
|
||||
</member>
|
||||
<member name="enable_node_path" type="NodePath" setter="set_enable_node_path" getter="get_enable_node_path" default="NodePath("..")">
|
||||
</member>
|
||||
30
doc/classes/VisibleOnScreenEnabler3D.xml
Normal file
30
doc/classes/VisibleOnScreenEnabler3D.xml
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisibleOnScreenEnabler3D" inherits="VisibleOnScreenNotifier3D" version="4.0">
|
||||
<brief_description>
|
||||
Enables certain nodes only when approximately visible.
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="enable_mode" type="int" setter="set_enable_mode" getter="get_enable_mode" enum="VisibleOnScreenEnabler3D.EnableMode" default="0">
|
||||
</member>
|
||||
<member name="enable_node_path" type="NodePath" setter="set_enable_node_path" getter="get_enable_node_path" default="NodePath("..")">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
<constant name="ENABLE_MODE_INHERIT" value="0" enum="EnableMode">
|
||||
</constant>
|
||||
<constant name="ENABLE_MODE_ALWAYS" value="1" enum="EnableMode">
|
||||
</constant>
|
||||
<constant name="ENABLE_MODE_WHEN_PAUSED" value="2" enum="EnableMode">
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisibilityNotifier2D" inherits="Node2D" version="4.0">
|
||||
<class name="VisibleOnScreenNotifier2D" inherits="Node2D" version="4.0">
|
||||
<brief_description>
|
||||
Detects when the node extents are visible on screen.
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
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.
|
||||
</description>
|
||||
<tutorials>
|
||||
<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>
|
||||
|
|
@ -22,18 +22,18 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="rect" type="Rect2" setter="set_rect" getter="get_rect" default="Rect2( -10, -10, 20, 20 )">
|
||||
The VisibilityNotifier2D's bounding rectangle.
|
||||
The VisibleOnScreenNotifier2D's bounding rectangle.
|
||||
</member>
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="screen_entered">
|
||||
<description>
|
||||
Emitted when the VisibilityNotifier2D enters the screen.
|
||||
Emitted when the VisibleOnScreenNotifier2D enters the screen.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="screen_exited">
|
||||
<description>
|
||||
Emitted when the VisibilityNotifier2D exits the screen.
|
||||
Emitted when the VisibleOnScreenNotifier2D exits the screen.
|
||||
</description>
|
||||
</signal>
|
||||
</signals>
|
||||
|
|
@ -1,12 +1,12 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisibilityNotifier3D" inherits="VisualInstance3D" version="4.0">
|
||||
<class name="VisibleOnScreenNotifier3D" inherits="VisualInstance3D" version="4.0">
|
||||
<brief_description>
|
||||
Detects approximately when the node is visible on screen.
|
||||
</brief_description>
|
||||
<description>
|
||||
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].
|
||||
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].
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
|
@ -22,18 +22,18 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="aabb" type="AABB" setter="set_aabb" getter="get_aabb" default="AABB( -1, -1, -1, 2, 2, 2 )">
|
||||
The VisibilityNotifier3D's bounding box.
|
||||
The VisibleOnScreenNotifier3D's bounding box.
|
||||
</member>
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="screen_entered">
|
||||
<description>
|
||||
Emitted when the VisibilityNotifier3D enters the screen.
|
||||
Emitted when the VisibleOnScreenNotifier3D enters the screen.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="screen_exited">
|
||||
<description>
|
||||
Emitted when the VisibilityNotifier3D exits the screen.
|
||||
Emitted when the VisibleOnScreenNotifier3D exits the screen.
|
||||
</description>
|
||||
</signal>
|
||||
</signals>
|
||||
Loading…
Add table
Add a link
Reference in a new issue