]> granicus.if.org Git - postgis/commitdiff
Moved out of LRS section: line_locate_point back (to Misc),
authorSandro Santilli <strk@keybit.net>
Tue, 13 Dec 2005 12:51:00 +0000 (12:51 +0000)
committerSandro Santilli <strk@keybit.net>
Tue, 13 Dec 2005 12:51:00 +0000 (12:51 +0000)
line_substring and line_interpolate_point (to Geometry constructors).
Added more cross-references.

git-svn-id: http://svn.osgeo.org/postgis/trunk@2169 b70326c6-7e19-0410-871a-916f4a2858ee

doc/postgis.xml

index 2315fc56379d3550cfbaac14830f8b47a1908368..79d94fc85f0cdd20f7e961000ba0b81e16898564 100644 (file)
@@ -3520,7 +3520,7 @@ dimension
             </listitem>
           </varlistentry>
 
-          <varlistentry>
+          <varlistentry id="StartPoint">
             <term>StartPoint(geometry)</term>
 
             <listitem>
@@ -4253,7 +4253,7 @@ dimension
           </listitem>
         </varlistentry>
 
-        <varlistentry>
+        <varlistentry id="length2d">
           <term>length2d(geometry)</term>
 
           <listitem>
@@ -4452,6 +4452,30 @@ FROM geometry_table;</literallayout>
                  </listitem>
                </varlistentry>
 
+        <varlistentry id="line_interpolate_point">
+          <term>line_interpolate_point(linestring, location)</term>
+
+          <listitem>
+               <para>
+               Interpolates a point along a line. First argument must be a
+               LINESTRING. Second argument is a float8 between 0 and 1
+               representing fraction of total
+               <link linkend="length2d">2d length</link> the point has
+               to be located.
+               </para>
+
+               <para>
+               See <link linkend="line_locate_point">line_locate_point()</link>
+               for computing the line location nearest to a Point.
+               </para>
+
+               <para>
+                       Availability: 0.8.2
+               </para>
+          </listitem>
+        </varlistentry>
+
+
                <varlistentry>
                  <term>MakeBox2D(&lt;LL&gt;, &lt;UR&gt;)</term>
 
@@ -4494,6 +4518,29 @@ FROM geometry_table;</literallayout>
                  </listitem>
                </varlistentry>
 
+        <varlistentry id="line_substring">
+          <term>line_substring(linestring, start, end)</term>
+
+          <listitem>
+               <para>
+               Return a linestring being a substring of the input one starting
+               and ending at the given fractions of total 2d length. Second
+               and third arguments are float8 values between 0 and 1.
+               </para>
+
+               <para>
+               See <link linkend="line_locate_point">line_locate_point()</link>
+               for computing the line location nearest to a Point.
+               </para>
+
+               <para>
+                       Availability: 1.1.0
+               </para>
+          </listitem>
+        </varlistentry>
+
+
+
                <varlistentry>
                  <term>MakePolygon(linestring, [linestring[]])</term>
                  <listitem>
@@ -4836,49 +4883,6 @@ FROM geometry_table;</literallayout>
 
        <variablelist>
 
-        <varlistentry>
-          <term>line_interpolate_point(linestring, proportion)</term>
-
-          <listitem>
-            <para>Interpolates a point along a line. First argument must be a
-            LINESTRING. Second argument is a float between 0 and 1. Returns a
-            point.</para>
-               <para>
-                       Availability: 0.8.2
-               </para>
-          </listitem>
-        </varlistentry>
-
-
-        <varlistentry>
-          <term>line_substring(linestring, start, end)</term>
-
-          <listitem>
-               <para>
-               Return a linestring being a substring of the input one starting
-               and ending at the given fractions of total length. Second
-               and third arguments are float8 values between 0 and 1.
-               </para>
-               <para>
-                       Availability: 1.1.0
-               </para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term>line_locate_point(linestring, point)</term>
-
-          <listitem>
-               <para>
-               Returns a float, representing the proportional distance the
-               point is located along the line.
-               </para>
-               <para>
-                       Availability: 1.1.0
-               </para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry>
           <term>locate_along_measure(geometry, float8)</term>
 
@@ -5089,6 +5093,25 @@ FROM geometry_table;</literallayout>
           </listitem>
         </varlistentry>
 
+        <varlistentry id="line_locate_point">
+          <term>line_locate_point(LineString, Point)</term>
+          <listitem>
+               <para>
+               Returns a float between 0 and 1 representing 
+               the location of the closest point on LineString
+               to the given Point, as a fraction of
+               total <link linkend="length2d">2d line</link> length.
+               </para>
+
+               <para>
+       You can use the returned location to extract a Point (<link linkend="line_interpolate_point">line_interpolate_point</link>) or a substring (<link linkend="line_substring">line_substring</link>).
+               </para>
+
+               <para>
+                       Availability: 1.1.0
+               </para>
+          </listitem>
+        </varlistentry>
 
         </variablelist>
       </sect2>