[postgis-tickets] [SCM] PostGIS branch master updated. 7a54134c70582a52676c1c4fae709db9e2a29c9a
git at osgeo.org
git at osgeo.org
Fri Jan 24 14:50:32 PST 2020
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 7a54134c70582a52676c1c4fae709db9e2a29c9a (commit)
from 8033b2844f14708e84ea9ae29e3129a03e457bd0 (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 7a54134c70582a52676c1c4fae709db9e2a29c9a
Author: Paul Ramsey <pramsey at cleverelephant.ca>
Date: Fri Jan 24 13:56:17 2020 -0800
Add docs for ST_Hexagon and ST_Square
diff --git a/doc/reference_constructor.xml b/doc/reference_constructor.xml
index b52f083..e39761e 100644
--- a/doc/reference_constructor.xml
+++ b/doc/reference_constructor.xml
@@ -951,6 +951,95 @@ WHERE ST_Intersects(admin1.geom, hexes.geom)
</refsection>
</refentry>
+ <refentry id="ST_Hexagon">
+ <refnamediv>
+ <refname>ST_Hexagon</refname>
+ <refpurpose>Returns a single hexagon, using the provided edge size and
+ cell coordinate within the hexagon grid space.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>geometry <function>ST_Hexagon</function></funcdef>
+ <paramdef><type>float8</type> <parameter>size</parameter></paramdef>
+ <paramdef><type>integer</type> <parameter>cell_i</parameter></paramdef>
+ <paramdef><type>integer</type> <parameter>cell_j</parameter></paramdef>
+ <paramdef choice="opt"><type>geometry</type> <parameter>origin</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Uses the same hexagon tiling concept as <xref linkend="ST_HexagonGrid" />, but generates just one hexagon at the desired cell coordinate. Optionally,
+ can adjust origin coordinate of the tiling, the default origin is at 0,0.
+ </para>
+ <para>Hexagons are generated with no SRID set, so use <xref linkend="ST_SetSRID" /> to set the SRID to the one you expect.</para>
+
+ <para>Availability: 3.1</para>
+ </refsection>
+
+ <refsection>
+ <title>Example: Creating a hexagon at the origin</title>
+ <programlisting>SELECT ST_AsText(ST_SetSRID(ST_Hexagon(1.0, 0, 0), 3857));
+
+POLYGON((-1 0,-0.5
+ -0.866025403784439,0.5
+ -0.866025403784439,1
+ 0,0.5
+ 0.866025403784439,-0.5
+ 0.866025403784439,-1 0)) </programlisting>
+ </refsection>
+ <refsection>
+ <title>See Also</title>
+ <para><xref linkend="ST_TileEnvelope" />, <xref linkend="ST_HexagonGrid" />, <xref linkend="ST_Square" /></para>
+ </refsection>
+ </refentry>
+
+ <refentry id="ST_Square">
+ <refnamediv>
+ <refname>ST_Square</refname>
+ <refpurpose>Returns a single square, using the provided edge size and
+ cell coordinate within the hexagon grid space.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>geometry <function>ST_Square</function></funcdef>
+ <paramdef><type>float8</type> <parameter>size</parameter></paramdef>
+ <paramdef><type>integer</type> <parameter>cell_i</parameter></paramdef>
+ <paramdef><type>integer</type> <parameter>cell_j</parameter></paramdef>
+ <paramdef choice="opt"><type>geometry</type> <parameter>origin</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Uses the same square tiling concept as <xref linkend="ST_SquareGrid" />, but generates just one square at the desired cell coordinate. Optionally,
+ can adjust origin coordinate of the tiling, the default origin is at 0,0.
+ </para>
+ <para>Squares are generated with no SRID set, so use <xref linkend="ST_SetSRID" /> to set the SRID to the one you expect.</para>
+
+ <para>Availability: 3.1</para>
+ </refsection>
+
+ <refsection>
+ <title>Example: Creating a square at the origin</title>
+ <programlisting>SELECT ST_AsText(ST_SetSRID(ST_Square(1.0, 0, 0), 3857));
+
+ POLYGON((0 0,0 1,1 1,1 0,0 0))</programlisting>
+ </refsection>
+ <refsection>
+ <title>See Also</title>
+ <para><xref linkend="ST_TileEnvelope" />, <xref linkend="ST_SquareGrid" />, <xref linkend="ST_Hexagon" /></para>
+ </refsection>
+ </refentry>
+
-----------------------------------------------------------------------
Summary of changes:
doc/reference_constructor.xml | 89 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 89 insertions(+)
hooks/post-receive
--
PostGIS
More information about the postgis-tickets
mailing list