godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cross-reference AABB getter methods in the documentation

Browse Source 
This also clarifies that `get_aabb()` returns the AABB in local space.

See https://github.com/godotengine/godot/issues/42095.

(cherry picked from commit 9712f8fd2d)
This commit is contained in:
Hugo Locurcio 2020-09-16 15:53:10 +02:00 committed by Rémi Verschelde
parent ee5971a185
commit 939de03db7
No known key found for this signature in database
GPG Key ID: C3336907360768E1
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/Mesh.xml
View File

@ -44,7 +44,7 @@
<return type="AABB"> <return type="AABB">
</return> </return>
<description> <description>
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]. [b]Note:[/b] This is only implemented for [ArrayMesh] and [PrimitiveMesh].
</description> </description>
</method> </method>

2
doc/classes/MultiMesh.xml
View File

@ -18,7 +18,7 @@
<return type="AABB"> <return type="AABB">
</return> </return>
<description> <description>
Returns the visibility axis-aligned bounding box. Returns the visibility axis-aligned bounding box in local space. See also [method VisualInstance.get_transformed_aabb].
</description> </description>
</method> </method>
<method name="get_instance_color" qualifiers="const"> <method name="get_instance_color" qualifiers="const">

4
doc/classes/VisualInstance.xml
View File

@ -13,7 +13,7 @@
<return type="AABB"> <return type="AABB">
</return> </return>
<description> <description>
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].
</description> </description>
</method> </method>
<method name="get_base" qualifiers="const"> <method name="get_base" qualifiers="const">
@ -44,7 +44,7 @@
</return> </return>
<description> <description>
Returns the transformed [AABB] (also known as the bounding box) for this [VisualInstance]. 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].
</description> </description>
</method> </method>
<method name="set_base"> <method name="set_base">