File: reference_sfcgal.xml

package info (click to toggle)
postgis 2.1.4%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 35,424 kB
  • ctags: 8,886
  • sloc: sql: 113,491; ansic: 97,254; xml: 41,127; sh: 11,925; java: 5,662; perl: 3,113; makefile: 2,265; python: 1,198; yacc: 438; lex: 114
file content (277 lines) | stat: -rw-r--r-- 7,097 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<?xml version="1.0" encoding="UTF-8"?>
<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> 
            Installation instructions of the library can be found on SFCGAL home page <ulink url="http://www.sfcgal.org">http://www.sfcgal.org</ulink>. 
            To load the functions execute postgis/sfcgal.sql
        </para>
		</abstract>
	</sect1info>
	<title>SFCGAL Functions</title>
	<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: 2.1.0</para>
		<para>&sfcgal_required;</para>
		<para>&Z_support;</para>
		<para>&P_support;</para>
		<para>&T_support;</para>
	  </refsection>

	</refentry>


	<refentry id="ST_Extrude">
	  <refnamediv>
		<refname>ST_Extrude</refname>

		<refpurpose>Extrude a surface to a related volume</refpurpose>
	  </refnamediv>

	  <refsynopsisdiv>
		<funcsynopsis>
		  <funcprototype>
			<funcdef>geometry <function>ST_Extrude</function></funcdef>
			<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
			<paramdef><type>float</type> <parameter>x</parameter></paramdef>
			<paramdef><type>float</type> <parameter>y</parameter></paramdef>
			<paramdef><type>float</type> <parameter>z</parameter></paramdef>
		  </funcprototype>
		</funcsynopsis>
	  </refsynopsisdiv>

	  <refsection>
		<title>Description</title>

		<para>Availability: 2.1.0</para>
		<para>&sfcgal_required;</para>
		<para>&Z_support;</para>
		<para>&P_support;</para>
		<para>&T_support;</para>
	  </refsection>

	</refentry>


	<refentry id="ST_StraightSkeleton">
	  <refnamediv>
		<refname>ST_StraightSkeleton</refname>

		<refpurpose>Compute a straight skeleton from a geometry</refpurpose>
	  </refnamediv>

	  <refsynopsisdiv>
		<funcsynopsis>
		  <funcprototype>
			<funcdef>geometry <function>ST_StraightSkeleton</function></funcdef>
			<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
		  </funcprototype>
		</funcsynopsis>
	  </refsynopsisdiv>

	  <refsection>
		<title>Description</title>

		<para>Availability: 2.1.0</para>
		<para>&sfcgal_required;</para>
		<para>&Z_support;</para>
		<para>&P_support;</para>
		<para>&T_support;</para>
	  </refsection>

	</refentry>

	<refentry id="ST_Orientation">
	  <refnamediv>
		<refname>ST_Orientation</refname>

		<refpurpose>Determine surface orientation</refpurpose>
	  </refnamediv>

	  <refsynopsisdiv>
		<funcsynopsis>
		  <funcprototype>
			<funcdef>integer <function>ST_Orientation</function></funcdef>
			<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
		  </funcprototype>
		</funcsynopsis>
	  </refsynopsisdiv>

	  <refsection>
		<title>Description</title>

		<para>Availability: 2.1.0</para>
		<para>&sfcgal_required;</para>
		<para>&Z_support;</para>
		<para>&P_support;</para>
		<para>&T_support;</para>
	  </refsection>

	</refentry>


	<refentry id="ST_ForceLHR">
	  <refnamediv>
		<refname>ST_ForceLHR</refname>

		<refpurpose>Force LHR orientation</refpurpose>
	  </refnamediv>

	  <refsynopsisdiv>
		<funcsynopsis>
		  <funcprototype>
			<funcdef>geometry <function>ST_ForceLHR</function></funcdef>
			<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
		  </funcprototype>
		</funcsynopsis>
	  </refsynopsisdiv>

	  <refsection>
		<title>Description</title>

		<para>Availability: 2.1.0</para>
		<para>&sfcgal_required;</para>
		<para>&Z_support;</para>
		<para>&P_support;</para>
		<para>&T_support;</para>
	  </refsection>

	</refentry>

	<refentry id="ST_MinkowskiSum">
	  <refnamediv>
		<refname>ST_MinkowskiSum</refname>

		<refpurpose>Performs Minkowski sum</refpurpose>
	  </refnamediv>

	  <refsynopsisdiv>
		<funcsynopsis>
		  <funcprototype>
			<funcdef>geometry <function>ST_MinkowskiSum</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>This function performs a 2D minkowski sum of a point, line or polygon with a polygon.</para>
                <para>The first parameter can be any 2D geometry (point, linestring, polygon). If a 3D geometry is passed, it will be converted to 2D by forcing Z to 0, leading to possible cases of invalidity. The second parameter must be a 2D polygon.</para>

		<para>Availability: 2.1.0</para>
		<para>&sfcgal_required;</para>
		<para>&Z_support;</para>
	  </refsection>

	</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: 2.1.0</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: 2.1.0</para>
		<para>&sfcgal_required;</para>
		<para>&Z_support;</para>
		<para>&P_support;</para>
		<para>&T_support;</para>
	  </refsection>

	</refentry>

	<refentry id="ST_Tesselate">
	  <refnamediv>
		<refname>ST_Tesselate</refname>

		<refpurpose>Perform surface Tesselation</refpurpose>
	  </refnamediv>

	  <refsynopsisdiv>
		<funcsynopsis>
		  <funcprototype>
			<funcdef>geometry <function>ST_Tesselate</function></funcdef>
			<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
		  </funcprototype>
		</funcsynopsis>
	  </refsynopsisdiv>

	  <refsection>
		<title>Description</title>

		<para>Availability: 2.1.0</para>
		<para>&sfcgal_required;</para>
		<para>&Z_support;</para>
		<para>&P_support;</para>
		<para>&T_support;</para>
	  </refsection>

	</refentry>

</sect1>