com.esri.arcgis.carto
Interface ITerrainLayer

All Superinterfaces:

ILayer, java.io.Serializable

All Known Subinterfaces:

ITerrainLayer2

All Known Implementing Classes:

ITerrainLayer2Proxy, ITerrainLayerProxy, TerrainLayer

public interface ITerrainLayer
extends ILayer, java.io.Serializable

COM Interface 'ITerrainLayer'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control a Terrain layer.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID5a0f220d_614f_4c72_aff2_7ea0be2c8513
static int	xxDummy Deprecated. Internal use only

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.
java.lang.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(java.lang.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

Field Detail

IID5a0f220d_614f_4c72_aff2_7ea0be2c8513

static final int IID5a0f220d_614f_4c72_aff2_7ea0be2c8513

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getTerrain

ITerrain getTerrain()
                    throws java.io.IOException,
                           AutomationException

The Terrain used to define the layer.

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTerrainByRef

void setTerrainByRef(ITerrain ppTerrain)
                     throws java.io.IOException,
                            AutomationException

The Terrain used to define the layer.

Parameters:

ppTerrain - A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentSurface

ISurface getCurrentSurface()
                           throws java.io.IOException,
                                  AutomationException

Gets current surface.

Returns:

A reference to a com.esri.arcgis.geodatabase.ISurface

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRendererCount

int getRendererCount()
                     throws java.io.IOException,
                            AutomationException

The number of renderers.

Returns:

The pRendererCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

ITinRenderer getRenderer(int index)
                         throws java.io.IOException,
                                AutomationException

Gets the nth renderer.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.ITinRenderer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addRenderer

void addRenderer(ITinRenderer pRenderer)
                 throws java.io.IOException,
                        AutomationException

Add a renderer to the end of the group.

Parameters:

pRenderer - A reference to a com.esri.arcgis.carto.ITinRenderer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertRenderer

void insertRenderer(ITinRenderer pRenderer,
                    int index)
                    throws java.io.IOException,
                           AutomationException

Insert a renderer at given index.

Parameters:

pRenderer - A reference to a com.esri.arcgis.carto.ITinRenderer (in)

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteRenderer

void deleteRenderer(ITinRenderer pRenderer)
                    throws java.io.IOException,
                           AutomationException

Remove a renderer from the group.

Parameters:

pRenderer - A reference to a com.esri.arcgis.carto.ITinRenderer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearRenderers

void clearRenderers()
                    throws java.io.IOException,
                           AutomationException

Remove all the renderers from the group.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayField

java.lang.String getDisplayField()
                                 throws java.io.IOException,
                                        AutomationException

The primary display field.

Returns:

The pFieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayField

void setDisplayField(java.lang.String pFieldName)
                     throws java.io.IOException,
                            AutomationException

The primary display field.

Parameters:

pFieldName - The pFieldName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

boolean isScaleSymbols()
                       throws java.io.IOException,
                              AutomationException

Indicates if symbols are scaled for this layer.

Returns:

The pbScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

void setScaleSymbols(boolean pbScale)
                     throws java.io.IOException,
                            AutomationException

Indicates if symbols are scaled for this layer.

Parameters:

pbScale - The pbScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseOverviewTerrain

boolean isUseOverviewTerrain()
                             throws java.io.IOException,
                                    AutomationException

Indicates if Overview Terrain should be used when zoom to full.

Returns:

The pbUseOverviewTerrain

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseOverviewTerrain

void setUseOverviewTerrain(boolean pbUseOverviewTerrain)
                           throws java.io.IOException,
                                  AutomationException

Indicates if Overview Terrain should be used when zoom to full.

Parameters:

pbUseOverviewTerrain - The pbUseOverviewTerrain (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoLOR

boolean isAutoLOR()
                  throws java.io.IOException,
                         AutomationException

Indicates if LOR should be updated when scale changed.

Returns:

The pbAutoLOR

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoLOR

void setAutoLOR(boolean pbAutoLOR)
                throws java.io.IOException,
                       AutomationException

Indicates if LOR should be updated when scale changed.

Parameters:

pbAutoLOR - The pbAutoLOR (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPyramidHonored

boolean isPyramidHonored()
                         throws java.io.IOException,
                                AutomationException

Indicates if current surface resolution honors the scale/resolution relationship in the pyramin definition.

Returns:

The pbHonored

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetResolution

double getTargetResolution()
                           throws java.io.IOException,
                                  AutomationException

Indicates the resolution to be used when AutoLOR is false.

Returns:

The pResolution

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetResolution

void setTargetResolution(double pResolution)
                         throws java.io.IOException,
                                AutomationException

Indicates the resolution to be used when AutoLOR is false.

Parameters:

pResolution - The pResolution (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentResolution

double getCurrentResolution()
                            throws java.io.IOException,
                                   AutomationException

Indicates the current resolution.

Returns:

The pResolution

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowResolution

boolean isShowResolution()
                         throws java.io.IOException,
                                AutomationException

Indicates if TOC should display resolution.

Returns:

The pbShow

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowResolution

void setShowResolution(boolean pbShow)
                       throws java.io.IOException,
                              AutomationException

Indicates if TOC should display resolution.

Parameters:

pbShow - The pbShow (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLockCurrentSurface

boolean isLockCurrentSurface()
                             throws java.io.IOException,
                                    AutomationException

Indicates if current surface should be updated based on scale change.

Returns:

The pbLock

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLockCurrentSurface

void setLockCurrentSurface(boolean pbLock)
                           throws java.io.IOException,
                                  AutomationException

Indicates if current surface should be updated based on scale change.

Parameters:

pbLock - The pbLock (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsePointBudget

boolean isUsePointBudget()
                         throws java.io.IOException,
                                AutomationException

Indicates if Point Budget should be used for rendering performance.

Returns:

The pbUsePointBudget

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUsePointBudget

void setUsePointBudget(boolean pbUsePointBudget)
                       throws java.io.IOException,
                              AutomationException

Indicates if Point Budget should be used for rendering performance.

Parameters:

pbUsePointBudget - The pbUsePointBudget (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointBudget

int getPointBudget()
                   throws java.io.IOException,
                          AutomationException

Indicates the Point Budget.

Returns:

The pPointBudget

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointBudget

void setPointBudget(int pPointBudget)
                    throws java.io.IOException,
                           AutomationException

Indicates the Point Budget.

Parameters:

pPointBudget - The pPointBudget (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnalysisToolsResolution

double getAnalysisToolsResolution()
                                  throws java.io.IOException,
                                         AutomationException

Indicates the resolution that analysis tools will be enabled.

Returns:

The pAnalysisResolution

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnalysisToolsResolution

void setAnalysisToolsResolution(double pAnalysisResolution)
                                throws java.io.IOException,
                                       AutomationException

Indicates the resolution that analysis tools will be enabled.

Parameters:

pAnalysisResolution - The pAnalysisResolution (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.