This document is archived and information here might be outdated.  Recommended version.


IDynamicSurface3.CreateBlockCursor Method (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (GeoDatabaseExtensions)  

IDynamicSurface3.CreateBlockCursor Method

Create terrain block cursor.

[Visual Basic .NET]
Public Sub CreateBlockCursor ( _
    ByVal pAOI As IGeometry, _
    ByVal Resolution As Double, _
    ByVal bSingleTileOnly As Boolean, _
    ByVal pTrackCancel As ITrackCancel, _
    ByRef pCursor As ITerrainBlockCursor _
)
[C#]
public void CreateBlockCursor (
    IGeometry pAOI,
    double Resolution,
    bool bSingleTileOnly,
    ITrackCancel pTrackCancel,
    ref ITerrainBlockCursor pCursor
);
[C++]
HRESULT CreateBlockCursor(
  IGeometry* pAOI,
  double Resolution,
  VARIANT_BOOL bSingleTileOnly,
  ITrackCancel* pTrackCancel,
  ITerrainBlockCursor** pCursor
);
[C++]

Parameters pAOI [in]
pAOI is a parameter of type IGeometry* Resolution [in]
Resolution is a parameter of type double bSingleTileOnly [in]
bSingleTileOnly is a parameter of type bool pTrackCancel [in]
pTrackCancel is a parameter of type ITrackCancel* pCursor [out]
pCursor is a parameter of type ITerrainBlockCursor**

Product Availability

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

Description

Creates a terrain block cursor based on the desired area of intereset (AOI) and pyramid resolution.

pAOI represents the area that needs to be included in the cursors process. It can be an envelope, polygon, or NULL. If NULL, the full extent of the terrain will be used.

Resolution specifies which pyramid level to use when generating blocks.

bSingleTileOnly controls whether blocks are strictly defined only from individual tiles (one tile, one block) or if they can be aggregates, made from multiple tiles. Usually, blocks are aggregates, comprised of multiple tiles. Generally, aggregation is more efficient and should be used but some applications may require strict tile based granularity of blocks. If that's the case, set this to TRUE. A value of FALSE means blocks are allowed to be aggregated. This does not guarantee they will be but can be depending on several variables (i.e., value of MinimizeResourceUsage, availability of memory, amount of data in tiles under consideration for aggregation).

pTrackCancel is a reference to a CancelTracker to support progress reporting and the ability to halt the process. To bypass this feature pass a NULL pointer.

pCursor is the returned TerrainBlockCursor.

 

Notes:


This method honors setting for MinimizeResourceUsage. If MinimizeResourceUsage is TRUE, then each block will be a single tile regardless of the setting for bSingleTileOnly.

See Also

IDynamicSurface3 Interface