summaryrefslogtreecommitdiff
path: root/doc/classes/Plane.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Plane.xml')
-rw-r--r--doc/classes/Plane.xml106
1 files changed, 55 insertions, 51 deletions
diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml
index f7a68e6a24..a20607d0a7 100644
--- a/doc/classes/Plane.xml
+++ b/doc/classes/Plane.xml
@@ -9,21 +9,21 @@
<tutorials>
<link title="Math documentation index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
</tutorials>
- <methods>
- <method name="Plane" qualifiers="constructor">
+ <constructors>
+ <constructor name="Plane">
<return type="Plane" />
<description>
Constructs a default-initialized [Plane] with all components set to [code]0[/code].
</description>
- </method>
- <method name="Plane" qualifiers="constructor">
+ </constructor>
+ <constructor name="Plane">
<return type="Plane" />
<argument index="0" name="from" type="Plane" />
<description>
Constructs a [Plane] as a copy of the given [Plane].
</description>
- </method>
- <method name="Plane" qualifiers="constructor">
+ </constructor>
+ <constructor name="Plane">
<return type="Plane" />
<argument index="0" name="a" type="float" />
<argument index="1" name="b" type="float" />
@@ -32,31 +32,31 @@
<description>
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" qualifiers="constructor">
+ </constructor>
+ <constructor name="Plane">
<return type="Plane" />
<argument index="0" name="normal" type="Vector3" />
- <argument index="1" name="point" type="Vector3" />
<description>
- Creates a plane from the normal vector and a point in the plane.
+ Creates a plane from the normal vector. The plane will intersect the origin.
</description>
- </method>
- <method name="Plane" qualifiers="constructor">
+ </constructor>
+ <constructor name="Plane">
<return type="Plane" />
<argument index="0" name="normal" type="Vector3" />
<argument index="1" name="d" type="float" />
<description>
- Creates a plane from the normal vector and the plane's distance to the origin.
+ Creates a plane from the normal vector and the plane's distance from the origin.
</description>
- </method>
- <method name="Plane" qualifiers="constructor">
+ </constructor>
+ <constructor name="Plane">
<return type="Plane" />
<argument index="0" name="normal" type="Vector3" />
+ <argument index="1" name="point" type="Vector3" />
<description>
- Creates a plane from the normal vector. The plane will intersect the origin.
+ Creates a plane from the normal vector and a point on the plane.
</description>
- </method>
- <method name="Plane" qualifiers="constructor">
+ </constructor>
+ <constructor name="Plane">
<return type="Plane" />
<argument index="0" name="point1" type="Vector3" />
<argument index="1" name="point2" type="Vector3" />
@@ -64,7 +64,9 @@
<description>
Creates a plane from the three points, given in clockwise order.
</description>
- </method>
+ </constructor>
+ </constructors>
+ <methods>
<method name="center" qualifiers="const">
<return type="Vector3" />
<description>
@@ -130,38 +132,6 @@
Returns a copy of the plane, normalized.
</description>
</method>
- <method name="operator !=" qualifiers="operator">
- <return type="bool" />
- <description>
- </description>
- </method>
- <method name="operator !=" qualifiers="operator">
- <return type="bool" />
- <argument index="0" name="right" type="Plane" />
- <description>
- </description>
- </method>
- <method name="operator ==" qualifiers="operator">
- <return type="bool" />
- <description>
- </description>
- </method>
- <method name="operator ==" qualifiers="operator">
- <return type="bool" />
- <argument index="0" name="right" type="Plane" />
- <description>
- </description>
- </method>
- <method name="operator unary+" qualifiers="operator">
- <return type="Plane" />
- <description>
- </description>
- </method>
- <method name="operator unary-" qualifiers="operator">
- <return type="Plane" />
- <description>
- </description>
- </method>
<method name="project" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="point" type="Vector3" />
@@ -200,4 +170,38 @@
A plane that extends in the X and Y axes (normal vector points +Z).
</constant>
</constants>
+ <operators>
+ <operator name="operator !=">
+ <return type="bool" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator !=">
+ <return type="bool" />
+ <argument index="0" name="right" type="Plane" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator ==">
+ <return type="bool" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator ==">
+ <return type="bool" />
+ <argument index="0" name="right" type="Plane" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator unary+">
+ <return type="Plane" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator unary-">
+ <return type="Plane" />
+ <description>
+ </description>
+ </operator>
+ </operators>
</class>