From 939de03db7932856fdddd489593eaa73697d6a0d Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 16 Sep 2020 15:53:10 +0200 Subject: [PATCH] Cross-reference AABB getter methods in the documentation This also clarifies that `get_aabb()` returns the AABB in local space. See https://github.com/godotengine/godot/issues/42095. (cherry picked from commit 9712f8fd2da24d3f97b391c0a694215fd4f181c3) --- doc/classes/Mesh.xml | 2 +- doc/classes/MultiMesh.xml | 2 +- doc/classes/VisualInstance.xml | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index b1407875d0b..f07e98c3695 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -44,7 +44,7 @@ - Returns the smallest [AABB] enclosing this mesh. Not affected by [code]custom_aabb[/code]. + Returns the smallest [AABB] enclosing this mesh in local space. Not affected by [code]custom_aabb[/code]. See also [method VisualInstance.get_transformed_aabb]. [b]Note:[/b] This is only implemented for [ArrayMesh] and [PrimitiveMesh]. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 74e94d49838..c9a441eed3f 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -18,7 +18,7 @@ - Returns the visibility axis-aligned bounding box. + Returns the visibility axis-aligned bounding box in local space. See also [method VisualInstance.get_transformed_aabb]. diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index ce78f79ca88..2436008ef5c 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -13,7 +13,7 @@ - Returns the [AABB] (also known as the bounding box) for this [VisualInstance]. + Returns the [AABB] (also known as the bounding box) for this [VisualInstance]. See also [method get_transformed_aabb]. @@ -44,7 +44,7 @@ Returns the transformed [AABB] (also known as the bounding box) for this [VisualInstance]. - Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]'s [Transform]. + Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]'s [Transform]. See also [method get_aabb].