com.esri.arcgis.geodatabase
Interface esriSpatialRelEnum

All Superinterfaces:

Serializable

public interface esriSpatialRelEnum
extends Serializable

Queryable Spatial Relationships.

Description

The esriSpatialRelEnum enumeration defines the common types of spatial relationships.

Remarks

esriSpatialRelUndefined

Used when the spatial relationship is not known at the time of object creation.

esriSpatialRelIntersects

Returns a feature if any spatial relationship is found. Applies to all shape type combinations.

esriSpatialRelEnvelopeIntersects

Returns a feature if the envelope of the two shapes intersects.

esriSpatialRelIndexIntersects

Returns a feature if the envelope of the query geometry intersects the index entry for the target geometry. Because it uses the underlying index grid, rather than the evelope of the feature, it is faster and is commonly used for return features for display purposes.

esriSpatialRelTouches

Returns a feature if the two shapes share a common boundary. However, the intersection of the interiors of the two shapes must be empty. In the Point/Line case, the point may touch an endpoint only of the line. Applies to all combinations except Point/Point.

esriSpatialRelOverlaps

Returns a feature if the intersection of the two shapes results in an object of the same dimension, but different from both of the shapes. Applies to Area/Area, Line/Line, and Multi-point/Multi-point shape type combinations.

esriSpatialRelCrosses

Returns a feature if the intersection of the interiors of the two shapes is not empty and has a lower dimension than the maximum dimension of the two shapes. Two lines that share an endpoint in common do not cross. Valid for Line/Line, Line/Area, Multi-point/Area, and Multi-point/Line shape type combinations.

esriSpatialRelWithin

Returns a feature if its shape wholly contains the search geometry. Valid for all shape type combinations.

esriSpatialRelContains

Returns a feature if its shape is wholly contained within the search geometry. Valid for all shape type combinations.

esriSpatialRelRelation

This is the expected value for ISpatialFilter::SpatialRel when using ISpatialFilter::SpatialRelDescription to define a custom spatial relationship. See the help on ISpatialFilter for details.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

ISpatialFilter, esriSpatialRelEnum

Field Summary

static int	esriSpatialRelContains Query Geometry Contains Target Geometry.
static int	esriSpatialRelCrosses Query Geometry Crosses Target Geometry.
static int	esriSpatialRelEnvelopeIntersects Envelope of Query Geometry Intersects Envelope of Target Geometry.
static int	esriSpatialRelIndexIntersects Query Geometry Intersects Index entry for Target Geometry (Primary Index Filter).
static int	esriSpatialRelIntersects Query Geometry Intersects Target Geometry.
static int	esriSpatialRelOverlaps Query Geometry Overlaps Target Geometry.
static int	esriSpatialRelRelation Query geometry IBE(Interior-Boundary-Exterior) relationship with target geometry.
static int	esriSpatialRelTouches Query Geometry Touches Target Geometry.
static int	esriSpatialRelUndefined No Defined Spatial Relationship.
static int	esriSpatialRelWithin Query Geometry is Within Target Geometry.

Field Detail

esriSpatialRelUndefined

static final int esriSpatialRelUndefined

No Defined Spatial Relationship.

See Also:

Constant Field Values

esriSpatialRelIntersects

static final int esriSpatialRelIntersects

Query Geometry Intersects Target Geometry.

See Also:

Constant Field Values

esriSpatialRelEnvelopeIntersects

static final int esriSpatialRelEnvelopeIntersects

Envelope of Query Geometry Intersects Envelope of Target Geometry.

See Also:

Constant Field Values

esriSpatialRelIndexIntersects

static final int esriSpatialRelIndexIntersects

Query Geometry Intersects Index entry for Target Geometry (Primary Index Filter).

See Also:

Constant Field Values

esriSpatialRelTouches

static final int esriSpatialRelTouches

Query Geometry Touches Target Geometry.

See Also:

Constant Field Values

esriSpatialRelOverlaps

static final int esriSpatialRelOverlaps

Query Geometry Overlaps Target Geometry.

See Also:

Constant Field Values

esriSpatialRelCrosses

static final int esriSpatialRelCrosses

Query Geometry Crosses Target Geometry.

See Also:

Constant Field Values

esriSpatialRelWithin

static final int esriSpatialRelWithin

Query Geometry is Within Target Geometry.

See Also:

Constant Field Values

esriSpatialRelContains

static final int esriSpatialRelContains

Query Geometry Contains Target Geometry.

See Also:

Constant Field Values

esriSpatialRelRelation

static final int esriSpatialRelRelation

Query geometry IBE(Interior-Boundary-Exterior) relationship with target geometry.

See Also:

Constant Field Values