]> granicus.if.org Git - postgis/commitdiff
#2753: patch from vmp -- revised patch moving intro into an abstract instead of as...
authorRegina Obe <lr@pcorp.us>
Fri, 20 Jun 2014 05:41:33 +0000 (05:41 +0000)
committerRegina Obe <lr@pcorp.us>
Fri, 20 Jun 2014 05:41:33 +0000 (05:41 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@12626 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference_sfcgal.xml

index 94aa4ce921b00f1e82c03673d30007a2e008fa94..7a0db80caa1b58b4446b9e81d3933fddfa45eb46 100644 (file)
@@ -1,13 +1,45 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-  <sect1 id="reference_sfcgal">
-       <title>Using SFCGAL Advanced 2D/3D functions</title>
-        <para> 
-          TODO Introduction part
+<sect1 id="reference_sfcgal">
+       <sect1info>
+               <abstract>
+                               <para> 
+            SFCGAL is a C++ wrapper  library around CGAL that provides advanced 2D and 3D functions. 
+            For robustness, geometry coordinates have an exact rational number representation.
         </para>
         <para> 
-          TODO Install part
+            Installation instructions of the library can be found on SFCGAL home page (http://www.sfcgal.org). 
+            To load the functions execute postgis/sfcgal.sql
         </para>
+               </abstract>
+       </sect1info>
+       <refentry id="postgis_sfcgal_version">
+         <refnamediv>
+               <refname>postgis_sfcgal_version</refname>
+
+               <refpurpose>Returns the version of SFCGAL in use</refpurpose>
+         </refnamediv>
+
+         <refsynopsisdiv>
+               <funcsynopsis>
+                 <funcprototype>
+                       <funcdef>text <function>postgis_sfcgal_version</function></funcdef>
+                        <void/>
+                 </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+
+         <refsection>
+               <title>Description</title>
+
+               <para>Availability</para>
+               <para>&sfcgal_required;</para>
+               <para>&Z_support;</para>
+               <para>&P_support;</para>
+               <para>&T_support;</para>
+         </refsection>
+
+       </refentry>
+
 
        <refentry id="ST_Extrude">
          <refnamediv>
 
        </refentry>
 
+       <refentry id="ST_3DIntersection">
+         <refnamediv>
+               <refname>ST_3DIntersection</refname>
+
+               <refpurpose>Perform 3D intersection</refpurpose>
+         </refnamediv>
+
+         <refsynopsisdiv>
+               <funcsynopsis>
+                 <funcprototype>
+                       <funcdef>geometry <function>ST_3DIntersection</function></funcdef>
+                       <paramdef><type>geometry</type> <parameter>geom1</parameter></paramdef>
+                       <paramdef><type>geometry</type> <parameter>geom2</parameter></paramdef>
+                 </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+
+         <refsection>
+               <title>Description</title>
+
+               <para>Availability</para>
+               <para>&sfcgal_required;</para>
+               <para>&Z_support;</para>
+               <para>&P_support;</para>
+               <para>&T_support;</para>
+         </refsection>
+
+       </refentry>
+
+       <refentry id="ST_3DArea">
+         <refnamediv>
+               <refname>ST_3DArea</refname>
+
+               <refpurpose>Computes area of 3D geometries</refpurpose>
+         </refnamediv>
+
+         <refsynopsisdiv>
+               <funcsynopsis>
+                 <funcprototype>
+                       <funcdef>float<function>ST_3DArea</function></funcdef>
+                       <paramdef><type>geometry</type> <parameter>geom1</parameter></paramdef>
+                 </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+
+         <refsection>
+               <title>Description</title>
+
+               <para>Availability</para>
+               <para>&sfcgal_required;</para>
+               <para>&Z_support;</para>
+               <para>&P_support;</para>
+               <para>&T_support;</para>
+         </refsection>
+
+       </refentry>
 
        <refentry id="ST_Tesselate">
          <refnamediv>
 
        </refentry>
 
-  </sect1>
+</sect1>