[postgis-tickets] [SCM] PostGIS branch master updated. 3.1.0rc1-85-g86df398
git at osgeo.org
git at osgeo.org
Wed Feb 17 23:16:33 PST 2021
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "PostGIS".
The branch, master has been updated
via 86df398fcfced629460c0f03f8fb6691da405b26 (commit)
from 4b0e00a4e28013f9c3575532524fe2a6653f0658 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 86df398fcfced629460c0f03f8fb6691da405b26
Author: Martin Davis <mtnclimb at gmail.com>
Date: Wed Feb 17 23:16:23 2021 -0800
Improve doc Ref section for accessors
diff --git a/doc/reference_accessor.xml b/doc/reference_accessor.xml
index 17e92bb..5384309 100644
--- a/doc/reference_accessor.xml
+++ b/doc/reference_accessor.xml
@@ -86,6 +86,7 @@
<para><xref linkend="ST_GeometryType" /></para>
</refsection>
</refentry>
+
<refentry id="ST_Boundary">
<refnamediv>
<refname>ST_Boundary</refname>
@@ -202,6 +203,85 @@ MULTIPOINT(-1 1 1,1 1 0.75)
</refsection>
</refentry>
+ <refentry id="ST_BoundingDiagonal">
+ <refnamediv>
+ <refname>ST_BoundingDiagonal</refname>
+
+ <refpurpose>Returns the diagonal of a geometry's bounding box.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>geometry <function>ST_BoundingDiagonal</function></funcdef>
+
+ <paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
+ <paramdef choice="opt"><type>boolean </type> <parameter>fits=false</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>
+Returns the diagonal of the supplied geometry's bounding box as a LineString.
+The diagonal is a 2-point LineString with the minimum values of each dimension in its
+start point and the maximum values in its end point.
+If the input geometry is empty, the diagonal line is a LINESTRING EMPTY.
+ </para>
+
+ <para>
+The optional <varname>fits</varname> parameter specifies if the best fit is needed.
+If false, the diagonal of a somewhat larger bounding box can be accepted
+(which is faster to compute for geometries with many vertices). In either case,
+the bounding box of the returned diagonal line always covers the input
+geometry.
+ </para>
+
+ <para>
+The returned geometry retains the SRID and dimensionality
+(Z and M presence) of the input geometry.
+ </para>
+
+ <note><para>
+In degenerate cases (i.e. a single vertex in input) the returned linestring
+will be formally invalid (no interior).
+The result is still topologically valid.
+ </para></note>
+
+ <para>Availability: 2.2.0</para>
+ <para>&Z_support;</para>
+ <para>&M_support;</para>
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>
+-- Get the minimum X in a buffer around a point
+SELECT ST_X(ST_StartPoint(ST_BoundingDiagonal(
+ ST_Buffer(ST_MakePoint(0,0),10)
+)));
+ st_x
+------
+ -10
+ </programlisting>
+ </refsection>
+ <refsection>
+ <title>See Also</title>
+ <para>
+<xref linkend="ST_StartPoint" />,
+<xref linkend="ST_EndPoint" />,
+<xref linkend="ST_X" />,
+<xref linkend="ST_Y" />,
+<xref linkend="ST_Z" />,
+<xref linkend="ST_M" />,
+<xref linkend="ST_Envelope" />
+ </para>
+ </refsection>
+ </refentry>
+
<refentry id="ST_CoordDim">
<refnamediv>
<refname>ST_CoordDim</refname>
@@ -324,26 +404,29 @@ ST_Dimension
<refsection>
<title>Description</title>
- <para>This is a set-returning function (SRF). It returns a set of
- geometry_dump rows, formed by a geometry (geom) and an array of
- integers (path). When the input geometry is a simple type
- (POINT,LINESTRING,POLYGON) a single record will be returned with
- an empty path array and the input geometry as geom. When the input
- geometry is a collection or multi it will return a record for each
- of the collection components, and the path will express the
+ <para>A set-returning function (SRF) that extracts the components of a geometry.
+ It returns a set of
+ <varname><xref linkend="geometry_dump" /></varname> rows,
+ each containing a geometry (<parameter>geom</parameter> field)
+ and an array of integers (<parameter>path</parameter> field).
+ </para>
+
+ <para>For an atomic geometry type
+ (POINT,LINESTRING,POLYGON) a single record is returned with
+ an empty <parameter>path</parameter> array and the input geometry as <parameter>geom</parameter>.
+ For a collection or multi-geometry a record is returned for each
+ of the collection components, and the <parameter>path</parameter> denotes the
position of the component inside the collection.</para>
<para>ST_Dump is useful for expanding geometries. It is the
- reverse of a GROUP BY in that it creates new rows. For example it
- can be use to expand MULTIPOLYGONS into POLYGONS.</para>
+ inverse of a <xref linkend="ST_Collect" /> / GROUP BY, in that it creates new rows.
+ For example it can be use to expand MULTIPOLYGONS into POLYGONS.</para>
<para>Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
<para>Availability: PostGIS 1.0.0RC1. Requires PostgreSQL 7.3 or higher.</para>
<note><para>Prior to 1.3.4, this function crashes if used with geometries that contain CURVES. This is fixed in 1.3.4+</para></note>
-
-
<para>&curve_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
@@ -412,20 +495,20 @@ SELECT (g.gdump).path, ST_AsEWKT((g.gdump).geom) as wkt
</refsection>
<refsection>
<title>See Also</title>
- <para><xref linkend="geometry_dump" />, <xref linkend="PostGIS_Geometry_DumpFunctions" />, <xref linkend="ST_Collect" />, <xref linkend="ST_Collect" />, <xref linkend="ST_GeometryN" /></para>
+ <para><xref linkend="geometry_dump" />, <xref linkend="PostGIS_Geometry_DumpFunctions" />, <xref linkend="ST_Collect" />, <xref linkend="ST_GeometryN" /></para>
</refsection>
</refentry>
<refentry id="ST_DumpPoints">
<refnamediv>
<refname>ST_DumpPoints</refname>
- <refpurpose>Returns a set of <varname>geometry_dump</varname> rows for the points in a geometry.</refpurpose>
+ <refpurpose>Returns a set of <varname>geometry_dump</varname> rows for the coordinates in a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
- <funcdef>geometry_dump[]<function>ST_DumpPoints</function></funcdef>
+ <funcdef>geometry_dump[] <function>ST_DumpPoints</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -433,27 +516,44 @@ SELECT (g.gdump).path, ST_AsEWKT((g.gdump).geom) as wkt
<refsection>
<title>Description</title>
- <para>This set-returning function (SRF) returns a set of <varname>geometry_dump</varname> rows formed
- by a geometry (<varname>geom</varname>) and an array of integers (<varname>path</varname>).</para>
-
- <para>The <parameter>geom</parameter> component of <varname>geometry_dump</varname> are
- all the <varname>POINT</varname>s that make up the supplied geometry</para>
-
- <para>The <parameter>path</parameter> component of <varname>geometry_dump</varname> (an <varname>integer[]</varname>)
- is an index reference enumerating the <varname>POINT</varname>s of the supplied geometry.
- For example, if a <varname>LINESTRING</varname> is supplied, a path of <varname>{i}</varname> is
- returned where <varname>i</varname> is the <varname>nth</varname> coordinate in the <varname>LINESTRING</varname>.
- If a <varname>POLYGON</varname> is supplied, a path of <varname>{i,j}</varname> is returned where
- <varname>i</varname> is the ring number (1 is outer; inner rings follow) and <varname>j</varname>
- enumerates the <varname>POINT</varname>s (again 1-based index).
- </para>
- <para>Enhanced: 2.1.0 Faster speed. Reimplemented as native-C.</para>
- <para>Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
- <para>Availability: 1.5.0</para>
- <para>&curve_support;</para>
- <para>&P_support;</para>
- <para>&T_support;</para>
- <para>&Z_support;</para>
+ <para>A set-returning function (SRF) that extracts the coordinates (vertices) of a geometry.
+ It returns a set of
+ <varname><xref linkend="geometry_dump" /></varname> rows,
+ each containing a geometry (<parameter>geom</parameter> field)
+ and an array of integers (<parameter>path</parameter> field).
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>the <parameter>geom</parameter> field
+ <varname>POINT</varname>s represent the coordinates of the supplied geometry.
+ </para>
+ </listitem>
+ <listitem>
+ <para>the <parameter>path</parameter> field (an <varname>integer[]</varname>)
+ is an index enumerating the coordinate positions in the elements of the supplied geometry.
+ The indices are 1-based.
+ For example, for a <varname>LINESTRING</varname> the paths are <varname>{i}</varname>
+ where <varname>i</varname> is the <varname>nth</varname>
+ coordinate in the <varname>LINESTRING</varname>.
+ For a <varname>POLYGON</varname> the paths are <varname>{i,j}</varname> where
+ <varname>i</varname> is the ring number (1 is outer; inner rings follow)
+ and <varname>j</varname> is the coordinate position in the ring.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ To obtain a single geometry containing the coordinates use <xref linkend="ST_Points" />.
+ </para>
+
+ <para>Enhanced: 2.1.0 Faster speed. Reimplemented as native-C.</para>
+ <para>Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
+ <para>Availability: 1.5.0</para>
+ <para>&curve_support;</para>
+ <para>&P_support;</para>
+ <para>&T_support;</para>
+ <para>&Z_support;</para>
</refsection>
<refsection><title>Classic Explode a Table of LineStrings into nodes</title>
@@ -634,7 +734,8 @@ SELECT (g.gdump).path, ST_AsEWKT((g.gdump).geom) as wkt
</refsection>
<refsection>
<title>See Also</title>
- <para><xref linkend="geometry_dump" />, <xref linkend="PostGIS_Geometry_DumpFunctions" />, <xref linkend="ST_Dump" />, <xref linkend="ST_DumpRings" /></para>
+ <para><xref linkend="geometry_dump" />, <xref linkend="PostGIS_Geometry_DumpFunctions" />,
+ <xref linkend="ST_Dump" />, <xref linkend="ST_DumpRings" />, <xref linkend="ST_Points" /></para>
</refsection>
</refentry>
<refentry id="ST_DumpRings">
@@ -657,26 +758,31 @@ SELECT (g.gdump).path, ST_AsEWKT((g.gdump).geom) as wkt
<refsection>
<title>Description</title>
- <para>This is a set-returning function (SRF). It returns a set of
- <varname>geometry_dump</varname> rows, defined as an <varname>integer[]</varname>
- and a <varname>geometry</varname>, aliased "path" and "geom" respectively.
- The "path" field holds the polygon ring index containing a single integer: 0 for the shell, >0 for holes.
- The "geom" field contains the corresponding ring as a polygon.</para>
-
+ <para>A set-returning function (SRF) that extracts the rings of a polygon.
+ It returns a set of <varname><xref linkend="geometry_dump" /></varname> rows,
+ each containing a geometry (<parameter>geom</parameter> field)
+ and an array of integers (<parameter>path</parameter> field).
+ </para>
+ <para>
+ The <parameter>geom</parameter> field contains each ring as a POLYGON.</para>
+ The <parameter>path</parameter> field is an integer array of length 1 containing the polygon ring index.
+ The exterior ring (shell) has index 0. The interior rings (holes) have indices of 1 and higher.
+
+ <note><para>This only works for POLYGON geometries. It does not work for MULTIPOLYGONS</para></note>
<para>Availability: PostGIS 1.1.3. Requires PostgreSQL 7.3 or higher.</para>
- <note><para>This only works for POLYGON geometries. It will not work for MULTIPOLYGONS</para></note>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
-
- <programlisting>SELECT sometable.field1, sometable.field1,
- (ST_DumpRings(sometable.the_geom)).geom As the_geom
-FROM sometableOfpolys;
-
-SELECT ST_AsEWKT(geom) As the_geom, path
+ <para>General form of query.</para>
+ <programlisting>SELECT polyTable.field1, polyTable.field1,
+ (ST_DumpRings(polyTable.the_geom)).geom As the_geom
+FROM polyTable;
+</programlisting>
+ <para>A polygon with a single hole.</para>
+<programlisting>SELECT path, ST_AsEWKT(geom) As the_geom
FROM ST_DumpRings(
ST_GeomFromEWKT('POLYGON((-8149064 5133092 1,-8149064 5132986 1,-8148996 5132839 1,-8148972 5132767 1,-8148958 5132508 1,-8148941 5132466 1,-8148924 5132394 1,
-8148903 5132210 1,-8148930 5131967 1,-8148992 5131978 1,-8149237 5132093 1,-8149404 5132211 1,-8149647 5132310 1,-8149757 5132394 1,
@@ -882,85 +988,6 @@ POLYGON((20 75,20 150,125 150,125 75,20 75))</programlisting>
</refsection>
</refentry>
- <refentry id="ST_BoundingDiagonal">
- <refnamediv>
- <refname>ST_BoundingDiagonal</refname>
-
- <refpurpose>Returns the diagonal of a geometry's bounding box.</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <funcsynopsis>
- <funcprototype>
- <funcdef>geometry <function>ST_BoundingDiagonal</function></funcdef>
-
- <paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
- <paramdef choice="opt"><type>boolean </type> <parameter>fits=false</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
-
- <refsection>
- <title>Description</title>
-
- <para>
-Returns the diagonal of the supplied geometry's bounding box as a LineString.
-If the input geometry is empty, the diagonal line is also empty, otherwise
-it is a 2-point LineString with the minimum values of each dimension in its
-start point and the maximum values in its end point.
- </para>
-
- <para>
-The returned linestring geometry always retains SRID and dimensionality
-(Z and M presence) of the input geometry.
- </para>
-
- <para>
-The <varname>fits</varname> parameter specifies if the best fit is needed.
-If false, the diagonal of a somewhat larger bounding box can be accepted
-(is faster to obtain for geometries with a lot of vertices). In any case
-the bounding box of the returned diagonal line always covers the input
-geometry.
- </para>
-
- <note><para>
-In degenerate cases (a single vertex in input) the returned linestring
-will be topologically invalid (no interior). This does not make the
-return semantically invalid.
- </para></note>
-
- <para>Availability: 2.2.0</para>
- <para>&Z_support;</para>
- <para>&M_support;</para>
- </refsection>
-
- <refsection>
- <title>Examples</title>
-
- <programlisting>
--- Get the minimum X in a buffer around a point
-SELECT ST_X(ST_StartPoint(ST_BoundingDiagonal(
- ST_Buffer(ST_MakePoint(0,0),10)
-)));
- st_x
-------
- -10
- </programlisting>
- </refsection>
- <refsection>
- <title>See Also</title>
- <para>
-<xref linkend="ST_StartPoint" />,
-<xref linkend="ST_EndPoint" />,
-<xref linkend="ST_X" />,
-<xref linkend="ST_Y" />,
-<xref linkend="ST_Z" />,
-<xref linkend="ST_M" />,
-<xref linkend="geometry_overlaps_nd" />
- </para>
- </refsection>
- </refentry>
-
<refentry id="ST_ExteriorRing">
<refnamediv>
<refname>ST_ExteriorRing</refname>
@@ -981,10 +1008,13 @@ SELECT ST_X(ST_StartPoint(ST_BoundingDiagonal(
<refsection>
<title>Description</title>
- <para>Returns a line string representing the exterior ring of the <varname>POLYGON</varname> geometry. Return
- NULL if the geometry is not a polygon.</para>
+ <para>Returns a LINESTRING representing the exterior ring (shell) of a POLYGON.
+ Returns NULL if the geometry is not a polygon.</para>
- <note><para>Only works with POLYGON geometry types</para></note>
+ <note>
+ <para>This function does not support MULTIPOLYGONs.
+ For MULTIPOLYGONs use in conjunction with <xref linkend="ST_GeometryN" /> or <xref linkend="ST_Dump" /> </para>
+ </note>
<para>&sfs_compliant; 2.1.5.1</para>
<para>&sqlmm_compliant; SQL-MM 3: 8.2.3, 8.3.3</para>
@@ -1034,7 +1064,7 @@ LINESTRING(0 0 1,1 1 1,1 2 1,1 1 1,0 0 1)
<refnamediv>
<refname>ST_GeometryN</refname>
- <refpurpose>Return the Nth geometry element of a geometry collection.</refpurpose>
+ <refpurpose>Return an element of a geometry collection.</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -1050,9 +1080,9 @@ LINESTRING(0 0 1,1 1 1,1 2 1,1 1 1,0 0 1)
<refsection>
<title>Description</title>
- <para>Return the 1-based Nth geometry if the geometry is a
- GEOMETRYCOLLECTION, (MULTI)POINT, (MULTI)LINESTRING, MULTICURVE or (MULTI)POLYGON, POLYHEDRALSURFACE
- Otherwise, return NULL</para>
+ <para>Return the 1-based Nth element geometry of an input geometry which is a
+ GEOMETRYCOLLECTION, MULTIPOINT, MULTILINESTRING, MULTICURVE, MULTI)POLYGON, or POLYHEDRALSURFACE.
+ Otherwise, returns NULL.</para>
<note>
<para>Index is 1-based as for OGC specs since version 0.8.0.
@@ -1060,7 +1090,7 @@ LINESTRING(0 0 1,1 1 1,1 2 1,1 1 1,0 0 1)
</note>
<note>
- <para>If you want to extract all geometries, of a geometry, <xref linkend="ST_Dump" /> is more efficient, and also works for singular geoms.</para>
+ <para>To extract all elements of a geometry, <xref linkend="ST_Dump" /> is more efficient and works for atomoic geometrie.</para>
</note>
<para>Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
<para>Changed: 2.0.0 Prior versions would return NULL for singular geometries. This was changed to return the geometry for ST_GeometryN(..,1) case.</para>
@@ -1289,13 +1319,15 @@ SELECT ST_AsEWKT(ST_GeometryN(geom,2)) as wkt
<refsection>
<title>Description</title>
- <para>Returns the Nth interior linestring ring of the polygon geometry.
- Returns NULL if the geometry is not a polygon or the given N is out
- of range. The index starts at 1.</para>
+ <para>Returns the Nth interior ring (hole) of a POLYGON geometry as a LINESTRING.
+ The index starts at 1.
+ Returns NULL if the geometry is not a polygon or the index is out
+ of range. </para>
<!-- optionally mention that this function uses indexes if appropriate -->
<note>
- <para>This function does not support for MULTIPOLYGONs. Use in conjunction with <xref linkend="ST_Dump" /> for MULTIPOLYGONS</para>
+ <para>This function does not support MULTIPOLYGONs.
+ For MULTIPOLYGONs use in conjunction with <xref linkend="ST_GeometryN" /> or <xref linkend="ST_Dump" /> </para>
</note>
<para>&sfs_compliant;</para>
@@ -1313,7 +1345,7 @@ SELECT ST_AsText(ST_InteriorRingN(the_geom, 1)) As the_geom
FROM (SELECT ST_BuildArea(
ST_Collect(ST_Buffer(ST_Point(1,2), 20,3),
ST_Buffer(ST_Point(1, 2), 10,3))) As the_geom
- ) as foo
+ ) as foo;
</programlisting>
</refsection>
@@ -1322,155 +1354,16 @@ FROM (SELECT ST_BuildArea(
<title>See Also</title>
<para>
-<xref linkend="ST_ExteriorRing" />
-<xref linkend="ST_BuildArea" />,
-<xref linkend="ST_Collect" />,
-<xref linkend="ST_Dump" />,
-<xref linkend="ST_NumInteriorRing" />,
-<xref linkend="ST_NumInteriorRings" />
+ <xref linkend="ST_ExteriorRing" />,
+ <xref linkend="ST_BuildArea" />,
+ <xref linkend="ST_Collect" />,
+ <xref linkend="ST_Dump" />,
+ <xref linkend="ST_NumInteriorRing" />,
+ <xref linkend="ST_NumInteriorRings" />
</para>
</refsection>
</refentry>
- <refentry id="ST_IsPolygonCCW">
- <refnamediv>
- <refname>
- ST_IsPolygonCCW
- </refname>
- <refpurpose>Tests if Polygons have exterior rings oriented counter-clockwise and interior rings oriented clockwise.
- </refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <funcsynopsis>
- <funcprototype>
- <funcdef>
- boolean
- <function>ST_IsPolygonCCW</function>
- </funcdef>
- <paramdef>
- <type>geometry</type>
- <parameter>geom</parameter>
- </paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
-
- <refsection>
- <title>Description</title>
-
- <para>
- Returns true if all polygonal components of the input geometry use a counter-clockwise
- orientation for their exterior ring, and a clockwise direction
- for all interior rings.
- </para>
-
- <para>
- Returns true if the geometry has no polygonal components.
- </para>
-
- <note>
- <para>
- Closed linestrings are not considered polygonal components,
- so you would still get a true return by passing
- a single closed linestring no matter its orientation.
- </para>
- </note>
-
- <note>
- <para>
- If a polygonal geometry does not use reversed orientation
- for interior rings (i.e., if one or more interior rings
- are oriented in the same direction as an exterior ring)
- then both ST_IsPolygonCW and ST_IsPolygonCCW will return false.
- </para>
- </note>
-
- <para>Availability: 2.4.0</para>
- <para>&Z_support;</para>
- <para>&M_support;</para>
-
- </refsection>
-
- <refsection>
- <title>See Also</title>
- <para>
- <xref linkend="ST_ForcePolygonCW" />,
- <xref linkend="ST_ForcePolygonCCW" />,
- <xref linkend="ST_IsPolygonCW" />
- </para>
- </refsection>
- </refentry>
-
- <refentry id="ST_IsPolygonCW">
- <refnamediv>
- <refname>
- ST_IsPolygonCW
- </refname>
- <refpurpose>Tests if Polygons have exterior rings oriented clockwise and interior rings oriented counter-clockwise.
- </refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <funcsynopsis>
- <funcprototype>
- <funcdef>
- boolean
- <function>ST_IsPolygonCW</function>
- </funcdef>
- <paramdef>
- <type>geometry</type>
- <parameter>geom</parameter>
- </paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
-
- <refsection>
- <title>Description</title>
-
- <para>
- Returns true if all polygonal components of the input geometry use a clockwise
- orientation for their exterior ring, and a counter-clockwise direction
- for all interior rings.
- </para>
-
- <para>
- Returns true if the geometry has no polygonal components.
- </para>
-
- <note>
- <para>
- Closed linestrings are not considered polygonal components,
- so you would still get a true return by passing
- a single closed linestring no matter its orientation.
- </para>
- </note>
-
- <note>
- <para>
- If a polygonal geometry does not use reversed orientation
- for interior rings (i.e., if one or more interior rings
- are oriented in the same direction as an exterior ring)
- then both ST_IsPolygonCW and ST_IsPolygonCCW will return false.
- </para>
- </note>
-
- <para>Availability: 2.4.0</para>
- <para>&Z_support;</para>
- <para>&M_support;</para>
- </refsection>
-
- <refsection>
- <title>See Also</title>
- <para>
- <xref linkend="ST_ForcePolygonCW" />,
- <xref linkend="ST_ForcePolygonCCW" />,
- <xref linkend="ST_IsPolygonCW" />
- </para>
- </refsection>
- </refentry>
-
<refentry id="ST_IsClosed">
<refnamediv>
<refname>ST_IsClosed</refname>
@@ -1738,6 +1631,145 @@ SELECT ST_IsEmpty(ST_GeomFromText('POLYGON((1 2, 3 4, 5 6, 1 2))'));
</refentry>
+ <refentry id="ST_IsPolygonCCW">
+ <refnamediv>
+ <refname>
+ ST_IsPolygonCCW
+ </refname>
+ <refpurpose>Tests if Polygons have exterior rings oriented counter-clockwise and interior rings oriented clockwise.
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ boolean
+ <function>ST_IsPolygonCCW</function>
+ </funcdef>
+ <paramdef>
+ <type>geometry</type>
+ <parameter>geom</parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>
+ Returns true if all polygonal components of the input geometry use a counter-clockwise
+ orientation for their exterior ring, and a clockwise direction
+ for all interior rings.
+ </para>
+
+ <para>
+ Returns true if the geometry has no polygonal components.
+ </para>
+
+ <note>
+ <para>
+ Closed linestrings are not considered polygonal components,
+ so you would still get a true return by passing
+ a single closed linestring no matter its orientation.
+ </para>
+ </note>
+
+ <note>
+ <para>
+ If a polygonal geometry does not use reversed orientation
+ for interior rings (i.e., if one or more interior rings
+ are oriented in the same direction as an exterior ring)
+ then both ST_IsPolygonCW and ST_IsPolygonCCW will return false.
+ </para>
+ </note>
+
+ <para>Availability: 2.4.0</para>
+ <para>&Z_support;</para>
+ <para>&M_support;</para>
+
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+ <para>
+ <xref linkend="ST_ForcePolygonCW" />,
+ <xref linkend="ST_ForcePolygonCCW" />,
+ <xref linkend="ST_IsPolygonCW" />
+ </para>
+ </refsection>
+ </refentry>
+
+ <refentry id="ST_IsPolygonCW">
+ <refnamediv>
+ <refname>
+ ST_IsPolygonCW
+ </refname>
+ <refpurpose>Tests if Polygons have exterior rings oriented clockwise and interior rings oriented counter-clockwise.
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ boolean
+ <function>ST_IsPolygonCW</function>
+ </funcdef>
+ <paramdef>
+ <type>geometry</type>
+ <parameter>geom</parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>
+ Returns true if all polygonal components of the input geometry use a clockwise
+ orientation for their exterior ring, and a counter-clockwise direction
+ for all interior rings.
+ </para>
+
+ <para>
+ Returns true if the geometry has no polygonal components.
+ </para>
+
+ <note>
+ <para>
+ Closed linestrings are not considered polygonal components,
+ so you would still get a true return by passing
+ a single closed linestring no matter its orientation.
+ </para>
+ </note>
+
+ <note>
+ <para>
+ If a polygonal geometry does not use reversed orientation
+ for interior rings (i.e., if one or more interior rings
+ are oriented in the same direction as an exterior ring)
+ then both ST_IsPolygonCW and ST_IsPolygonCCW will return false.
+ </para>
+ </note>
+
+ <para>Availability: 2.4.0</para>
+ <para>&Z_support;</para>
+ <para>&M_support;</para>
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+ <para>
+ <xref linkend="ST_ForcePolygonCW" />,
+ <xref linkend="ST_ForcePolygonCCW" />,
+ <xref linkend="ST_IsPolygonCW" />
+ </para>
+ </refsection>
+ </refentry>
+
<refentry id="ST_IsRing">
<refnamediv>
<refname>ST_IsRing</refname>
@@ -2214,7 +2246,7 @@ GROUP BY gid, field1,field2;
<refsection>
<title>See Also</title>
- <para><xref linkend="ST_NumInteriorRing" /></para>
+ <para><xref linkend="ST_NumInteriorRing" />, <xref linkend="ST_InteriorRingN" /></para>
</refsection>
</refentry>
@@ -2236,7 +2268,7 @@ GROUP BY gid, field1,field2;
<refsection>
<title>See Also</title>
- <para><xref linkend="ST_NumInteriorRings" /></para>
+ <para><xref linkend="ST_NumInteriorRings" />, <xref linkend="ST_InteriorRingN" /></para>
</refsection>
</refentry>
@@ -2495,7 +2527,7 @@ FROM ST_GeomFromText('LINESTRING(0 0 0, 1 1 1, 2 2 2)') AS g
<refentry id="ST_Points">
<refnamediv>
<refname>ST_Points</refname>
- <refpurpose>Returns a MultiPoint containing all the coordinates of a geometry.
+ <refpurpose>Returns a MultiPoint containing the coordinates of a geometry.
</refpurpose>
</refnamediv>
@@ -2515,13 +2547,18 @@ FROM ST_GeomFromText('LINESTRING(0 0 0, 1 1 1, 2 2 2)') AS g
<title>Description</title>
<para>
- Returns a MultiPoint containing all of the coordinates of a
- geometry. Does not remove points that are duplicated in
- the input geometry, including start and end points of ring geometries.
+ Returns a MultiPoint containing all the coordinates of a
+ geometry. Does not remove points that are repeated in
+ the geometry, including the start and end points of ring geometries.
(If this behavior is undesired, duplicates may be removed using
<xref linkend="ST_RemoveRepeatedPoints" />).
</para>
+ <para>
+ To obtain information about the position of each coordinate in the parent geometry
+ use <xref linkend="ST_DumpPoints" />.
+ </para>
+
<para>
M and Z coordinates will be preserved if present.
</para>
@@ -2545,7 +2582,7 @@ MULTIPOINT Z (30 10 4,10 30 5,40 40 6, 30 10 4)
<refsection>
<title>See Also</title>
- <para><xref linkend="ST_RemoveRepeatedPoints" /></para>
+ <para><xref linkend="ST_RemoveRepeatedPoints" />, <xref linkend="ST_DumpPoints" /></para>
</refsection>
</refentry>
diff --git a/doc/reference_type.xml b/doc/reference_type.xml
index c91be1c..c23b8d7 100644
--- a/doc/reference_type.xml
+++ b/doc/reference_type.xml
@@ -171,12 +171,13 @@
containing the fields:</para>
<itemizedlist>
<listitem>
- <para><varname>geom</varname> - a references to a component geometry</para>
+ <para><varname>geom</varname> - a geometry representing a component of the dumped geometry.
+ The geometry type depends on the originating function.</para>
</listitem>
<listitem>
- <para><varname>path[]</varname> - a 1-dimensional integer array
+ <para><varname>path[]</varname> - an integer array
that defines the navigation path within the dumped geometry to the <varname>geom</varname> component.
- The path array starts at 1 (e.g. <varname>path[1]</varname> is the first element.)</para>
+ The path array is 1-based (i.e. <varname>path[1]</varname> is the first element.)</para>
</listitem>
</itemizedlist>
<para>
-----------------------------------------------------------------------
Summary of changes:
doc/reference_accessor.xml | 623 ++++++++++++++++++++++++---------------------
doc/reference_type.xml | 7 +-
2 files changed, 334 insertions(+), 296 deletions(-)
hooks/post-receive
--
PostGIS
More information about the postgis-tickets
mailing list