Interface IPixelBlockCursor

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll

Provides access to members that control pixel block cursor.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("54DFC56A-BC14-46AC-A815-07DEA8CB9CFB")]
public interface IPixelBlockCursor

Remarks

This is a legacy interface since ArcGIS 9.2. Please use IRaster2.CreateCursorEx and IRasterCursor.

The IPixelBlockCursor interface controls iteration through the pixel blocks of a Raster and a RasterBand.

The InitByRawPixels method initializes a PixelBlock from a RasterBand by specifying the pixel block size.

The InitByRaster method initializes the PixelBlock from a Raster. The size of the PixelBlock is determined automatically when creating from a Raster.

GetBlockSize returns the size of the current pixel block.

NextBlock retrieves the next pixel block, the location of upper-left corner of the pixel block in pixel space, and size of the pixel block.

The ScanMode, a write-only property, specifies the pixel block scan mode. The default is line mode. If you wish to change the scan mode, this property must be set immediately after initializing pixel block (calling InitByRawPixels or InitByRaster). The supported 4 scan modes are Line, LineSerpent, Serpent, and alaGIF, with values 0, 1, 3, and 4 respectively.

The UpdateBlockSize method changes the pixel block size for retrieving the next pixel block. This should be used only when reading pixel block from a Raster.

When iterating through the pixel blocks in a RasterBand, you must specify the size of the pixel block at the time of initiating it. After initiation, the size of the pixel block is fixed. When iterating through the pixel blocks in a Raster, the size of the pixel block is determined automatically at the time of initiation. You can modify it later on.

 

Properties

ScanMode

The cursor scan mode: Line = 0, LineSerpent = 1, Serpent2 = 3, alaGIF = 4.

int ScanMode { set; }

Property Value

int

Remarks

The supported 4 scan modes are Line, LineSerpent, Serpent, and alaGIF, with value 0,1,3, and 4 respectively. The default is line mode.

If you wish to change the scan mode, this property must be set immedietly after initializing the pixel block (calling InitByRawPixels or InitByRaster).

Methods

GetBlockSize(ref int, ref int)

Gets the cursor block size.

void GetBlockSize(ref int pBlockSizeX, ref int pBlockSizeY)

Parameters

pBlockSizeX int
pBlockSizeY int

InitByRaster(IRaster)

Initializes the cursor by the raster interface.

void InitByRaster(IRaster pRaster)

Parameters

pRaster IRaster

InitByRawPixels(IRawPixels, int, int)

Initializes the cursor by the raw pixel interface.

void InitByRawPixels(IRawPixels pRowPixels, int BlockSizeX, int BlockSizeY)

Parameters

pRowPixels IRawPixels
BlockSizeX int
BlockSizeY int

NextBlock(ref int, ref int, ref int, ref int)

Obtains the next pixel block from the cursor.

IPixelBlock NextBlock(ref int pLeft, ref int pTop, ref int pSizeX, ref int pSizeY)

Parameters

pLeft int
pTop int
pSizeX int
pSizeY int

Returns

IPixelBlock

UpdateBlockSize(int, int)

Updates the cursor block size.

void UpdateBlockSize(int BlockSizeX, int BlockSizeY)

Parameters

BlockSizeX int
BlockSizeY int

Remarks

This should be used only when reading a PixelBlock from a Raster.