com.esri.arcgis.datasourcesraster
Interface IClipFilter

All Superinterfaces:
Serializable
All Known Subinterfaces:
IClipFilter2
All Known Implementing Classes:
ClipFilter

public interface IClipFilter
extends Serializable

Provides access to members that control a clipping filter.

Superseded By

IClipFilter2

Description

This interface is new at ArcGIS 9.3.

Remarks

IClipFilter is used to construct, from given geometries such as polygons, a ClipFilter class which can be used to clip a Raster using IPixelOperation iterface.

Product Availability

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

See Also:
IPixelOperation

Method Summary
 void add(IGeometry pClippingGeometry)
          Adds a clipping geometry.
 void empty()
          Removes all clipping geometries.
 

Method Detail

add

void add(IGeometry pClippingGeometry)
         throws IOException,
                AutomationException
Adds a clipping geometry.

Remarks

Use Add method to create a ClipFilter from multiple geometries, the ClipFilter will take the union of all the gemetries.

Product Availability

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

Parameters:
pClippingGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

void empty()
           throws IOException,
                  AutomationException
Removes all clipping geometries.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.