asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated outdated or missing Plane class documentation

Browse source
This commit is contained in:
Simon Wenner 2015-04-20 23:31:53 +02:00
parent 03fd8a80c1
commit 8156db1623
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/base/classes.xml
View file

@ -21551,6 +21551,7 @@
<return type="Vector3">
</return>
<description>
Returns the center of the plane.
</description>
</method>
<method name="distance_to" >
@ -21559,12 +21560,14 @@
<argument index="0" name="point" type="Vector3">
</argument>
<description>
Returns the shortest distance from the plane to the position "point".
</description>
</method>
<method name="get_any_point" >
<return type="Vector3">
</return>
<description>
Returns a point on the plane.
</description>
</method>
<method name="has_point" >
@ -21575,7 +21578,7 @@
<argument index="1" name="epsilon" type="float" default="0.00001">
</argument>
<description>
Returns true if "p" is inside the plane (by a very minimum treshold).
Returns true if "point" is inside the plane (by a very minimum treshold).
</description>
</method>
<method name="intersect_3" >
@ -21586,7 +21589,7 @@
<argument index="1" name="c" type="Plane">
</argument>
<description>
Returns true if this plane intersects with planes "a" and "b". The resulting intersectin is placed in "r".
Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned.
</description>
</method>
<method name="intersects_ray" >
@ -21597,7 +21600,7 @@
<argument index="1" name="dir" type="Vector3">
</argument>
<description>
Returns true if ray consiting of position "p" and direction normal "d" intersects this plane. If true, the result is placed in "r".
Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned.
</description>
</method>
<method name="intersects_segment" >
@ -21608,7 +21611,7 @@
<argument index="1" name="end" type="Vector3">
</argument>
<description>
Returns true if segment from position "sa" to position "sb" intersects this plane. If true, the result is placed in "r".
Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned.
</description>
</method>
<method name="is_point_over" >
@ -21617,7 +21620,7 @@
<argument index="0" name="point" type="Vector3">
</argument>
<description>
Returns true if "p" is located above the plane.
Returns true if "point" is located above the plane.
</description>
</method>
<method name="normalized" >
@ -21646,6 +21649,7 @@
<argument index="3" name="d" type="float">
</argument>
<description>
Creates a plane from the three parameters "a", "b", "c" and "d".
</description>
</method>
<method name="Plane" >
@ -21656,6 +21660,7 @@
<argument index="2" name="v3" type="Vector3">
</argument>
<description>
Creates a plane from three points.
</description>
</method>
<method name="Plane" >
@ -21664,6 +21669,7 @@
<argument index="1" name="d" type="float">
</argument>
<description>
Creates a plane from the normal and the plane's distance to the origin.
</description>
</method>
</methods>