OGR: OGRSurface Class Reference

# OGRSurface Class Reference

`#include <ogr_geometry.h>`

Inheritance diagram for OGRSurface:

List of all members.

## Public Member Functions
virtual double | get_Area () const =0
virtual OGRErr | Centroid (OGRPoint *poPoint) const =0
virtual OGRErr | PointOnSurface (OGRPoint *poPoint) const =0

## Detailed Description

Abstract base class for 2 dimensional objects like polygons.

## Member Function Documentation

OGRErr OGRSurface::Centroid | ( | OGRPoint * | poPoint | ) | const`[pure virtual]`

Compute and return centroid of surface. The centroid is not necessarily within the geometry.

This method relates to the SFCOM ISurface::get_Centroid() method.

NOTE: Only implemented when GEOS included in build.

Parameters:

  | poPoint | point to be set with the centroid location.

Returns:
  OGRERR_NONE if it succeeds or OGRERR_FAILURE otherwise.

Implemented in OGRPolygon.

double OGRSurface::get_Area | ( |  | ) | const`[pure virtual]`

Get the area of the surface object.

For polygons the area is computed as the area of the outer ring less the area of all internal rings.

This method relates to the SFCOM ISurface::get_Area() method.

Returns:
  the area of the feature in square units of the spatial reference system in use.

Implemented in OGRPolygon.

OGRErr OGRSurface::PointOnSurface | ( | OGRPoint * | poPoint | ) | const`[pure virtual]`

This method relates to the SFCOM ISurface::get_PointOnSurface() method.

NOTE: Only implemented when GEOS included in build.

Parameters:

  | poPoint | point to be set with an internal point.

Returns:
  OGRERR_NONE if it succeeds or OGRERR_FAILURE otherwise.

Implemented in OGRPolygon.

The documentation for this class was generated from the following files:

- ogr_geometry.h
- ogrsurface.cpp

Generated for GDAL by 1.5.9.