summaryrefslogtreecommitdiff
path: root/doc/classes/Geometry.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2020-02-18 13:59:24 +0100
committerRémi Verschelde <rverschelde@gmail.com>2020-02-18 14:02:02 +0100
commit213a85521dcac9c01e1e4746733e606b610c0db4 (patch)
tree07da9583c7c551cf23e433c3f665adf5a35b0ca6 /doc/classes/Geometry.xml
parentb4d1882dc37bdf769994d41712d26a9a7e7145ef (diff)
doc: Sync classref with current source
Handle removal of Pool*Array types and other recent changes.
Diffstat (limited to 'doc/classes/Geometry.xml')
-rw-r--r--doc/classes/Geometry.xml74
1 files changed, 37 insertions, 37 deletions
diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml
index 739c860b28..9d4e0d0388 100644
--- a/doc/classes/Geometry.xml
+++ b/doc/classes/Geometry.xml
@@ -51,9 +51,9 @@
</description>
</method>
<method name="clip_polygon">
- <return type="PoolVector3Array">
+ <return type="PackedVector3Array">
</return>
- <argument index="0" name="points" type="PoolVector3Array">
+ <argument index="0" name="points" type="PackedVector3Array">
</argument>
<argument index="1" name="plane" type="Plane">
</argument>
@@ -64,9 +64,9 @@
<method name="clip_polygons_2d">
<return type="Array">
</return>
- <argument index="0" name="polygon_a" type="PoolVector2Array">
+ <argument index="0" name="polygon_a" type="PackedVector2Array">
</argument>
- <argument index="1" name="polygon_b" type="PoolVector2Array">
+ <argument index="1" name="polygon_b" type="PackedVector2Array">
</argument>
<description>
Clips [code]polygon_a[/code] against [code]polygon_b[/code] and returns an array of clipped polygons. This performs [constant OPERATION_DIFFERENCE] between polygons. Returns an empty array if [code]polygon_b[/code] completely overlaps [code]polygon_a[/code].
@@ -76,18 +76,18 @@
<method name="clip_polyline_with_polygon_2d">
<return type="Array">
</return>
- <argument index="0" name="polyline" type="PoolVector2Array">
+ <argument index="0" name="polyline" type="PackedVector2Array">
</argument>
- <argument index="1" name="polygon" type="PoolVector2Array">
+ <argument index="1" name="polygon" type="PackedVector2Array">
</argument>
<description>
Clips [code]polyline[/code] against [code]polygon[/code] and returns an array of clipped polylines. This performs [constant OPERATION_DIFFERENCE] between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape.
</description>
</method>
<method name="convex_hull_2d">
- <return type="PoolVector2Array">
+ <return type="PackedVector2Array">
</return>
- <argument index="0" name="points" type="PoolVector2Array">
+ <argument index="0" name="points" type="PackedVector2Array">
</argument>
<description>
Given an array of [Vector2]s, returns the convex hull as a list of points in counterclockwise order. The last point is the same as the first one.
@@ -96,9 +96,9 @@
<method name="exclude_polygons_2d">
<return type="Array">
</return>
- <argument index="0" name="polygon_a" type="PoolVector2Array">
+ <argument index="0" name="polygon_a" type="PackedVector2Array">
</argument>
- <argument index="1" name="polygon_b" type="PoolVector2Array">
+ <argument index="1" name="polygon_b" type="PackedVector2Array">
</argument>
<description>
Mutually excludes common area defined by intersection of [code]polygon_a[/code] and [code]polygon_b[/code] (see [method intersect_polygons_2d]) and returns an array of excluded polygons. This performs [constant OPERATION_XOR] between polygons. In other words, returns all but common area between polygons.
@@ -158,7 +158,7 @@
</description>
</method>
<method name="get_closest_points_between_segments">
- <return type="PoolVector3Array">
+ <return type="PackedVector3Array">
</return>
<argument index="0" name="p1" type="Vector3">
</argument>
@@ -169,11 +169,11 @@
<argument index="3" name="q2" type="Vector3">
</argument>
<description>
- Given the two 3D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PoolVector3Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]).
+ Given the two 3D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PackedVector3Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]).
</description>
</method>
<method name="get_closest_points_between_segments_2d">
- <return type="PoolVector2Array">
+ <return type="PackedVector2Array">
</return>
<argument index="0" name="p1" type="Vector2">
</argument>
@@ -184,7 +184,7 @@
<argument index="3" name="q2" type="Vector2">
</argument>
<description>
- Given the two 2D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PoolVector2Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]).
+ Given the two 2D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PackedVector2Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]).
</description>
</method>
<method name="get_uv84_normal_bit">
@@ -199,9 +199,9 @@
<method name="intersect_polygons_2d">
<return type="Array">
</return>
- <argument index="0" name="polygon_a" type="PoolVector2Array">
+ <argument index="0" name="polygon_a" type="PackedVector2Array">
</argument>
- <argument index="1" name="polygon_b" type="PoolVector2Array">
+ <argument index="1" name="polygon_b" type="PackedVector2Array">
</argument>
<description>
Intersects [code]polygon_a[/code] with [code]polygon_b[/code] and returns an array of intersected polygons. This performs [constant OPERATION_INTERSECTION] between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs.
@@ -211,9 +211,9 @@
<method name="intersect_polyline_with_polygon_2d">
<return type="Array">
</return>
- <argument index="0" name="polyline" type="PoolVector2Array">
+ <argument index="0" name="polyline" type="PackedVector2Array">
</argument>
- <argument index="1" name="polygon" type="PoolVector2Array">
+ <argument index="1" name="polygon" type="PackedVector2Array">
</argument>
<description>
Intersects [code]polyline[/code] with [code]polygon[/code] and returns an array of intersected polylines. This performs [constant OPERATION_INTERSECTION] between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape.
@@ -237,7 +237,7 @@
</return>
<argument index="0" name="point" type="Vector2">
</argument>
- <argument index="1" name="polygon" type="PoolVector2Array">
+ <argument index="1" name="polygon" type="PackedVector2Array">
</argument>
<description>
Returns [code]true[/code] if [code]point[/code] is inside [code]polygon[/code] or if it's located exactly [i]on[/i] polygon's boundary, otherwise returns [code]false[/code].
@@ -246,7 +246,7 @@
<method name="is_polygon_clockwise">
<return type="bool">
</return>
- <argument index="0" name="polygon" type="PoolVector2Array">
+ <argument index="0" name="polygon" type="PackedVector2Array">
</argument>
<description>
Returns [code]true[/code] if [code]polygon[/code]'s vertices are ordered in clockwise order, otherwise returns [code]false[/code].
@@ -271,7 +271,7 @@
<method name="make_atlas">
<return type="Dictionary">
</return>
- <argument index="0" name="sizes" type="PoolVector2Array">
+ <argument index="0" name="sizes" type="PackedVector2Array">
</argument>
<description>
Given an array of [Vector2]s representing tiles, builds an atlas. The returned dictionary has two keys: [code]points[/code] is a vector of [Vector2] that specifies the positions of each tile, [code]size[/code] contains the overall size of the whole atlas as [Vector2].
@@ -280,9 +280,9 @@
<method name="merge_polygons_2d">
<return type="Array">
</return>
- <argument index="0" name="polygon_a" type="PoolVector2Array">
+ <argument index="0" name="polygon_a" type="PackedVector2Array">
</argument>
- <argument index="1" name="polygon_b" type="PoolVector2Array">
+ <argument index="1" name="polygon_b" type="PackedVector2Array">
</argument>
<description>
Merges (combines) [code]polygon_a[/code] and [code]polygon_b[/code] and returns an array of merged polygons. This performs [constant OPERATION_UNION] between polygons.
@@ -292,7 +292,7 @@
<method name="offset_polygon_2d">
<return type="Array">
</return>
- <argument index="0" name="polygon" type="PoolVector2Array">
+ <argument index="0" name="polygon" type="PackedVector2Array">
</argument>
<argument index="1" name="delta" type="float">
</argument>
@@ -307,7 +307,7 @@
<method name="offset_polyline_2d">
<return type="Array">
</return>
- <argument index="0" name="polyline" type="PoolVector2Array">
+ <argument index="0" name="polyline" type="PackedVector2Array">
</argument>
<argument index="1" name="delta" type="float">
</argument>
@@ -370,7 +370,7 @@
</description>
</method>
<method name="segment_intersects_convex">
- <return type="PoolVector3Array">
+ <return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
@@ -379,11 +379,11 @@
<argument index="2" name="planes" type="Array">
</argument>
<description>
- Given a convex hull defined though the [Plane]s in the array [code]planes[/code], tests if the segment ([code]from[/code], [code]to[/code]) intersects with that hull. If an intersection is found, returns a [PoolVector3Array] containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty.
+ Given a convex hull defined though the [Plane]s in the array [code]planes[/code], tests if the segment ([code]from[/code], [code]to[/code]) intersects with that hull. If an intersection is found, returns a [PackedVector3Array] containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty.
</description>
</method>
<method name="segment_intersects_cylinder">
- <return type="PoolVector3Array">
+ <return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
@@ -394,7 +394,7 @@
<argument index="3" name="radius" type="float">
</argument>
<description>
- Checks if the segment ([code]from[/code], [code]to[/code]) intersects the cylinder with height [code]height[/code] that is centered at the origin and has radius [code]radius[/code]. If no, returns an empty [PoolVector3Array]. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection.
+ Checks if the segment ([code]from[/code], [code]to[/code]) intersects the cylinder with height [code]height[/code] that is centered at the origin and has radius [code]radius[/code]. If no, returns an empty [PackedVector3Array]. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection.
</description>
</method>
<method name="segment_intersects_segment_2d">
@@ -413,7 +413,7 @@
</description>
</method>
<method name="segment_intersects_sphere">
- <return type="PoolVector3Array">
+ <return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
@@ -424,7 +424,7 @@
<argument index="3" name="sphere_radius" type="float">
</argument>
<description>
- Checks if the segment ([code]from[/code], [code]to[/code]) intersects the sphere that is located at [code]sphere_position[/code] and has radius [code]sphere_radius[/code]. If no, returns an empty [PoolVector3Array]. If yes, returns a [PoolVector3Array] containing the point of intersection and the sphere's normal at the point of intersection.
+ Checks if the segment ([code]from[/code], [code]to[/code]) intersects the sphere that is located at [code]sphere_position[/code] and has radius [code]sphere_radius[/code]. If no, returns an empty [PackedVector3Array]. If yes, returns a [PackedVector3Array] containing the point of intersection and the sphere's normal at the point of intersection.
</description>
</method>
<method name="segment_intersects_triangle">
@@ -445,21 +445,21 @@
</description>
</method>
<method name="triangulate_delaunay_2d">
- <return type="PoolIntArray">
+ <return type="PackedIntArray">
</return>
- <argument index="0" name="points" type="PoolVector2Array">
+ <argument index="0" name="points" type="PackedVector2Array">
</argument>
<description>
- Triangulates the area specified by discrete set of [code]points[/code] such that no point is inside the circumcircle of any resulting triangle. Returns a [PoolIntArray] where each triangle consists of three consecutive point indices into [code]points[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PoolIntArray] is returned.
+ Triangulates the area specified by discrete set of [code]points[/code] such that no point is inside the circumcircle of any resulting triangle. Returns a [PackedIntArray] where each triangle consists of three consecutive point indices into [code]points[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PackedIntArray] is returned.
</description>
</method>
<method name="triangulate_polygon">
- <return type="PoolIntArray">
+ <return type="PackedIntArray">
</return>
- <argument index="0" name="polygon" type="PoolVector2Array">
+ <argument index="0" name="polygon" type="PackedVector2Array">
</argument>
<description>
- Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PoolIntArray] where each triangle consists of three consecutive point indices into [code]polygon[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PoolIntArray] is returned.
+ Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PackedIntArray] where each triangle consists of three consecutive point indices into [code]polygon[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PackedIntArray] is returned.
</description>
</method>
</methods>