hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added various docs, mostly mathematical basics

Browse source
This commit is contained in:
Grosskopf 2017-10-22 22:43:35 +02:00
parent fc09e14366
commit 03e2508e45
7 changed files with 85 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

43
doc/classes/Rect3.xml
View file

@ -4,7 +4,7 @@
Axis-Aligned Bounding Box.
</brief_description>
<description>
Rect3 provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests.
Rect3 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
</description>
<tutorials>
</tutorials>
@ -28,7 +28,7 @@
<argument index="0" name="with" type="Rect3">
</argument>
<description>
Return true if this [code]Rect3[/code] completely encloses another one.
Returns [code]true[/code] if this [code]Rect3[/code] completely encloses another one.
</description>
</method>
<method name="expand">
@ -37,14 +37,14 @@
<argument index="0" name="to_point" type="Vector3">
</argument>
<description>
Return this [code]Rect3[/code] expanded to include a given point.
Returns this [code]Rect3[/code] expanded to include a given point.
</description>
</method>
<method name="get_area">
<return type="float">
</return>
<description>
Get the area of the [code]Rect3[/code].
Gets the area of the [code]Rect3[/code].
</description>
</method>
<method name="get_endpoint">
@ -53,49 +53,49 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Get the position of the 8 endpoints of the [code]Rect3[/code] in space.
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>
Return the normalized longest axis of the [code]Rect3[/code].
Returns the normalized longest axis of the [code]Rect3[/code].
</description>
</method>
<method name="get_longest_axis_index">
<return type="int">
</return>
<description>
Return the index of the longest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum).
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>
Return the scalar length of the longest axis of the [code]Rect3[/code].
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>
Return the normalized shortest axis of the [code]Rect3[/code].
Returns the normalized shortest axis of the [code]Rect3[/code].
</description>
</method>
<method name="get_shortest_axis_index">
<return type="int">
</return>
<description>
Return the index of the shortest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum).
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>
Return the scalar length of the shortest axis of the [code]Rect3[/code].
Returns the scalar length of the shortest axis of the [code]Rect3[/code].
</description>
</method>
<method name="get_support">
@ -104,7 +104,7 @@
<argument index="0" name="dir" type="Vector3">
</argument>
<description>
Return the support point in a given direction. This is useful for collision detection algorithms.
Returns the support point in a given direction. This is useful for collision detection algorithms.
</description>
</method>
<method name="grow">
@ -113,21 +113,21 @@
<argument index="0" name="by" type="float">
</argument>
<description>
Return a copy of the [code]Rect3[/code] grown a given amount of units towards all the sides.
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>
Return true if the [code]Rect3[/code] is flat or empty.
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>
Return true if the [code]Rect3[/code] is empty.
Returns [code]true[/code] if the [code]Rect3[/code] is empty.
</description>
</method>
<method name="has_point">
@ -136,7 +136,7 @@
<argument index="0" name="point" type="Vector3">
</argument>
<description>
Return true if the [code]Rect3[/code] contains a point.
Returns [code]true[/code] if the [code]Rect3[/code] contains a point.
</description>
</method>
<method name="intersection">
@ -145,7 +145,7 @@
<argument index="0" name="with" type="Rect3">
</argument>
<description>
Return the intersection between two [code]Rect3[/code]. An empty Rect3 (size 0,0,0) is returned on failure.
Returns the intersection between two [code]Rect3[/code]. An empty Rect3 (size 0,0,0) is returned on failure.
</description>
</method>
<method name="intersects">
@ -154,7 +154,7 @@
<argument index="0" name="with" type="Rect3">
</argument>
<description>
Return true if the [code]Rect3[/code] overlaps with another.
Returns [code]true[/code] if the [code]Rect3[/code] overlaps with another.
</description>
</method>
<method name="intersects_plane">
@ -163,7 +163,7 @@
<argument index="0" name="plane" type="Plane">
</argument>
<description>
Return true if the [code]Rect3[/code] is at both sides of a plane.
Returns [code]true[/code] if the [code]Rect3[/code] is on both sides of a plane.
</description>
</method>
<method name="intersects_segment">
@ -174,7 +174,7 @@
<argument index="1" name="to" type="Vector3">
</argument>
<description>
Return true if the [code]Rect3[/code] intersects the line segment between from and to
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">
@ -183,7 +183,7 @@
<argument index="0" name="with" type="Rect3">
</argument>
<description>
Combine this [code]Rect3[/code] with another, a larger one is returned that contains both.
Returns a larger Rect3 that contains this Rect3 and [code]with[/code].
</description>
</method>
</methods>
@ -192,6 +192,7 @@
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.