FDO API Reference Feature Data Objects

SpatialOperations.h

Go to the documentation of this file.
00001 #ifndef _SPATIALOPERATIONS_H_
00002 #define _SPATIALOPERATIONS_H_
00003 // 
00004 
00005 //
00006 // Copyright (C) 2004-2006  Autodesk, Inc.
00007 // 
00008 // This library is free software; you can redistribute it and/or
00009 // modify it under the terms of version 2.1 of the GNU Lesser
00010 // General Public License as published by the Free Software Foundation.
00011 // 
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015 // Lesser General Public License for more details.
00016 // 
00017 // You should have received a copy of the GNU Lesser General Public
00018 // License along with this library; if not, write to the Free Software
00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 //
00021 
00022 #ifdef _WIN32
00023 #pragma once
00024 #endif
00025 
00026 /// \brief
00027 /// The FdoSpatialOperations enumeration lists the spatial conditions available.
00028 /// <param name="FdoSpatialOperations_Contains">
00029 /// Test to see if the geometric property value spatially contains the
00030 /// literal geometric value
00031 /// </param>
00032 /// <param name="FdoSpatialOperations_Crosses">
00033 /// Test to see if the geometric property value spatially crosses the given
00034 /// geometry
00035 /// </param>
00036 /// <param name="FdoSpatialOperations_Disjoint">
00037 /// Test to see if the geometric property value spatially is spatially
00038 /// disjoint from the given geometry
00039 /// </param>
00040 /// <param name="FdoSpatialOperations_Equals">
00041 /// Test to see if the geometric property value is spatially equal to the
00042 /// given geometry
00043 /// </param>
00044 /// <param name="FdoSpatialOperations_Intersects">
00045 /// Test to see if the geometric property value spatially intersects the
00046 /// given geometry
00047 /// </param>
00048 /// <param name="FdoSpatialOperations_Overlaps">
00049 /// Test to see if the geometric property value spatially overlaps the given
00050 /// geometry
00051 /// </param>
00052 /// <param name="FdoSpatialOperations_Touches">
00053 /// Test to see if the geometric property value spatially touches the given
00054 /// geometry
00055 /// </param>
00056 /// <param name="FdoSpatialOperations_Within">
00057 /// Test to see if the geometric property value is spatially within the
00058 /// given geometry
00059 /// </param>
00060 /// <param name="FdoSpatialOperations_CoveredBy">
00061 /// Test to see if the geometric property value is covered by the interior
00062 /// and boundary of the given geometry
00063 /// </param>
00064 /// <param name="FdoSpatialOperations_Inside">
00065 /// Test to see if the geometric property value is inside the interior
00066 /// of the given geometry, not touching the boundary
00067 /// </param>
00068 /// <param name="FdoSpatialOperations_EnvelopeIntersects">
00069 /// Test to see if the envelope of the referenced geometric property value intersects the
00070 /// given geometry
00071 /// </param>
00072 enum FdoSpatialOperations
00073 {
00074     /// Test to see if the geometric property value spatially contains the
00075     /// literal geometric value.
00076     FdoSpatialOperations_Contains,
00077 
00078     /// Test to see if the geometric property value spatially crosses the given
00079     /// geometry.
00080     FdoSpatialOperations_Crosses,
00081 
00082     /// Test to see if the geometric property value spatially is spatially
00083     /// disjoint from the given geometry.
00084     FdoSpatialOperations_Disjoint,
00085 
00086     /// Test to see if the geometric property value is spatially equal to the
00087     /// given geometry.
00088     FdoSpatialOperations_Equals,
00089 
00090     /// Test to see if the geometric property value spatially intersects the
00091     /// given geometry.
00092     FdoSpatialOperations_Intersects,
00093 
00094     /// Test to see if the geometric property value spatially overlaps the given
00095     /// geometry.
00096     FdoSpatialOperations_Overlaps,
00097 
00098     /// Test to see if the geometric property value spatially touches the given
00099     /// geometry.
00100     FdoSpatialOperations_Touches,
00101 
00102     /// Test to see if the geometric property value is spatially within the
00103     /// given geometry.
00104     FdoSpatialOperations_Within,
00105 
00106     /// Test to see if the geometric property value is covered by the interior
00107     /// and boundary of the given geometry.
00108     FdoSpatialOperations_CoveredBy,
00109 
00110     /// Test to see if the geometric property value is inside the interior
00111     /// of the given geometry, not touching the boundary.
00112     FdoSpatialOperations_Inside,
00113 
00114     /// Test to see if the envelope of the referenced geometric property value spatially intersects the
00115     /// given geometry.
00116     FdoSpatialOperations_EnvelopeIntersects
00117 
00118 };
00119 
00120 
00121 #endif
00122 
00123 

Comments or suggestions? Send us feedback.