com.esri.arcgis.carto
Interface IRasterSpatialSelection

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterLayer

public interface IRasterSpatialSelection
extends Serializable

Provides access to members that control the behavior of the spatial selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void drawSpatialSelection(IDisplay pDisplay, ITrackCancel pTrackCancel)
          Draws the current spatial selection.
 IRasterDataset getMaskRasterDataset()
          Reference to the current selection dataset.
 void init(boolean bInit, String fileFullName, int fileFormat)
          Create or remove the selection dataset.
 void maskDrawPolyRect(ITrackCancel trackCancel, Object vRects, int op)
          Perform the mask operation with the given array of rectangles.
 void maskReadBitmap(ITrackCancel trackCancel, tagRECT pRect, Object vBytes, boolean byBits)
          Read pixels from selection.
 void maskWriteBitmap(ITrackCancel trackCancel, tagRECT pRect, int op, Object vBytes, boolean byBits)
          Perform the mask operation with bitmask.
 void setMaskRasterDatasetByRef(IRasterDataset ppRasterDataset)
          Reference to the current selection dataset.
 

Method Detail

init

void init(boolean bInit,
          String fileFullName,
          int fileFormat)
          throws IOException,
                 AutomationException
Create or remove the selection dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
bInit - The bInit (in)
fileFullName - The fileFullName (in, optional, pass 0 if not required)
fileFormat - A com.esri.arcgis.carto.esriRasterSelectionMaskFileFormat constant (in, optional, pass 1 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawSpatialSelection

void drawSpatialSelection(IDisplay pDisplay,
                          ITrackCancel pTrackCancel)
                          throws IOException,
                                 AutomationException
Draws the current spatial selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskRasterDataset

IRasterDataset getMaskRasterDataset()
                                    throws IOException,
                                           AutomationException
Reference to the current selection dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskRasterDatasetByRef

void setMaskRasterDatasetByRef(IRasterDataset ppRasterDataset)
                               throws IOException,
                                      AutomationException
Reference to the current selection dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

maskWriteBitmap

void maskWriteBitmap(ITrackCancel trackCancel,
                     tagRECT pRect,
                     int op,
                     Object vBytes,
                     boolean byBits)
                     throws IOException,
                            AutomationException
Perform the mask operation with bitmask.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
pRect - A Structure: com.esri.arcgis.display.tagRECT (in)
op - A com.esri.arcgis.carto.esriRasterSelectionMaskOp constant (in)
vBytes - A Variant (in)
byBits - The byBits (in, optional, pass false if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

maskReadBitmap

void maskReadBitmap(ITrackCancel trackCancel,
                    tagRECT pRect,
                    Object vBytes,
                    boolean byBits)
                    throws IOException,
                           AutomationException
Read pixels from selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
pRect - A Structure: com.esri.arcgis.display.tagRECT (in)
vBytes - A Variant (in)
byBits - The byBits (in, optional, pass false if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

maskDrawPolyRect

void maskDrawPolyRect(ITrackCancel trackCancel,
                      Object vRects,
                      int op)
                      throws IOException,
                             AutomationException
Perform the mask operation with the given array of rectangles.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
vRects - A Variant (in)
op - A com.esri.arcgis.carto.esriRasterSelectionMaskOp constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.