aboutsummaryrefslogtreecommitdiff
path: root/doc/classes/Rect3.xml
diff options
context:
space:
mode:
authorFerenc Arn2017-11-16 21:09:00 -0500
committerFerenc Arn2017-11-17 11:01:41 -0500
commitd28763a4c1792dc00fde3d151eaea54f9cf2b8a9 (patch)
tree7abd311b6e672829bd751fbf4d9135b60f2f9913 /doc/classes/Rect3.xml
parentb44cb4e3b9b573a3cbbd6f71aff81e6c3465d84b (diff)
downloadgodot-d28763a4c1792dc00fde3d151eaea54f9cf2b8a9.tar.gz
godot-d28763a4c1792dc00fde3d151eaea54f9cf2b8a9.tar.zst
godot-d28763a4c1792dc00fde3d151eaea54f9cf2b8a9.zip
Rename Rect3 to AABB.
Fixes #12973.
Diffstat (limited to 'doc/classes/Rect3.xml')
-rw-r--r--doc/classes/Rect3.xml203
1 files changed, 0 insertions, 203 deletions
diff --git a/doc/classes/Rect3.xml b/doc/classes/Rect3.xml
deleted file mode 100644
index 88be5fa41..000000000
--- a/doc/classes/Rect3.xml
+++ /dev/null
@@ -1,203 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="Rect3" category="Built-In Types" version="3.0-alpha">
- <brief_description>
- Axis-Aligned Bounding Box.
- </brief_description>
- <description>
- Rect3 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
- </description>
- <tutorials>
- </tutorials>
- <demos>
- </demos>
- <methods>
- <method name="Rect3">
- <return type="Rect3">
- </return>
- <argument index="0" name="position" type="Vector3">
- </argument>
- <argument index="1" name="size" type="Vector3">
- </argument>
- <description>
- Optional constructor, accepts position and size.
- </description>
- </method>
- <method name="encloses">
- <return type="bool">
- </return>
- <argument index="0" name="with" type="Rect3">
- </argument>
- <description>
- Returns [code]true[/code] if this [code]Rect3[/code] completely encloses another one.
- </description>
- </method>
- <method name="expand">
- <return type="Rect3">
- </return>
- <argument index="0" name="to_point" type="Vector3">
- </argument>
- <description>
- Returns this [code]Rect3[/code] expanded to include a given point.
- </description>
- </method>
- <method name="get_area">
- <return type="float">
- </return>
- <description>
- Gets the area of the [code]Rect3[/code].
- </description>
- </method>
- <method name="get_endpoint">
- <return type="Vector3">
- </return>
- <argument index="0" name="idx" type="int">
- </argument>
- <description>
- Gets the position of the 8 endpoints of the [code]Rect3[/code] in space.
- </description>
- </method>
- <method name="get_longest_axis">
- <return type="Vector3">
- </return>
- <description>
- Returns the normalized longest axis of the [code]Rect3[/code].
- </description>
- </method>
- <method name="get_longest_axis_index">
- <return type="int">
- </return>
- <description>
- Returns the index of the longest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum).
- </description>
- </method>
- <method name="get_longest_axis_size">
- <return type="float">
- </return>
- <description>
- Returns the scalar length of the longest axis of the [code]Rect3[/code].
- </description>
- </method>
- <method name="get_shortest_axis">
- <return type="Vector3">
- </return>
- <description>
- Returns the normalized shortest axis of the [code]Rect3[/code].
- </description>
- </method>
- <method name="get_shortest_axis_index">
- <return type="int">
- </return>
- <description>
- Returns the index of the shortest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum).
- </description>
- </method>
- <method name="get_shortest_axis_size">
- <return type="float">
- </return>
- <description>
- Returns the scalar length of the shortest axis of the [code]Rect3[/code].
- </description>
- </method>
- <method name="get_support">
- <return type="Vector3">
- </return>
- <argument index="0" name="dir" type="Vector3">
- </argument>
- <description>
- Returns the support point in a given direction. This is useful for collision detection algorithms.
- </description>
- </method>
- <method name="grow">
- <return type="Rect3">
- </return>
- <argument index="0" name="by" type="float">
- </argument>
- <description>
- Returns a copy of the [code]Rect3[/code] grown a given amount of units towards all the sides.
- </description>
- </method>
- <method name="has_no_area">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the [code]Rect3[/code] is flat or empty.
- </description>
- </method>
- <method name="has_no_surface">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the [code]Rect3[/code] is empty.
- </description>
- </method>
- <method name="has_point">
- <return type="bool">
- </return>
- <argument index="0" name="point" type="Vector3">
- </argument>
- <description>
- Returns [code]true[/code] if the [code]Rect3[/code] contains a point.
- </description>
- </method>
- <method name="intersection">
- <return type="Rect3">
- </return>
- <argument index="0" name="with" type="Rect3">
- </argument>
- <description>
- Returns the intersection between two [code]Rect3[/code]. An empty Rect3 (size 0,0,0) is returned on failure.
- </description>
- </method>
- <method name="intersects">
- <return type="bool">
- </return>
- <argument index="0" name="with" type="Rect3">
- </argument>
- <description>
- Returns [code]true[/code] if the [code]Rect3[/code] overlaps with another.
- </description>
- </method>
- <method name="intersects_plane">
- <return type="bool">
- </return>
- <argument index="0" name="plane" type="Plane">
- </argument>
- <description>
- Returns [code]true[/code] if the [code]Rect3[/code] is on both sides of a plane.
- </description>
- </method>
- <method name="intersects_segment">
- <return type="bool">
- </return>
- <argument index="0" name="from" type="Vector3">
- </argument>
- <argument index="1" name="to" type="Vector3">
- </argument>
- <description>
- Returns [code]true[/code] if the [code]Rect3[/code] intersects the line segment between [code]from[/code] and [code]to[/code].
- </description>
- </method>
- <method name="merge">
- <return type="Rect3">
- </return>
- <argument index="0" name="with" type="Rect3">
- </argument>
- <description>
- Returns a larger Rect3 that contains this Rect3 and [code]with[/code].
- </description>
- </method>
- </methods>
- <members>
- <member name="end" type="Vector3" setter="" getter="">
- Ending corner.
- </member>
- <member name="position" type="Vector3" setter="" getter="">
- Beginning corner.
- </member>
- <member name="size" type="Vector3" setter="" getter="">
- Size from position to end.
- </member>
- </members>
- <constants>
- </constants>
-</class>