doc: Sync classref with current source
And move GLTF docs to its module folder.
This commit is contained in:
Rémi Verschelde
parent
2fd445cc18
commit
4ca1e73ff9
48 changed files with 535 additions and 395 deletions
|
|
@ -41,14 +41,14 @@
|
|||
Constructs an [AABB] from a position and size.
|
||||
</description>
|
||||
</method>
|
||||
<method name="abs">
|
||||
<method name="abs" qualifiers="const">
|
||||
<return type="AABB">
|
||||
</return>
|
||||
<description>
|
||||
Returns an AABB with equivalent position and size, modified so that the most-negative corner is the origin and the size is positive.
|
||||
</description>
|
||||
</method>
|
||||
<method name="encloses">
|
||||
<method name="encloses" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="with" type="AABB">
|
||||
|
|
@ -57,7 +57,7 @@
|
|||
Returns [code]true[/code] if this [AABB] completely encloses another one.
|
||||
</description>
|
||||
</method>
|
||||
<method name="expand">
|
||||
<method name="expand" qualifiers="const">
|
||||
<return type="AABB">
|
||||
</return>
|
||||
<argument index="0" name="to_point" type="Vector3">
|
||||
|
|
@ -66,14 +66,14 @@
|
|||
Returns this [AABB] expanded to include a given point.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_area">
|
||||
<method name="get_area" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Returns the volume of the [AABB].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_endpoint">
|
||||
<method name="get_endpoint" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
|
|
@ -82,49 +82,49 @@
|
|||
Gets the position of the 8 endpoints of the [AABB] in space.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_longest_axis">
|
||||
<method name="get_longest_axis" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<description>
|
||||
Returns the normalized longest axis of the [AABB].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_longest_axis_index">
|
||||
<method name="get_longest_axis_index" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
Returns the index of the longest axis of the [AABB] (according to [Vector3]'s [code]AXIS_*[/code] constants).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_longest_axis_size">
|
||||
<method name="get_longest_axis_size" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Returns the scalar length of the longest axis of the [AABB].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_shortest_axis">
|
||||
<method name="get_shortest_axis" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<description>
|
||||
Returns the normalized shortest axis of the [AABB].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_shortest_axis_index">
|
||||
<method name="get_shortest_axis_index" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
Returns the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_shortest_axis_size">
|
||||
<method name="get_shortest_axis_size" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Returns the scalar length of the shortest axis of the [AABB].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_support">
|
||||
<method name="get_support" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="dir" type="Vector3">
|
||||
|
|
@ -133,7 +133,7 @@
|
|||
Returns the support point in a given direction. This is useful for collision detection algorithms.
|
||||
</description>
|
||||
</method>
|
||||
<method name="grow">
|
||||
<method name="grow" qualifiers="const">
|
||||
<return type="AABB">
|
||||
</return>
|
||||
<argument index="0" name="by" type="float">
|
||||
|
|
@ -142,21 +142,21 @@
|
|||
Returns a copy of the [AABB] grown a given amount of units towards all the sides.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_no_area">
|
||||
<method name="has_no_area" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Returns [code]true[/code] if the [AABB] is flat or empty.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_no_surface">
|
||||
<method name="has_no_surface" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Returns [code]true[/code] if the [AABB] is empty.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_point">
|
||||
<method name="has_point" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="point" type="Vector3">
|
||||
|
|
@ -165,7 +165,7 @@
|
|||
Returns [code]true[/code] if the [AABB] contains a point.
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersection">
|
||||
<method name="intersection" qualifiers="const">
|
||||
<return type="AABB">
|
||||
</return>
|
||||
<argument index="0" name="with" type="AABB">
|
||||
|
|
@ -174,7 +174,7 @@
|
|||
Returns the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure.
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersects">
|
||||
<method name="intersects" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="with" type="AABB">
|
||||
|
|
@ -183,7 +183,7 @@
|
|||
Returns [code]true[/code] if the [AABB] overlaps with another.
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersects_plane">
|
||||
<method name="intersects_plane" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="plane" type="Plane">
|
||||
|
|
@ -192,7 +192,7 @@
|
|||
Returns [code]true[/code] if the [AABB] is on both sides of a plane.
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersects_ray">
|
||||
<method name="intersects_ray" qualifiers="const">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="from" type="Vector3">
|
||||
|
|
@ -202,7 +202,7 @@
|
|||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersects_segment">
|
||||
<method name="intersects_segment" qualifiers="const">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="from" type="Vector3">
|
||||
|
|
@ -213,7 +213,7 @@
|
|||
Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_equal_approx">
|
||||
<method name="is_equal_approx" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="aabb" type="AABB">
|
||||
|
|
@ -222,7 +222,7 @@
|
|||
Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GlobalScope.is_equal_approx] on each component.
|
||||
</description>
|
||||
</method>
|
||||
<method name="merge">
|
||||
<method name="merge" qualifiers="const">
|
||||
<return type="AABB">
|
||||
</return>
|
||||
<argument index="0" name="with" type="AABB">
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue