Updates docs of AABB and Plane

This commit is contained in:
Haoyu Qiu
2019-12-18 15:09:11 +08:00
parent 4f18c134b9
commit a58deee648
2 changed files with 10 additions and 5 deletions

View File

@ -22,7 +22,7 @@
<argument index="3" name="d" type="float">
</argument>
<description>
Creates a plane from the four parameters [code]a[/code], [code]b[/code], [code]c[/code] and [code]d[/code].
Creates a plane from the four parameters. The three components of the resulting plane's [member normal] are [code]a[/code], [code]b[/code] and [code]c[/code], and the plane has a distance of [code]d[/code] from the origin.
</description>
</method>
<method name="Plane">
@ -35,7 +35,7 @@
<argument index="2" name="v3" type="Vector3">
</argument>
<description>
Creates a plane from three points.
Creates a plane from the three points, given in clockwise order.
</description>
</method>
<method name="Plane">
@ -153,14 +153,19 @@
</methods>
<members>
<member name="d" type="float" setter="" getter="" default="0.0">
Distance from the origin to the plane, in the direction of [member normal].
</member>
<member name="normal" type="Vector3" setter="" getter="" default="Vector3( 0, 0, 0 )">
The normal of the plane. "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing.
</member>
<member name="x" type="float" setter="" getter="" default="0.0">
The [member normal]'s X component.
</member>
<member name="y" type="float" setter="" getter="" default="0.0">
The [member normal]'s Y component.
</member>
<member name="z" type="float" setter="" getter="" default="0.0">
The [member normal]'s Z component.
</member>
</members>
<constants>