com.esri.arcgis.carto
Interface ITerrainLayer

All Superinterfaces:
ILayer, Serializable
All Known Implementing Classes:
TerrainLayer

public interface ITerrainLayer
extends ILayer, Serializable

Provides access to members that control a Terrain layer.

Product Availability

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


Method Summary
 void addRenderer(ITinRenderer pRenderer)
          Add a renderer to the end of the group.
 void clearRenderers()
          Remove all the renderers from the group.
 void deleteRenderer(ITinRenderer pRenderer)
          Remove a renderer from the group.
 double getAnalysisToolsResolution()
          Indicates the resolution that analysis tools will be enabled.
 double getCurrentResolution()
          Indicates the current resolution.
 ISurface getCurrentSurface()
          Gets current surface.
 String getDisplayField()
          The primary display field.
 int getPointBudget()
          Indicates the Point Budget.
 ITinRenderer getRenderer(int index)
          Gets the nth renderer.
 int getRendererCount()
          The number of renderers.
 double getTargetResolution()
          Indicates the resolution to be used when AutoLOR is false.
 ITerrain getTerrain()
          The Terrain used to define the layer.
 void insertRenderer(ITinRenderer pRenderer, int index)
          Insert a renderer at given index.
 boolean isAutoLOR()
          Indicates if LOR should be updated when scale changed.
 boolean isLockCurrentSurface()
          Indicates if current surface should be updated based on scale change.
 boolean isPyramidHonored()
          Indicates if current surface resolution honors the scale/resolution relationship in the pyramin definition.
 boolean isScaleSymbols()
          Indicates if symbols are scaled for this layer.
 boolean isShowResolution()
          Indicates if TOC should display resolution.
 boolean isUseOverviewTerrain()
          Indicates if Overview Terrain should be used when zoom to full.
 boolean isUsePointBudget()
          Indicates if Point Budget should be used for rendering performance.
 void setAnalysisToolsResolution(double pAnalysisResolution)
          Indicates the resolution that analysis tools will be enabled.
 void setAutoLOR(boolean pbAutoLOR)
          Indicates if LOR should be updated when scale changed.
 void setDisplayField(String pFieldName)
          The primary display field.
 void setLockCurrentSurface(boolean pbLock)
          Indicates if current surface should be updated based on scale change.
 void setPointBudget(int pPointBudget)
          Indicates the Point Budget.
 void setScaleSymbols(boolean pbScale)
          Indicates if symbols are scaled for this layer.
 void setShowResolution(boolean pbShow)
          Indicates if TOC should display resolution.
 void setTargetResolution(double pResolution)
          Indicates the resolution to be used when AutoLOR is false.
 void setTerrainByRef(ITerrain ppTerrain)
          The Terrain used to define the layer.
 void setUseOverviewTerrain(boolean pbUseOverviewTerrain)
          Indicates if Overview Terrain should be used when zoom to full.
 void setUsePointBudget(boolean pbUsePointBudget)
          Indicates if Point Budget should be used for rendering performance.
 
Methods inherited from interface com.esri.arcgis.carto.ILayer
draw, getAreaOfInterest, getMaximumScale, getMinimumScale, getName, getSupportedDrawPhases, getTipText, isCached, isShowTips, isValid, isVisible, setCached, setMaximumScale, setMinimumScale, setName, setShowTips, setSpatialReferenceByRef, setVisible
 

Method Detail

getTerrain

ITerrain getTerrain()
                    throws IOException,
                           AutomationException
The Terrain used to define the layer.

Product Availability

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

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

setTerrainByRef

void setTerrainByRef(ITerrain ppTerrain)
                     throws IOException,
                            AutomationException
The Terrain used to define the layer.

Product Availability

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

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

getCurrentSurface

ISurface getCurrentSurface()
                           throws IOException,
                                  AutomationException
Gets current surface.

Description

GetCurrentSurface may return a NULL pointer ('Nothing' in VB). For example, it will return NULL if ITerrain.IsValid is FALSE. Therefore, check the return value before attempting to use it.

Product Availability

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

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

getRendererCount

int getRendererCount()
                     throws IOException,
                            AutomationException
The number of renderers.

Product Availability

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

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

getRenderer

ITinRenderer getRenderer(int index)
                         throws IOException,
                                AutomationException
Gets the nth renderer.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ITinRenderer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addRenderer

void addRenderer(ITinRenderer pRenderer)
                 throws IOException,
                        AutomationException
Add a renderer to the end of the group.

Product Availability

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

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

insertRenderer

void insertRenderer(ITinRenderer pRenderer,
                    int index)
                    throws IOException,
                           AutomationException
Insert a renderer at given index.

Product Availability

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

Parameters:
pRenderer - A reference to a com.esri.arcgis.carto.ITinRenderer (in)
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteRenderer

void deleteRenderer(ITinRenderer pRenderer)
                    throws IOException,
                           AutomationException
Remove a renderer from the group.

Product Availability

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

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

clearRenderers

void clearRenderers()
                    throws IOException,
                           AutomationException
Remove all the renderers from the group.

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.

getDisplayField

String getDisplayField()
                       throws IOException,
                              AutomationException
The primary display field.

Product Availability

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

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

setDisplayField

void setDisplayField(String pFieldName)
                     throws IOException,
                            AutomationException
The primary display field.

Product Availability

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

Parameters:
pFieldName - The pFieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

boolean isScaleSymbols()
                       throws IOException,
                              AutomationException
Indicates if symbols are scaled for this layer.

Product Availability

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

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

setScaleSymbols

void setScaleSymbols(boolean pbScale)
                     throws IOException,
                            AutomationException
Indicates if symbols are scaled for this layer.

Product Availability

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

Parameters:
pbScale - The pbScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseOverviewTerrain

boolean isUseOverviewTerrain()
                             throws IOException,
                                    AutomationException
Indicates if Overview Terrain should be used when zoom to full.

Product Availability

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

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

setUseOverviewTerrain

void setUseOverviewTerrain(boolean pbUseOverviewTerrain)
                           throws IOException,
                                  AutomationException
Indicates if Overview Terrain should be used when zoom to full.

Product Availability

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

Parameters:
pbUseOverviewTerrain - The pbUseOverviewTerrain (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAutoLOR

boolean isAutoLOR()
                  throws IOException,
                         AutomationException
Indicates if LOR should be updated when scale changed.

Product Availability

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

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

setAutoLOR

void setAutoLOR(boolean pbAutoLOR)
                throws IOException,
                       AutomationException
Indicates if LOR should be updated when scale changed.

Product Availability

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

Parameters:
pbAutoLOR - The pbAutoLOR (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPyramidHonored

boolean isPyramidHonored()
                         throws IOException,
                                AutomationException
Indicates if current surface resolution honors the scale/resolution relationship in the pyramin definition.

Product Availability

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

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

getTargetResolution

double getTargetResolution()
                           throws IOException,
                                  AutomationException
Indicates the resolution to be used when AutoLOR is false.

Product Availability

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

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

setTargetResolution

void setTargetResolution(double pResolution)
                         throws IOException,
                                AutomationException
Indicates the resolution to be used when AutoLOR is false.

Product Availability

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

Parameters:
pResolution - The pResolution (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentResolution

double getCurrentResolution()
                            throws IOException,
                                   AutomationException
Indicates the current resolution.

Product Availability

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

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

isShowResolution

boolean isShowResolution()
                         throws IOException,
                                AutomationException
Indicates if TOC should display resolution.

Product Availability

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

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

setShowResolution

void setShowResolution(boolean pbShow)
                       throws IOException,
                              AutomationException
Indicates if TOC should display resolution.

Product Availability

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

Parameters:
pbShow - The pbShow (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLockCurrentSurface

boolean isLockCurrentSurface()
                             throws IOException,
                                    AutomationException
Indicates if current surface should be updated based on scale change.

Product Availability

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

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

setLockCurrentSurface

void setLockCurrentSurface(boolean pbLock)
                           throws IOException,
                                  AutomationException
Indicates if current surface should be updated based on scale change.

Product Availability

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

Parameters:
pbLock - The pbLock (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsePointBudget

boolean isUsePointBudget()
                         throws IOException,
                                AutomationException
Indicates if Point Budget should be used for rendering performance.

Product Availability

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

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

setUsePointBudget

void setUsePointBudget(boolean pbUsePointBudget)
                       throws IOException,
                              AutomationException
Indicates if Point Budget should be used for rendering performance.

Product Availability

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

Parameters:
pbUsePointBudget - The pbUsePointBudget (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPointBudget

int getPointBudget()
                   throws IOException,
                          AutomationException
Indicates the Point Budget.

Product Availability

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

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

setPointBudget

void setPointBudget(int pPointBudget)
                    throws IOException,
                           AutomationException
Indicates the Point Budget.

Product Availability

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

Parameters:
pPointBudget - The pPointBudget (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnalysisToolsResolution

double getAnalysisToolsResolution()
                                  throws IOException,
                                         AutomationException
Indicates the resolution that analysis tools will be enabled.

Product Availability

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

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

setAnalysisToolsResolution

void setAnalysisToolsResolution(double pAnalysisResolution)
                                throws IOException,
                                       AutomationException
Indicates the resolution that analysis tools will be enabled.

Product Availability

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

Parameters:
pAnalysisResolution - The pAnalysisResolution (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.