From d28763a4c1792dc00fde3d151eaea54f9cf2b8a9 Mon Sep 17 00:00:00 2001 From: Ferenc Arn Date: Thu, 16 Nov 2017 21:09:00 -0500 Subject: Rename Rect3 to AABB. Fixes #12973. --- doc/classes/@GlobalScope.xml | 4 +- doc/classes/AABB.xml | 203 +++++++++++++++++++++++++++++++++++++ doc/classes/ArrayMesh.xml | 4 +- doc/classes/EditorSpatialGizmo.xml | 2 +- doc/classes/GIProbeData.xml | 6 +- doc/classes/MultiMesh.xml | 6 +- doc/classes/Nil.xml | 2 +- doc/classes/Particles.xml | 8 +- doc/classes/Rect3.xml | 203 ------------------------------------- doc/classes/String.xml | 4 +- doc/classes/VisibilityNotifier.xml | 6 +- doc/classes/VisualInstance.xml | 4 +- doc/classes/VisualServer.xml | 6 +- 13 files changed, 229 insertions(+), 229 deletions(-) create mode 100644 doc/classes/AABB.xml delete mode 100644 doc/classes/Rect3.xml (limited to 'doc') diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 258b06f320..31a0d3ccef 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1332,8 +1332,8 @@ Variable is of type [Quat]. - - Variable is of type [Rect3]. + + Variable is of type [AABB]. Variable is of type [Basis]. diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml new file mode 100644 index 0000000000..494dcb8fce --- /dev/null +++ b/doc/classes/AABB.xml @@ -0,0 +1,203 @@ + + + + Axis-Aligned Bounding Box. + + + AABB consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + + + + + + + + + + + + + + + Optional constructor, accepts position and size. + + + + + + + + + Returns [code]true[/code] if this [code]AABB[/code] completely encloses another one. + + + + + + + + + Returns this [code]AABB[/code] expanded to include a given point. + + + + + + + Gets the area of the [code]AABB[/code]. + + + + + + + + + Gets the position of the 8 endpoints of the [code]AABB[/code] in space. + + + + + + + Returns the normalized longest axis of the [code]AABB[/code]. + + + + + + + Returns the index of the longest axis of the [code]AABB[/code] (according to [Vector3]::AXIS* enum). + + + + + + + Returns the scalar length of the longest axis of the [code]AABB[/code]. + + + + + + + Returns the normalized shortest axis of the [code]AABB[/code]. + + + + + + + Returns the index of the shortest axis of the [code]AABB[/code] (according to [Vector3]::AXIS* enum). + + + + + + + Returns the scalar length of the shortest axis of the [code]AABB[/code]. + + + + + + + + + Returns the support point in a given direction. This is useful for collision detection algorithms. + + + + + + + + + Returns a copy of the [code]AABB[/code] grown a given amount of units towards all the sides. + + + + + + + Returns [code]true[/code] if the [code]AABB[/code] is flat or empty. + + + + + + + Returns [code]true[/code] if the [code]AABB[/code] is empty. + + + + + + + + + Returns [code]true[/code] if the [code]AABB[/code] contains a point. + + + + + + + + + Returns the intersection between two [code]AABB[/code]. An empty AABB (size 0,0,0) is returned on failure. + + + + + + + + + Returns [code]true[/code] if the [code]AABB[/code] overlaps with another. + + + + + + + + + Returns [code]true[/code] if the [code]AABB[/code] is on both sides of a plane. + + + + + + + + + + + Returns [code]true[/code] if the [code]AABB[/code] intersects the line segment between [code]from[/code] and [code]to[/code]. + + + + + + + + + Returns a larger AABB that contains this AABB and [code]with[/code]. + + + + + + Ending corner. + + + Beginning corner. + + + Size from position to end. + + + + + diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 10456f805d..6c9b191371 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -66,7 +66,7 @@ - + @@ -95,7 +95,7 @@ - + diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index e111eec3b9..758024c99b 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -24,7 +24,7 @@ - + Add collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw]. diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index 3777eba6af..5d118be776 100644 --- a/doc/classes/GIProbeData.xml +++ b/doc/classes/GIProbeData.xml @@ -16,7 +16,7 @@ - + @@ -86,7 +86,7 @@ - + @@ -167,7 +167,7 @@ - + diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 73384c27e4..b6a89d09f4 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -7,7 +7,7 @@ MultiMesh provides low level mesh instancing. If the amount of [Mesh] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance] nodes may affect performance by using too much CPU or video memory. For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). - Since instances may have any behavior, the Rect3 used for visibility must be provided by the user. + Since instances may have any behavior, the AABB used for visibility must be provided by the user. @@ -15,10 +15,10 @@ - + - Return the visibility Rect3. + Return the visibility AABB. diff --git a/doc/classes/Nil.xml b/doc/classes/Nil.xml index 1fccdc0148..a4bd60d53e 100644 --- a/doc/classes/Nil.xml +++ b/doc/classes/Nil.xml @@ -100,7 +100,7 @@ - + diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index 4e070f67fd..9a9279b0a7 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -13,7 +13,7 @@ - + @@ -105,7 +105,7 @@ - + @@ -247,7 +247,7 @@ - + @@ -300,7 +300,7 @@ Speed scaling ratio. Default value: [code]1[/code]. - + diff --git a/doc/classes/Rect3.xml b/doc/classes/Rect3.xml deleted file mode 100644 index 88be5fa419..0000000000 --- a/doc/classes/Rect3.xml +++ /dev/null @@ -1,203 +0,0 @@ - - - - Axis-Aligned Bounding Box. - - - Rect3 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. - - - - - - - - - - - - - - - Optional constructor, accepts position and size. - - - - - - - - - Returns [code]true[/code] if this [code]Rect3[/code] completely encloses another one. - - - - - - - - - Returns this [code]Rect3[/code] expanded to include a given point. - - - - - - - Gets the area of the [code]Rect3[/code]. - - - - - - - - - Gets the position of the 8 endpoints of the [code]Rect3[/code] in space. - - - - - - - Returns the normalized longest axis of the [code]Rect3[/code]. - - - - - - - Returns the index of the longest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum). - - - - - - - Returns the scalar length of the longest axis of the [code]Rect3[/code]. - - - - - - - Returns the normalized shortest axis of the [code]Rect3[/code]. - - - - - - - Returns the index of the shortest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum). - - - - - - - Returns the scalar length of the shortest axis of the [code]Rect3[/code]. - - - - - - - - - Returns the support point in a given direction. This is useful for collision detection algorithms. - - - - - - - - - Returns a copy of the [code]Rect3[/code] grown a given amount of units towards all the sides. - - - - - - - Returns [code]true[/code] if the [code]Rect3[/code] is flat or empty. - - - - - - - Returns [code]true[/code] if the [code]Rect3[/code] is empty. - - - - - - - - - Returns [code]true[/code] if the [code]Rect3[/code] contains a point. - - - - - - - - - Returns the intersection between two [code]Rect3[/code]. An empty Rect3 (size 0,0,0) is returned on failure. - - - - - - - - - Returns [code]true[/code] if the [code]Rect3[/code] overlaps with another. - - - - - - - - - Returns [code]true[/code] if the [code]Rect3[/code] is on both sides of a plane. - - - - - - - - - - - Returns [code]true[/code] if the [code]Rect3[/code] intersects the line segment between [code]from[/code] and [code]to[/code]. - - - - - - - - - Returns a larger Rect3 that contains this Rect3 and [code]with[/code]. - - - - - - Ending corner. - - - Beginning corner. - - - Size from position to end. - - - - - diff --git a/doc/classes/String.xml b/doc/classes/String.xml index ecf9e54ee7..60c5e75dec 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -95,10 +95,10 @@ - + - Constructs a new String from the given [Rect3]. + Constructs a new String from the given [AABB]. diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index 1dfa60a5ac..90f1974697 100644 --- a/doc/classes/VisibilityNotifier.xml +++ b/doc/classes/VisibilityNotifier.xml @@ -12,7 +12,7 @@ - + Returns the bounding box of the VisibilityNotifier. @@ -28,7 +28,7 @@ - + Set the visibility bounding box of the VisibilityNotifier. @@ -36,7 +36,7 @@ - + The VisibilityNotifier's bounding box. diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index be2d38bf9f..7108eb13c5 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -10,7 +10,7 @@ - + @@ -22,7 +22,7 @@ - + diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 1030e4ecc0..d716d99e5d 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -1035,7 +1035,7 @@ - + @@ -1085,13 +1085,13 @@ - + - + -- cgit v1.2.3