[fdo-commits] r730 - branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Wed Feb 7 16:24:58 EST 2007
Author: gregboone
Date: 2007-02-07 16:24:58 -0500 (Wed, 07 Feb 2007)
New Revision: 730
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialGridTransform.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialUtility.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialGridTransform.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialGridTransform.h 2007-02-07 19:58:06 UTC (rev 729)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialGridTransform.h 2007-02-07 21:24:58 UTC (rev 730)
@@ -50,31 +50,25 @@
/// Input Floating-point X ordinate.
/// \param coordinateY
/// Input Floating-point Y ordinate.
- /// \param xGrid
+ /// \param gridX
/// Output Integer X ordinate.
- /// \param yGrid
+ /// \param gridY
/// Output Integer Y ordinate.
///
- /// \return
- /// Returns Nothing.
- ///
System::Void TransformToGrid(System::Double coordinateX, System::Double coordinateY, System::Int64* gridX, System::Int64* gridY);
/// \brief
/// Transform integer ordinates on the grid to floating-point ordinates.
///
+ /// \param gridX
+ /// Input Integer X ordinate.
+ /// \param gridY
+ /// Input Integer Y ordinate.
/// \param coordinateX
- /// Input Floating-point X ordinate.
+ /// Output Floating-point X ordinate.
/// \param coordinateY
- /// Input Floating-point Y ordinate.
- /// \param coordinateX
- /// Output Integer X ordinate.
- /// \param coordinateY
- /// Output Integer Y ordinate.
+ /// Output Floating-point Y ordinate.
///
- /// \return
- /// Returns Nothing.
- ///
System::Void TransformFromGrid(System::Int64 gridX, System::Int64 gridY, System::Double* coordinateX, System::Double* coordinateY);
/// \cond DOXYGEN-IGNORE
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialUtility.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialUtility.h 2007-02-07 19:58:06 UTC (rev 729)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialUtility.h 2007-02-07 21:24:58 UTC (rev 730)
@@ -74,12 +74,8 @@
///
/// \param geometry
/// Input Geometry to validate
- /// \param geometryTypesCount
- /// Input Number of elements in the array given by geometryTypes. If zero, no constraint is used.
/// \param geometryTypes
/// Input Array of allowed geometry types. NULL is valid if geometryTypesCount is zero.
- /// \param geometryComponentTypesCount
- /// Input Number of elements in the array given by geometryComponentTypes. If zero, no constraint is used.
/// \param geometryComponentTypes
/// Input Array of allowed geometry component types. NULL is valid if geometryComponentTypesCount is zero.
/// \param dimensionality
@@ -90,12 +86,67 @@
///
static NAMESPACE_OSGEO_SPATIAL::SpatialGeometryValidity ValidateGeometryByType(NAMESPACE_OSGEO_GEOMETRY::IGeometry * geometry, NAMESPACE_OSGEO_COMMON::GeometryType geometryTypes [], NAMESPACE_OSGEO_COMMON::GeometryComponentType geometryComponentTypes [], System::Int32 dimensionality);
+ /// \brief
+ /// Evaluates if two FDO geometric objects spatially interact with each other based on a user supplied spatial operator.
+ /// For example: Contains, Crosses, Disjoint, Equals, Intersects, Overlaps, Touches, Within, CoveredBy, Inside, EnvelopeIntersects.
+ ///
+ /// \param g1
+ /// Input Left hand Geometry to Evaluate
+ /// \param op
+ /// Input The spatial operation to apply to the left and right hand geometries
+ /// \param g2
+ /// Input Right hand Geometry to Evaluate
+ ///
+ /// \return
+ /// Returns The tesselated Geometry.
+ ///
static System::Boolean Evaluate(NAMESPACE_OSGEO_GEOMETRY::IGeometry * g1, NAMESPACE_OSGEO_FDO_FILTER::SpatialOperations op, NAMESPACE_OSGEO_GEOMETRY::IGeometry * g2);
+ /// \brief
+ /// Tesselates a curve geometry into a set of line strings that approximate the curve geometry.
+ ///
+ /// \param curve
+ /// Input Geometry to tesselate
+ ///
+ /// \return
+ /// Returns The tesselated Geometry.
+ ///
static NAMESPACE_OSGEO_GEOMETRY::IGeometry* TesselateCurve( NAMESPACE_OSGEO_GEOMETRY::IGeometry* curve);
+ /// \brief
+ /// Gets the extents of a geometry contained in a byte array.
+ ///
+ /// \param bytes
+ /// Input Geometry whose extents will be returned
+ /// \param minX
+ /// Output The minimim x position of the geometry
+ /// \param minY
+ /// Output The minimim y position of the geometry
+ /// \param maxX
+ /// Output The maximum x position of the geometry
+ /// \param maxY
+ /// Output The maximum y position of the geometry
+ ///
static System::Void GetExtents(System::Byte bytes [], System::Double* minX, System::Double* minY, System::Double* maxX, System::Double* maxY);
+ /// \brief
+ /// Gets the extents of a geometry contained in a byte array.
+ ///
+ /// \param bytes
+ /// Input Geometry whose extents will be returned
+ /// \param minX
+ /// Output The minimim x position of the geometry
+ /// \param minY
+ /// Output The minimim y position of the geometry
+ /// \param minZ
+ /// Output The minimim z position of the geometry
+ /// \param maxX
+ /// Output The maximum x position of the geometry
+ /// \param maxY
+ /// Output The maximum y position of the geometry
+ /// \param maxZ
+ /// Output The maximum z position of the geometry
+ ///
static System::Void GetExtents(System::Byte bytes [], System::Double* minX, System::Double* minY, System::Double* minZ, System::Double* maxX, System::Double* maxY, System::Double* maxZ);
/// \brief
@@ -107,14 +158,30 @@
/// Input X ordinate.
/// \param coordinateY
/// Input Y ordinate.
+ /// \param isOnBoundary
+ /// Output Specifies if the specified point is on the boundary of the ring.
///
/// \return
/// Returns TRUE if the point is within ring or on its boundary, FALSE otherwise.
///
static System::Boolean PointInRing( NAMESPACE_OSGEO_GEOMETRY::ILinearRing* ring, System::Double coordinateX, System::Double coordinateY, System::Boolean* isOnBoundary);
- static System::Boolean PointInRing( NAMESPACE_OSGEO_GEOMETRY::ILinearRing* ring, System::Double coordinateX, System::Double coordinateY);
/// \brief
+ /// Tests whether a point is within a ring or not.
+ ///
+ /// \param ring
+ /// Input Ring to test
+ /// \param coordinateX
+ /// Input X ordinate.
+ /// \param coordinateY
+ /// Input Y ordinate.
+ ///
+ /// \return
+ /// Returns TRUE if the point is within ring or on its boundary, FALSE otherwise.
+ ///
+ static System::Boolean PointInRing( NAMESPACE_OSGEO_GEOMETRY::ILinearRing* ring, System::Double coordinateX, System::Double coordinateY);
+
+ /// \brief
/// Tests whether a point is within a polygon (including its islands) or not.
///
/// \param polygon
@@ -123,18 +190,52 @@
/// Input X ordinate.
/// \param coordinateY
/// Input Y ordinate.
+ /// \param isOnExtBoundary
+ /// Output Specifies if the specified point is on the exterior boundary of the polygon.
+ /// \param isOnInBoundary
+ /// Output Specifies if the specified point is on the interior boundary of the polygon.
///
/// \return
/// Returns TRUE if the point is within polygon or on its boundary, FALSE otherwise.
///
static System::Boolean PointInPolygon(NAMESPACE_OSGEO_GEOMETRY::IPolygon* polygon, System::Double coordinateX, System::Double coordinateY, System::Boolean * isOnExtBoundary, System::Boolean * isOnInBoundary);
- static System::Boolean PointInPolygon(NAMESPACE_OSGEO_GEOMETRY::IPolygon* polygon, System::Double coordinateX, System::Double coordinateY, System::Boolean * isOnExtBoundary);
- static System::Boolean PointInPolygon(NAMESPACE_OSGEO_GEOMETRY::IPolygon* polygon, System::Double coordinateX, System::Double coordinateY);
/// \brief
+ /// Tests whether a point is within a polygon (including its islands) or not.
+ ///
+ /// \param polygon
+ /// Input Polygon to test
+ /// \param coordinateX
+ /// Input X ordinate.
+ /// \param coordinateY
+ /// Input Y ordinate.
+ /// \param isOnExtBoundary
+ /// Output Specifies if the specified point is on the exterior boundary of the polygon.
+ ///
+ /// \return
+ /// Returns TRUE if the point is within polygon or on its boundary, FALSE otherwise.
+ ///
+ static System::Boolean PointInPolygon(NAMESPACE_OSGEO_GEOMETRY::IPolygon* polygon, System::Double coordinateX, System::Double coordinateY, System::Boolean * isOnExtBoundary);
+
+ /// \brief
+ /// Tests whether a point is within a polygon (including its islands) or not.
+ ///
+ /// \param polygon
+ /// Input Polygon to test
+ /// \param coordinateX
+ /// Input X ordinate.
+ /// \param coordinateY
+ /// Input Y ordinate.
+ ///
+ /// \return
+ /// Returns TRUE if the point is within polygon or on its boundary, FALSE otherwise.
+ ///
+ static System::Boolean PointInPolygon(NAMESPACE_OSGEO_GEOMETRY::IPolygon* polygon, System::Double coordinateX, System::Double coordinateY);
+
+ /// \brief
/// Computes the area of a ring.
///
- /// \param poly
+ /// \param ring
/// Input Ring to test
///
/// \return
@@ -146,7 +247,7 @@
/// \brief
/// Computes the length (perimeter) of a ring.
///
- /// \param poly
+ /// \param ring
/// Input Ring to test
///
/// \return
More information about the fdo-commits
mailing list