com.esri.arcgis.geodatabaseextensions
Class ITerrainBlockCursorProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabaseextensions.ITerrainBlockCursorProxy
All Implemented Interfaces:
ITerrainBlockCursor, Externalizable, Serializable

public class ITerrainBlockCursorProxy
extends com.esri.arcgis.interop.Dispatch
implements ITerrainBlockCursor, Serializable

Provides access to TerrainBlockCursor object.

Product Availability

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

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  ITerrainBlockCursorProxy()
           
  ITerrainBlockCursorProxy(Object obj)
           
protected ITerrainBlockCursorProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 int getBlockCount()
          The number of blocks in the cursor.
 void next(int[] pRowBegin, int[] pRowEnd, int[] pColBegin, int[] pColEnd, boolean[] pbIsEnd)
          Returns next block in the form of rows and columns.
 void nextAsTin(ITin[] ppTin, IEnvelope[] ppExtent)
          Returns next block as a reference to a TIN object.
 void removeListener(String iidStr, Object theListener)
           
 void reset()
          Resets the cursor to point to the first block.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

ITerrainBlockCursorProxy

public ITerrainBlockCursorProxy()

ITerrainBlockCursorProxy

public ITerrainBlockCursorProxy(Object obj)
                         throws IOException
Throws:
IOException

ITerrainBlockCursorProxy

protected ITerrainBlockCursorProxy(Object obj,
                                   String iid)
                            throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getBlockCount

public int getBlockCount()
                  throws IOException,
                         AutomationException
The number of blocks in the cursor.

Description

The total number of blocks in the cursor. While this value is generally reliable it's possible for it to change in the event an overload condition is discovered for a block and it needs to be subdivided into multiple blocks. Therefore, it may be need to be checked each successive call to Next or NextAsTin if it's being used to track progress.

Product Availability

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

Specified by:
getBlockCount in interface ITerrainBlockCursor
Returns:
The pcBlocks
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

next

public void next(int[] pRowBegin,
                 int[] pRowEnd,
                 int[] pColBegin,
                 int[] pColEnd,
                 boolean[] pbIsEnd)
          throws IOException,
                 AutomationException
Returns next block in the form of rows and columns.

Description

Returns the row and column numbers of the terrain tiles associated with the next block. These can be passed to IDynamicSurface3.ConvertToExtent if getting the spatial extent of the block is desired.

bEnd is set to TRUE when there are no more blocks. Thus the row and column values are not to be used when bEnd is TRUE.

Product Availability

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

Specified by:
next in interface ITerrainBlockCursor
Parameters:
pRowBegin - The pRowBegin (out: use single element array)
pRowEnd - The pRowEnd (out: use single element array)
pColBegin - The pColBegin (out: use single element array)
pColEnd - The pColEnd (out: use single element array)
pbIsEnd - The pbIsEnd (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextAsTin

public void nextAsTin(ITin[] ppTin,
                      IEnvelope[] ppExtent)
               throws IOException,
                      AutomationException
Returns next block as a reference to a TIN object.

Description

Returns a TIN for the area represented by the next block in the cursor.

pTin is the output TIN for the next block. This will be returned NULL when there are no more blocks.

pExtent is an output envelope represeting the neatline, tile based, boundary for the block. The extent of the envelope may fall outside the data area of the TIN on the perimeter of the terrain where data does not fill the extent of the tiles. The extent of the envelope may fall within the data extent of the TIN for areas on the inside of the terrain. This is intentional and is designed to provide data overlap between neighboring blocks. This completes interpolation neighborhoods along block boundaries so that analytic results performed separately on the TINs for neighboring blocks match after being clipped by their respective block extents and merged.

Product Availability

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

Specified by:
nextAsTin in interface ITerrainBlockCursor
Parameters:
ppTin - A reference to a com.esri.arcgis.geodatabase.ITin (out: use single element array)
ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Resets the cursor to point to the first block.

Description

Returns the cursor to the initial block.

Product Availability

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

Specified by:
reset in interface ITerrainBlockCursor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.