<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>OGR: OGRSurface Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>OGRSurface Class Reference</h1><!-- doxytag: class="OGRSurface" --><!-- doxytag: inherits="OGRGeometry" -->
<p><code>#include <<a class="el" href="ogr__geometry_8h_source.html">ogr_geometry.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for OGRSurface:</div>
<div class="dynsection">
<div class="center">
<img src="classOGRSurface.png" usemap="#OGRSurface_map" alt=""/>
<map id="OGRSurface_map" name="OGRSurface_map">
<area href="classOGRGeometry.html" alt="OGRGeometry" shape="rect" coords="0,0,93,24"/>
<area href="classOGRPolygon.html" alt="OGRPolygon" shape="rect" coords="0,112,93,136"/>
</map>
</div>
</div>
<p><a href="classOGRSurface-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRSurface.html#a3b2c3125ec8c0b3a986e43cd1056f9e4">get_Area</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRSurface.html#a3f662a2a483477b83224e02be6fde080">Centroid</a> (<a class="el" href="classOGRPoint.html">OGRPoint</a> *poPoint) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRSurface.html#a1d28c548d1ceba9841597c5a37356226">PointOnSurface</a> (<a class="el" href="classOGRPoint.html">OGRPoint</a> *poPoint) const =0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Abstract base class for 2 dimensional objects like polygons. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3f662a2a483477b83224e02be6fde080"></a><!-- doxytag: member="OGRSurface::Centroid" ref="a3f662a2a483477b83224e02be6fde080" args="(OGRPoint *poPoint) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OGRErr OGRSurface::Centroid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOGRPoint.html">OGRPoint</a> * </td>
<td class="paramname"> <em>poPoint</em></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compute and return centroid of surface. The centroid is not necessarily within the geometry.</p>
<p>This method relates to the SFCOM ISurface::get_Centroid() method.</p>
<p>NOTE: Only implemented when GEOS included in build.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>poPoint</em> </td><td>point to be set with the centroid location.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>OGRERR_NONE if it succeeds or OGRERR_FAILURE otherwise. </dd></dl>
<p>Implemented in <a class="el" href="classOGRPolygon.html#ad12bc18f6f0f7c0209c26f5e4cd9eadc">OGRPolygon</a>.</p>
</div>
</div>
<a class="anchor" id="a3b2c3125ec8c0b3a986e43cd1056f9e4"></a><!-- doxytag: member="OGRSurface::get_Area" ref="a3b2c3125ec8c0b3a986e43cd1056f9e4" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double OGRSurface::get_Area </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the area of the surface object.</p>
<p>For polygons the area is computed as the area of the outer ring less the area of all internal rings.</p>
<p>This method relates to the SFCOM ISurface::get_Area() method.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the area of the feature in square units of the spatial reference system in use. </dd></dl>
<p>Implemented in <a class="el" href="classOGRPolygon.html#ad8ba9b796aafc593f5bd7bcf1086bc3d">OGRPolygon</a>.</p>
</div>
</div>
<a class="anchor" id="a1d28c548d1ceba9841597c5a37356226"></a><!-- doxytag: member="OGRSurface::PointOnSurface" ref="a1d28c548d1ceba9841597c5a37356226" args="(OGRPoint *poPoint) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OGRErr OGRSurface::PointOnSurface </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOGRPoint.html">OGRPoint</a> * </td>
<td class="paramname"> <em>poPoint</em></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method relates to the SFCOM ISurface::get_PointOnSurface() method.</p>
<p>NOTE: Only implemented when GEOS included in build.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>poPoint</em> </td><td>point to be set with an internal point.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>OGRERR_NONE if it succeeds or OGRERR_FAILURE otherwise. </dd></dl>
<p>Implemented in <a class="el" href="classOGRPolygon.html#a76e64f21cd31a6256cc425a6b5639069">OGRPolygon</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ogr__geometry_8h_source.html">ogr_geometry.h</a></li>
<li>ogrsurface.cpp</li>
</ul>
</div>
<hr>
Generated for GDAL by
<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.6.2-20100208.
</body>
</html>
