com.esri.arcgis.globecore
Class GlobeLayerProperties

java.lang.Object
  extended by com.esri.arcgis.globecore.GlobeLayerProperties
All Implemented Interfaces:
IDataLayerExtension, IGlobeLayerProperties, IGlobeLayerProperties2, IGlobeLayerProperties4, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class GlobeLayerProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeLayerProperties, IGlobeLayerProperties2, IGlobeLayerProperties4, IDataLayerExtension, IPersistStream, IPersist, Externalizable

The layer extension containing globe layer properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
GlobeLayerProperties()
          Constructs a GlobeLayerProperties using ArcGIS Engine.
GlobeLayerProperties(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeLayerProperties theGlobeLayerProperties = (GlobeLayerProperties) obj;
 
Method Summary
 void addIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
          addIFeatureLayerSelectionEventsListener.
 void applyDisplayProperties(ILayer pLayer)
          Applies the display properties of the layer.
 boolean connect(IName pOptRepairName)
          Connects the layer to its data source.
 boolean equals(Object o)
          Compare this object with another
 void estimateFeatureLODRange(int[] minLOD, int[] defaultLOD, int[] maxLOD, int[] pMinMinLOD, int[] pMaxMaxLOD)
          Suggests LOD range values for the layer.
 void estimateMinimumCellSize(double[] minCellsize)
          Suggests the minimum cell size for rasterization.
 void estimateSymbologyScalingFactor(double[] metersPerPoint)
          Suggests the scaling factor of meters-per-point to be applied on symbol sizes during rasterization.
 void estimateThresholdDistances(double[] minVisibleDistance, double[] maxVisibleDistance)
          Suggests visibility distance range for the layer.
 double getAlphaThreshold()
          Alpha threshold for transparency.
 int getBaseImageDrawingPriority()
          Indicates the drawing priority for images on the globe.
 int getCacheCompressionType()
          The cache compression type.
 String getCacheID()
          Unique layer cache ID.
 String getCacheName()
          The path to the layer cache.
 int getCacheRemovalOption()
          The cache removal option.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IEnvelope getExtent(ILayer pLayer)
          Calculate the extent of the layer, including elevation.
 int getFloatingSeeThroughOrder()
          Indicates the see-through order for a floating layer.
 IGlobeDisplay getGlobeDisplay()
          The globe display.
 IGlobeHeightProperties getHeightProperties()
          The height properties.
 int getImageCatalogCrossoverLevel()
          Crossover Level of Detail (0-31) for image catalog layers.
 int getImageSamplingMode()
          Image sampling mode for display.
 IIMSGlobeConnection getIMSConnection()
          The IMS connection, if it exists.
 void getLossyCompressionOption(boolean[] pbLossyCompression, short[] pQuality)
          Gets the lossy compression option and compression quality.
 ILayer getMasterLayer()
          The layer that defines properties for an elevation layer.
 int getMaxCacheSizeLimitMB()
          Maximum cache size [MB] as a hint to cache maintenance utilities.
 int getMaxFeatureLevelOfDetail()
          Level of Detail (0-31) for feature layers.
 double getMaximumDistance()
          The maximum distance at which the layer is visible.
 int getMaxLOD()
          Maximum LOD allowed.
 double getMinimumCellSize()
          Minimum cell size for rasters, in meters.
 double getMinimumCellSizeDegrees()
          Minimum cell size for rasters, in degrees.
 double getMinimumDistance()
          The minimum distance at which the layer is visible.
 int getMinLOD()
          Minimum LOD allowed.
 void getPartialLODRange(int[] fromLod, int[] toLod)
          Returns LOD range of partial cache generation.
 int getRasterTileSize()
          Rasterized vector tile size.
 String getRelativeBase()
          Base path used when storing relative path names.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 double getSymbologyScalingFactor()
          The scaling factor of meters-per-point to be applied on symbol sizes during rasterization.
 int getTextureCompressionType()
          The current texture compression type.
 int getTextureDisplayType()
          The current texture display type.
 double getTextureDownsamplingFactor()
          The texture down-sampling factor.
 int getType()
          The data type.
 int getVectorTileSize()
          Maximum vector tile size.
 int hashCode()
          the hashcode for this object
 void initCacheName(IGlobe pGlobe, ILayer pLayer, boolean bOverwrite)
          Initializes the cache name.
 void invalidatePartialLODRange()
          Invalidates LOD range of partial cache generation.
 boolean isCacheIsDangling()
          Reports if the cache will be lost if the document is not saved.
 boolean isCacheNameValid()
          Indicates if the path to the layer cache is valid.
 boolean isConsolidatedChild()
          Indicates if the cache is consolidated into the parent's.
 boolean isConsolidatedParent()
          Indicates if the group layer cache consolidates some of the children.
 void isDirty()
          isDirty
 boolean isDisconnected()
          Indicates if the layer is not associated with a data source.
 boolean isDynamicallyRasterized()
          Indicates if the feature data is to be rasterized.
 boolean isExtruded()
          Indicates if the feature data is to be extruded.
 boolean isFetchingSuspendedWhenNavigating()
          Indicates if the layer is visible while interactive navigation.
 boolean isFullCacheOption()
          Indicates if the layer should be fully cached.
 boolean isFullyCached()
          Indicates if the layer is fully cached.
 boolean isInvalidateCache()
          Indicates if changes in the properties have made the cache invalid (must be refreshed).
 boolean isInvisibleWhenNavigating()
          Indicates if the layer is visible while interactive navigation.
 boolean isLayerClone()
          Indicates if the layer is a clone of the original in Globe.
 boolean isMapConsolidatedChild()
          Indicates if the group layer cache consolidates the child through map rendering.
 boolean isMapConsolidatedParent()
          Indicates if the group layer cache consolidates the children through map rendering.
 boolean isPerTileVisibility()
          Indicates if the visibility threshold is applied per tile.
 boolean isRasterCatalogCacheConsolidated()
          Indicates if a raster catalog has a consolidated cache.
 boolean isRasterizerUsesOpenGL()
          Indicates if a raster catalog has a consolidated cache.
 boolean isScale3DSymbols()
          Indicates if the the 3D symbols will be scaled with the distance.
 boolean isStrictOnDemandMode()
          Indicates if the tile generation is done strictly on demand.
 boolean isUse16ColorBits()
          Indicates whether to use 16 bits for color.
 boolean isUse16ElevationBits()
          Indicates whether to use 16 bits for elevation.
 boolean isUseCache()
          Indicates if the layer will use a disk data cache.
 void load(IStream pstm)
          load
 void putLossyCompressionOption(boolean bLossyCompression, short quality)
          Puts the lossy compression option and compression quality.
 void readExternal(ObjectInput in)
           
 void removeIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
          removeIFeatureLayerSelectionEventsListener.
 void save(IStream pstm, int fClearDirty)
          save
 void setAlphaThreshold(double threshold)
          Alpha threshold for transparency.
 void setBaseImageDrawingPriority(int pPriority)
          Indicates the drawing priority for images on the globe.
 void setCacheCompressionType(int pType)
          The cache compression type.
 void setCacheName(String pCacheName)
          The path to the layer cache.
 void setCacheRemovalOption(int pOption)
          The cache removal option.
 void setFloatingSeeThroughOrder(int pOrder)
          Indicates the see-through order for a floating layer.
 void setFullCacheOption(boolean pbUseFullCache)
          Indicates if the layer should be fully cached.
 void setGlobeDisplayByRef(IGlobeDisplay ppDisplay)
          The globe display.
 void setHeightPropertiesByRef(IGlobeHeightProperties ppProps)
          The height properties.
 void setImageCatalogCrossoverLevel(int pLevel)
          Crossover Level of Detail (0-31) for image catalog layers.
 void setImageSamplingMode(int pMode)
          Image sampling mode for display.
 void setIMSConnectionByRef(IIMSGlobeConnection ppConnection)
          The IMS connection, if it exists.
 void setInvalidateCache(boolean pbInvalidate)
          Indicates if changes in the properties have made the cache invalid (must be refreshed).
 void setIsCacheNameValid(boolean validCacheName)
          Indicates if the path to the layer cache is valid.
 void setIsConsolidatedParent(boolean bConsolidated)
          Indicates if the group layer cache consolidates some of the children.
 void setIsDynamicallyRasterized(boolean dynamicallyRasterized)
          Indicates if the feature data is to be rasterized.
 void setIsExtruded(boolean extruded)
          Indicates if the feature data is to be extruded.
 void setIsFetchingSuspendedWhenNavigating(boolean bFetchingDisabledWhenNavigating)
          Indicates if the layer is visible while interactive navigation.
 void setIsFullyCached(boolean pbFullyCached)
          Indicates if the layer is fully cached.
 void setIsInvisibleWhenNavigating(boolean bInvisibleWhenNavigating)
          Indicates if the layer is visible while interactive navigation.
 void setIsLayerClone(boolean bIsClone)
          Indicates if the layer is a clone of the original in Globe.
 void setIsMapConsolidatedParent(boolean bConsolidated)
          Indicates if the group layer cache consolidates the children through map rendering.
 void setIsRasterCatalogCacheConsolidated(boolean bConsolidated)
          Indicates if a raster catalog has a consolidated cache.
 void setMaxCacheSizeLimitMB(int pLimit)
          Maximum cache size [MB] as a hint to cache maintenance utilities.
 void setMaxFeatureLevelOfDetail(int pLevel)
          Level of Detail (0-31) for feature layers.
 void setMaximumDistance(double pDistance)
          The maximum distance at which the layer is visible.
 void setMaxLOD(int lod)
          Maximum LOD allowed.
 void setMinimumCellSize(double pMinCellSize)
          Minimum cell size for rasters, in meters.
 void setMinimumCellSizeDegrees(double pMinCellSize)
          Minimum cell size for rasters, in degrees.
 void setMinimumDistance(double pDistance)
          The minimum distance at which the layer is visible.
 void setMinLOD(int lod)
          Minimum LOD allowed.
 void setNewCacheName(String cacheName, boolean rhs2)
          The path to the layer cache, with the option to avoid overwriting.
 void setPartialLODRange(int fromLod, int toLod)
          Sets LOD range of partial cache generation.
 void setPerTileVisibility(boolean pbPerTileVisibility)
          Indicates if the visibility threshold is applied per tile.
 void setRasterizerUsesOpenGL(boolean bUsesOpenGL)
          Indicates if a raster catalog has a consolidated cache.
 void setRelativeBase(String basePath)
          Base path used when storing relative path names.
 void setScale3DSymbols(boolean pbScaleSyms)
          Indicates if the the 3D symbols will be scaled with the distance.
 void setStrictOnDemandMode(boolean strictOnDemandMode)
          Indicates if the tile generation is done strictly on demand.
 void setSymbologyScalingFactor(double metersPerPoint)
          The scaling factor of meters-per-point to be applied on symbol sizes during rasterization.
 void setTextureCompressionType(int pType)
          The current texture compression type.
 void setTextureDisplayType(int pType)
          The current texture display type.
 void setTextureDownsamplingFactor(double pFactor)
          The texture down-sampling factor.
 void setType(int pType)
          The data type.
 void setUse16ColorBits(boolean pbUse16Bits)
          Indicates whether to use 16 bits for color.
 void setUse16ElevationBits(boolean pbUse16Bits)
          Indicates whether to use 16 bits for elevation.
 void setUseCache(boolean pbUseCache)
          Indicates if the layer will use a disk data cache.
 void setVectorTileSize(int psize)
          Maximum vector tile size.
 void validateType()
          Validates the data type.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

GlobeLayerProperties

public GlobeLayerProperties()
                     throws IOException,
                            UnknownHostException
Constructs a GlobeLayerProperties using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GlobeLayerProperties

public GlobeLayerProperties(Object obj)
                     throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeLayerProperties theGlobeLayerProperties = (GlobeLayerProperties) obj;

Construct a GlobeLayerProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GlobeLayerProperties.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

addIFeatureLayerSelectionEventsListener

public void addIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
                                             throws IOException
addIFeatureLayerSelectionEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.IFeatureLayerSelectionEvents interface.
Throws:
IOException - If there are communications problems.

removeIFeatureLayerSelectionEventsListener

public void removeIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
                                                throws IOException
removeIFeatureLayerSelectionEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.IFeatureLayerSelectionEvents interface.
Throws:
IOException - If there are communications problems.

getType

public int getType()
            throws IOException,
                   AutomationException
The data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getType in interface IGlobeLayerProperties
Specified by:
getType in interface IGlobeLayerProperties4
Returns:
A com.esri.arcgis.globecore.esriGlobeDataType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int pType)
             throws IOException,
                    AutomationException
The data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setType in interface IGlobeLayerProperties
Specified by:
setType in interface IGlobeLayerProperties4
Parameters:
pType - A com.esri.arcgis.globecore.esriGlobeDataType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateType

public void validateType()
                  throws IOException,
                         AutomationException
Validates the data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

initCacheName

public void initCacheName(IGlobe pGlobe,
                          ILayer pLayer,
                          boolean bOverwrite)
                   throws IOException,
                          AutomationException
Initializes the cache name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
initCacheName in interface IGlobeLayerProperties
Specified by:
initCacheName in interface IGlobeLayerProperties4
Parameters:
pGlobe - A reference to a com.esri.arcgis.globecore.IGlobe (in)
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
bOverwrite - The bOverwrite (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeightProperties

public IGlobeHeightProperties getHeightProperties()
                                           throws IOException,
                                                  AutomationException
The height properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHeightProperties in interface IGlobeLayerProperties
Specified by:
getHeightProperties in interface IGlobeLayerProperties4
Returns:
A reference to a com.esri.arcgis.globecore.IGlobeHeightProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeightPropertiesByRef

public void setHeightPropertiesByRef(IGlobeHeightProperties ppProps)
                              throws IOException,
                                     AutomationException
The height properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setHeightPropertiesByRef in interface IGlobeLayerProperties
Specified by:
setHeightPropertiesByRef in interface IGlobeLayerProperties4
Parameters:
ppProps - A reference to a com.esri.arcgis.globecore.IGlobeHeightProperties (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheName

public String getCacheName()
                    throws IOException,
                           AutomationException
The path to the layer cache.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCacheName in interface IGlobeLayerProperties
Specified by:
getCacheName in interface IGlobeLayerProperties4
Returns:
The pCacheName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCacheName

public void setCacheName(String pCacheName)
                  throws IOException,
                         AutomationException
The path to the layer cache.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCacheName in interface IGlobeLayerProperties
Specified by:
setCacheName in interface IGlobeLayerProperties4
Parameters:
pCacheName - The pCacheName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCacheNameValid

public boolean isCacheNameValid()
                         throws IOException,
                                AutomationException
Indicates if the path to the layer cache is valid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCacheNameValid in interface IGlobeLayerProperties
Specified by:
isCacheNameValid in interface IGlobeLayerProperties4
Returns:
The validCacheName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsCacheNameValid

public void setIsCacheNameValid(boolean validCacheName)
                         throws IOException,
                                AutomationException
Indicates if the path to the layer cache is valid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsCacheNameValid in interface IGlobeLayerProperties
Specified by:
setIsCacheNameValid in interface IGlobeLayerProperties4
Parameters:
validCacheName - The validCacheName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobeDisplay

public IGlobeDisplay getGlobeDisplay()
                              throws IOException,
                                     AutomationException
The globe display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGlobeDisplay in interface IGlobeLayerProperties
Specified by:
getGlobeDisplay in interface IGlobeLayerProperties4
Returns:
A reference to a com.esri.arcgis.globecore.IGlobeDisplay
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlobeDisplayByRef

public void setGlobeDisplayByRef(IGlobeDisplay ppDisplay)
                          throws IOException,
                                 AutomationException
The globe display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGlobeDisplayByRef in interface IGlobeLayerProperties
Specified by:
setGlobeDisplayByRef in interface IGlobeLayerProperties4
Parameters:
ppDisplay - A reference to a com.esri.arcgis.globecore.IGlobeDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIMSConnection

public IIMSGlobeConnection getIMSConnection()
                                     throws IOException,
                                            AutomationException
The IMS connection, if it exists.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getIMSConnection in interface IGlobeLayerProperties
Specified by:
getIMSConnection in interface IGlobeLayerProperties4
Returns:
A reference to a com.esri.arcgis.carto.IIMSGlobeConnection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIMSConnectionByRef

public void setIMSConnectionByRef(IIMSGlobeConnection ppConnection)
                           throws IOException,
                                  AutomationException
The IMS connection, if it exists.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIMSConnectionByRef in interface IGlobeLayerProperties
Specified by:
setIMSConnectionByRef in interface IGlobeLayerProperties4
Parameters:
ppConnection - A reference to a com.esri.arcgis.carto.IIMSGlobeConnection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheRemovalOption

public int getCacheRemovalOption()
                          throws IOException,
                                 AutomationException
The cache removal option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCacheRemovalOption in interface IGlobeLayerProperties
Specified by:
getCacheRemovalOption in interface IGlobeLayerProperties4
Returns:
A com.esri.arcgis.globecore.esriGlobeLayerCacheRemovalOption constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCacheRemovalOption

public void setCacheRemovalOption(int pOption)
                           throws IOException,
                                  AutomationException
The cache removal option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCacheRemovalOption in interface IGlobeLayerProperties
Specified by:
setCacheRemovalOption in interface IGlobeLayerProperties4
Parameters:
pOption - A com.esri.arcgis.globecore.esriGlobeLayerCacheRemovalOption constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUse16ColorBits

public boolean isUse16ColorBits()
                         throws IOException,
                                AutomationException
Indicates whether to use 16 bits for color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUse16ColorBits in interface IGlobeLayerProperties
Specified by:
isUse16ColorBits in interface IGlobeLayerProperties4
Returns:
The pbUse16Bits
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUse16ColorBits

public void setUse16ColorBits(boolean pbUse16Bits)
                       throws IOException,
                              AutomationException
Indicates whether to use 16 bits for color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUse16ColorBits in interface IGlobeLayerProperties
Specified by:
setUse16ColorBits in interface IGlobeLayerProperties4
Parameters:
pbUse16Bits - The pbUse16Bits (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUse16ElevationBits

public boolean isUse16ElevationBits()
                             throws IOException,
                                    AutomationException
Indicates whether to use 16 bits for elevation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUse16ElevationBits in interface IGlobeLayerProperties
Specified by:
isUse16ElevationBits in interface IGlobeLayerProperties4
Returns:
The pbUse16Bits
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUse16ElevationBits

public void setUse16ElevationBits(boolean pbUse16Bits)
                           throws IOException,
                                  AutomationException
Indicates whether to use 16 bits for elevation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUse16ElevationBits in interface IGlobeLayerProperties
Specified by:
setUse16ElevationBits in interface IGlobeLayerProperties4
Parameters:
pbUse16Bits - The pbUse16Bits (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLossyCompressionOption

public void getLossyCompressionOption(boolean[] pbLossyCompression,
                                      short[] pQuality)
                               throws IOException,
                                      AutomationException
Gets the lossy compression option and compression quality.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLossyCompressionOption in interface IGlobeLayerProperties
Specified by:
getLossyCompressionOption in interface IGlobeLayerProperties4
Parameters:
pbLossyCompression - The pbLossyCompression (out: use single element array)
pQuality - The pQuality (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putLossyCompressionOption

public void putLossyCompressionOption(boolean bLossyCompression,
                                      short quality)
                               throws IOException,
                                      AutomationException
Puts the lossy compression option and compression quality.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
putLossyCompressionOption in interface IGlobeLayerProperties
Specified by:
putLossyCompressionOption in interface IGlobeLayerProperties4
Parameters:
bLossyCompression - The bLossyCompression (in)
quality - The quality (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFullCacheOption

public boolean isFullCacheOption()
                          throws IOException,
                                 AutomationException
Indicates if the layer should be fully cached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isFullCacheOption in interface IGlobeLayerProperties
Specified by:
isFullCacheOption in interface IGlobeLayerProperties4
Returns:
The pbUseFullCache
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFullCacheOption

public void setFullCacheOption(boolean pbUseFullCache)
                        throws IOException,
                               AutomationException
Indicates if the layer should be fully cached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFullCacheOption in interface IGlobeLayerProperties
Specified by:
setFullCacheOption in interface IGlobeLayerProperties4
Parameters:
pbUseFullCache - The pbUseFullCache (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFullyCached

public boolean isFullyCached()
                      throws IOException,
                             AutomationException
Indicates if the layer is fully cached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isFullyCached in interface IGlobeLayerProperties
Specified by:
isFullyCached in interface IGlobeLayerProperties4
Returns:
The pbFullyCached
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsFullyCached

public void setIsFullyCached(boolean pbFullyCached)
                      throws IOException,
                             AutomationException
Indicates if the layer is fully cached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsFullyCached in interface IGlobeLayerProperties
Specified by:
setIsFullyCached in interface IGlobeLayerProperties4
Parameters:
pbFullyCached - The pbFullyCached (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInvalidateCache

public void setInvalidateCache(boolean pbInvalidate)
                        throws IOException,
                               AutomationException
Indicates if changes in the properties have made the cache invalid (must be refreshed).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setInvalidateCache in interface IGlobeLayerProperties
Specified by:
setInvalidateCache in interface IGlobeLayerProperties4
Parameters:
pbInvalidate - The pbInvalidate (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInvalidateCache

public boolean isInvalidateCache()
                          throws IOException,
                                 AutomationException
Indicates if changes in the properties have made the cache invalid (must be refreshed).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isInvalidateCache in interface IGlobeLayerProperties
Specified by:
isInvalidateCache in interface IGlobeLayerProperties4
Returns:
The pbInvalidate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDisconnected

public boolean isDisconnected()
                       throws IOException,
                              AutomationException
Indicates if the layer is not associated with a data source.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDisconnected in interface IGlobeLayerProperties
Specified by:
isDisconnected in interface IGlobeLayerProperties4
Returns:
The pbDisconnected
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent(ILayer pLayer)
                    throws IOException,
                           AutomationException
Calculate the extent of the layer, including elevation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IGlobeLayerProperties
Specified by:
getExtent in interface IGlobeLayerProperties4
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScale3DSymbols

public boolean isScale3DSymbols()
                         throws IOException,
                                AutomationException
Indicates if the the 3D symbols will be scaled with the distance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isScale3DSymbols in interface IGlobeLayerProperties
Specified by:
isScale3DSymbols in interface IGlobeLayerProperties4
Returns:
The pbScaleSyms
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScale3DSymbols

public void setScale3DSymbols(boolean pbScaleSyms)
                       throws IOException,
                              AutomationException
Indicates if the the 3D symbols will be scaled with the distance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setScale3DSymbols in interface IGlobeLayerProperties
Specified by:
setScale3DSymbols in interface IGlobeLayerProperties4
Parameters:
pbScaleSyms - The pbScaleSyms (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumDistance

public double getMinimumDistance()
                          throws IOException,
                                 AutomationException
The minimum distance at which the layer is visible.

Product Availability

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

Specified by:
getMinimumDistance in interface IGlobeLayerProperties
Specified by:
getMinimumDistance in interface IGlobeLayerProperties4
Returns:
The pDistance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumDistance

public void setMinimumDistance(double pDistance)
                        throws IOException,
                               AutomationException
The minimum distance at which the layer is visible.

Product Availability

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

Specified by:
setMinimumDistance in interface IGlobeLayerProperties
Specified by:
setMinimumDistance in interface IGlobeLayerProperties4
Parameters:
pDistance - The pDistance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumDistance

public double getMaximumDistance()
                          throws IOException,
                                 AutomationException
The maximum distance at which the layer is visible.

Product Availability

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

Specified by:
getMaximumDistance in interface IGlobeLayerProperties
Specified by:
getMaximumDistance in interface IGlobeLayerProperties4
Returns:
The pDistance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumDistance

public void setMaximumDistance(double pDistance)
                        throws IOException,
                               AutomationException
The maximum distance at which the layer is visible.

Product Availability

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

Specified by:
setMaximumDistance in interface IGlobeLayerProperties
Specified by:
setMaximumDistance in interface IGlobeLayerProperties4
Parameters:
pDistance - The pDistance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPerTileVisibility

public boolean isPerTileVisibility()
                            throws IOException,
                                   AutomationException
Indicates if the visibility threshold is applied per tile.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isPerTileVisibility in interface IGlobeLayerProperties
Specified by:
isPerTileVisibility in interface IGlobeLayerProperties4
Returns:
The pbPerTileVisibility
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPerTileVisibility

public void setPerTileVisibility(boolean pbPerTileVisibility)
                          throws IOException,
                                 AutomationException
Indicates if the visibility threshold is applied per tile.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPerTileVisibility in interface IGlobeLayerProperties
Specified by:
setPerTileVisibility in interface IGlobeLayerProperties4
Parameters:
pbPerTileVisibility - The pbPerTileVisibility (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBaseImageDrawingPriority

public int getBaseImageDrawingPriority()
                                throws IOException,
                                       AutomationException
Indicates the drawing priority for images on the globe.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBaseImageDrawingPriority in interface IGlobeLayerProperties
Specified by:
getBaseImageDrawingPriority in interface IGlobeLayerProperties4
Returns:
The pPriority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBaseImageDrawingPriority

public void setBaseImageDrawingPriority(int pPriority)
                                 throws IOException,
                                        AutomationException
Indicates the drawing priority for images on the globe.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBaseImageDrawingPriority in interface IGlobeLayerProperties
Specified by:
setBaseImageDrawingPriority in interface IGlobeLayerProperties4
Parameters:
pPriority - The pPriority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFloatingSeeThroughOrder

public int getFloatingSeeThroughOrder()
                               throws IOException,
                                      AutomationException
Indicates the see-through order for a floating layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFloatingSeeThroughOrder in interface IGlobeLayerProperties
Specified by:
getFloatingSeeThroughOrder in interface IGlobeLayerProperties4
Returns:
The pOrder
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFloatingSeeThroughOrder

public void setFloatingSeeThroughOrder(int pOrder)
                                throws IOException,
                                       AutomationException
Indicates the see-through order for a floating layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFloatingSeeThroughOrder in interface IGlobeLayerProperties
Specified by:
setFloatingSeeThroughOrder in interface IGlobeLayerProperties4
Parameters:
pOrder - The pOrder (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImageSamplingMode

public int getImageSamplingMode()
                         throws IOException,
                                AutomationException
Image sampling mode for display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getImageSamplingMode in interface IGlobeLayerProperties
Specified by:
getImageSamplingMode in interface IGlobeLayerProperties4
Returns:
A com.esri.arcgis.globecore.esriGlobeImageSamplingMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImageSamplingMode

public void setImageSamplingMode(int pMode)
                          throws IOException,
                                 AutomationException
Image sampling mode for display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setImageSamplingMode in interface IGlobeLayerProperties
Specified by:
setImageSamplingMode in interface IGlobeLayerProperties4
Parameters:
pMode - A com.esri.arcgis.globecore.esriGlobeImageSamplingMode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumCellSize

public double getMinimumCellSize()
                          throws IOException,
                                 AutomationException
Minimum cell size for rasters, in meters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMinimumCellSize in interface IGlobeLayerProperties
Specified by:
getMinimumCellSize in interface IGlobeLayerProperties4
Returns:
The pMinCellSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumCellSize

public void setMinimumCellSize(double pMinCellSize)
                        throws IOException,
                               AutomationException
Minimum cell size for rasters, in meters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMinimumCellSize in interface IGlobeLayerProperties
Specified by:
setMinimumCellSize in interface IGlobeLayerProperties4
Parameters:
pMinCellSize - The pMinCellSize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVectorTileSize

public int getVectorTileSize()
                      throws IOException,
                             AutomationException
Maximum vector tile size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getVectorTileSize in interface IGlobeLayerProperties
Specified by:
getVectorTileSize in interface IGlobeLayerProperties4
Returns:
The psize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVectorTileSize

public void setVectorTileSize(int psize)
                       throws IOException,
                              AutomationException
Maximum vector tile size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVectorTileSize in interface IGlobeLayerProperties
Specified by:
setVectorTileSize in interface IGlobeLayerProperties4
Parameters:
psize - The psize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsDynamicallyRasterized

public void setIsDynamicallyRasterized(boolean dynamicallyRasterized)
                                throws IOException,
                                       AutomationException
Indicates if the feature data is to be rasterized.

Remarks

When IGlobeLayerProperties::IsDynamicallyRasterized property is set to True, the feature data is rasterized. For displaying feature datasets as vectors, the IGlobeLayerProperties::IsDynamicallyRasterized property is set to False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsDynamicallyRasterized in interface IGlobeLayerProperties
Specified by:
setIsDynamicallyRasterized in interface IGlobeLayerProperties4
Parameters:
dynamicallyRasterized - The dynamicallyRasterized (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDynamicallyRasterized

public boolean isDynamicallyRasterized()
                                throws IOException,
                                       AutomationException
Indicates if the feature data is to be rasterized.

Remarks

When IGlobeLayerProperties::IsDynamicallyRasterized property is set to True, the feature data is rasterized. For displaying feature datasets as vectors, the IGlobeLayerProperties::IsDynamicallyRasterized property is set to False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDynamicallyRasterized in interface IGlobeLayerProperties
Specified by:
isDynamicallyRasterized in interface IGlobeLayerProperties4
Returns:
The dynamicallyRasterized
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbologyScalingFactor

public void setSymbologyScalingFactor(double metersPerPoint)
                               throws IOException,
                                      AutomationException
The scaling factor of meters-per-point to be applied on symbol sizes during rasterization.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymbologyScalingFactor in interface IGlobeLayerProperties
Specified by:
setSymbologyScalingFactor in interface IGlobeLayerProperties4
Parameters:
metersPerPoint - The metersPerPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbologyScalingFactor

public double getSymbologyScalingFactor()
                                 throws IOException,
                                        AutomationException
The scaling factor of meters-per-point to be applied on symbol sizes during rasterization.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSymbologyScalingFactor in interface IGlobeLayerProperties
Specified by:
getSymbologyScalingFactor in interface IGlobeLayerProperties4
Returns:
The metersPerPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsExtruded

public void setIsExtruded(boolean extruded)
                   throws IOException,
                          AutomationException
Indicates if the feature data is to be extruded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsExtruded in interface IGlobeLayerProperties
Specified by:
setIsExtruded in interface IGlobeLayerProperties4
Parameters:
extruded - The extruded (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExtruded

public boolean isExtruded()
                   throws IOException,
                          AutomationException
Indicates if the feature data is to be extruded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isExtruded in interface IGlobeLayerProperties
Specified by:
isExtruded in interface IGlobeLayerProperties4
Returns:
The extruded
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applyDisplayProperties

public void applyDisplayProperties(ILayer pLayer)
                            throws IOException,
                                   AutomationException
Applies the display properties of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
applyDisplayProperties in interface IGlobeLayerProperties
Specified by:
applyDisplayProperties in interface IGlobeLayerProperties4
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMasterLayer

public ILayer getMasterLayer()
                      throws IOException,
                             AutomationException
The layer that defines properties for an elevation layer. Null if the layer is its own master.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMasterLayer in interface IGlobeLayerProperties
Specified by:
getMasterLayer in interface IGlobeLayerProperties4
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxFeatureLevelOfDetail

public int getMaxFeatureLevelOfDetail()
                               throws IOException,
                                      AutomationException
Level of Detail (0-31) for feature layers.

Product Availability

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

Specified by:
getMaxFeatureLevelOfDetail in interface IGlobeLayerProperties
Specified by:
getMaxFeatureLevelOfDetail in interface IGlobeLayerProperties4
Returns:
The pLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxFeatureLevelOfDetail

public void setMaxFeatureLevelOfDetail(int pLevel)
                                throws IOException,
                                       AutomationException
Level of Detail (0-31) for feature layers.

Product Availability

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

Specified by:
setMaxFeatureLevelOfDetail in interface IGlobeLayerProperties
Specified by:
setMaxFeatureLevelOfDetail in interface IGlobeLayerProperties4
Parameters:
pLevel - The pLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isConsolidatedChild

public boolean isConsolidatedChild()
                            throws IOException,
                                   AutomationException
Indicates if the cache is consolidated into the parent's.

Product Availability

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

Specified by:
isConsolidatedChild in interface IGlobeLayerProperties
Specified by:
isConsolidatedChild in interface IGlobeLayerProperties4
Returns:
The bConsolidated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsConsolidatedParent

public void setIsConsolidatedParent(boolean bConsolidated)
                             throws IOException,
                                    AutomationException
Indicates if the group layer cache consolidates some of the children.

Product Availability

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

Specified by:
setIsConsolidatedParent in interface IGlobeLayerProperties
Specified by:
setIsConsolidatedParent in interface IGlobeLayerProperties4
Parameters:
bConsolidated - The bConsolidated (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isConsolidatedParent

public boolean isConsolidatedParent()
                             throws IOException,
                                    AutomationException
Indicates if the group layer cache consolidates some of the children.

Product Availability

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

Specified by:
isConsolidatedParent in interface IGlobeLayerProperties
Specified by:
isConsolidatedParent in interface IGlobeLayerProperties4
Returns:
The bConsolidated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImageCatalogCrossoverLevel

public int getImageCatalogCrossoverLevel()
                                  throws IOException,
                                         AutomationException
Crossover Level of Detail (0-31) for image catalog layers.

Product Availability

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

Specified by:
getImageCatalogCrossoverLevel in interface IGlobeLayerProperties
Specified by:
getImageCatalogCrossoverLevel in interface IGlobeLayerProperties4
Returns:
The pLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImageCatalogCrossoverLevel

public void setImageCatalogCrossoverLevel(int pLevel)
                                   throws IOException,
                                          AutomationException
Crossover Level of Detail (0-31) for image catalog layers.

Product Availability

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

Specified by:
setImageCatalogCrossoverLevel in interface IGlobeLayerProperties
Specified by:
setImageCatalogCrossoverLevel in interface IGlobeLayerProperties4
Parameters:
pLevel - The pLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

estimateFeatureLODRange

public void estimateFeatureLODRange(int[] minLOD,
                                    int[] defaultLOD,
                                    int[] maxLOD,
                                    int[] pMinMinLOD,
                                    int[] pMaxMaxLOD)
                             throws IOException,
                                    AutomationException
Suggests LOD range values for the layer.

Product Availability

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

Specified by:
estimateFeatureLODRange in interface IGlobeLayerProperties
Specified by:
estimateFeatureLODRange in interface IGlobeLayerProperties4
Parameters:
minLOD - The minLOD (out: use single element array)
defaultLOD - The defaultLOD (out: use single element array)
maxLOD - The maxLOD (out: use single element array)
pMinMinLOD - The pMinMinLOD (out: use single element array)
pMaxMaxLOD - The pMaxMaxLOD (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterTileSize

public int getRasterTileSize()
                      throws IOException,
                             AutomationException
Rasterized vector tile size.

Product Availability

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

Specified by:
getRasterTileSize in interface IGlobeLayerProperties
Specified by:
getRasterTileSize in interface IGlobeLayerProperties4
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinLOD

public int getMinLOD()
              throws IOException,
                     AutomationException
Minimum LOD allowed.

Product Availability

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

Specified by:
getMinLOD in interface IGlobeLayerProperties
Specified by:
getMinLOD in interface IGlobeLayerProperties4
Returns:
The lod
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinLOD

public void setMinLOD(int lod)
               throws IOException,
                      AutomationException
Minimum LOD allowed.

Description

The minimum Level of Detail of the layer. Indicates the minimum level for which data cache could be generated.

Product Availability

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

Specified by:
setMinLOD in interface IGlobeLayerProperties
Specified by:
setMinLOD in interface IGlobeLayerProperties4
Parameters:
lod - The lod (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxLOD

public int getMaxLOD()
              throws IOException,
                     AutomationException
Maximum LOD allowed.

Product Availability

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

Specified by:
getMaxLOD in interface IGlobeLayerProperties
Specified by:
getMaxLOD in interface IGlobeLayerProperties4
Returns:
The lod
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxLOD

public void setMaxLOD(int lod)
               throws IOException,
                      AutomationException
Maximum LOD allowed.

Description

The maximum Level of Detail of the layer. Indicates the maximum level for which data cache could be generated.

Product Availability

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

Specified by:
setMaxLOD in interface IGlobeLayerProperties
Specified by:
setMaxLOD in interface IGlobeLayerProperties4
Parameters:
lod - The lod (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

estimateThresholdDistances

public void estimateThresholdDistances(double[] minVisibleDistance,
                                       double[] maxVisibleDistance)
                                throws IOException,
                                       AutomationException
Suggests visibility distance range for the layer.

Product Availability

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

Specified by:
estimateThresholdDistances in interface IGlobeLayerProperties
Specified by:
estimateThresholdDistances in interface IGlobeLayerProperties4
Parameters:
minVisibleDistance - The minVisibleDistance (out: use single element array)
maxVisibleDistance - The maxVisibleDistance (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

estimateSymbologyScalingFactor

public void estimateSymbologyScalingFactor(double[] metersPerPoint)
                                    throws IOException,
                                           AutomationException
Suggests the scaling factor of meters-per-point to be applied on symbol sizes during rasterization.

Product Availability

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

Specified by:
estimateSymbologyScalingFactor in interface IGlobeLayerProperties
Specified by:
estimateSymbologyScalingFactor in interface IGlobeLayerProperties4
Parameters:
metersPerPoint - The metersPerPoint (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsMapConsolidatedParent

public void setIsMapConsolidatedParent(boolean bConsolidated)
                                throws IOException,
                                       AutomationException
Indicates if the group layer cache consolidates the children through map rendering.

Remarks

Setting this boolean property allows you to rasterizes a group layer by using map rendering. This allows you to optimize the rendering performance of group layers at the parent level. Rasterizing group layers consolidates the cache of the group layer and its children into a single cache and treats the group layer and its child layers as a single layer, which means that the contents of the layer are drawn as a raster on the globe surface. The layer is drawn similar to how it is drawn in ArcMap. This is beneficial when trying to display group layer created in ArcMap inside of ArcGlobe because rasertizing the group layer ensures that the display order and symbolgy of these layers is honored in ArcGlobe.

Product Availability

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

Specified by:
setIsMapConsolidatedParent in interface IGlobeLayerProperties2
Specified by:
setIsMapConsolidatedParent in interface IGlobeLayerProperties4
Parameters:
bConsolidated - The bConsolidated (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMapConsolidatedParent

public boolean isMapConsolidatedParent()
                                throws IOException,
                                       AutomationException
Indicates if the group layer cache consolidates the children through map rendering.

Description

Cache consolidation allows you to improve the performance of ArcGlobe by reducing the number of disk caches that are stored and displayed for an ArcGlobe document. Cache consolidation is only available for group layers in ArcGlobe. There are two options for cache consolidation: rasterizing the group layer or merging child caches.

Rasterizing the group layer option is also known as map consolidation. Rasterizing a group layer consolidates the child layers into a single cache, rendering them as a single raster layer with a single cache. All the child layers within the rasterized group layer must also be rasterized. Any child layers that were not rasterized before will become rasterized when the option is set to True. In this way, the group layer will be drawn similar to how it is drawn in ArcMap.

Product Availability

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

Specified by:
isMapConsolidatedParent in interface IGlobeLayerProperties2
Specified by:
isMapConsolidatedParent in interface IGlobeLayerProperties4
Returns:
The bConsolidated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMapConsolidatedChild

public boolean isMapConsolidatedChild()
                               throws IOException,
                                      AutomationException
Indicates if the group layer cache consolidates the child through map rendering.

Description

Cache consolidation allows you to improve the performance of ArcGlobe by reducing the number of disk caches that are stored and displayed for an ArcGlobe document. Cache consolidation is only available for group layers in ArcGlobe. There are two options for cache consolidation: rasterizing the group layer or merging child caches.

Rasterizing the group layer option is also known as map consolidation. Rasterizing a group layer consolidates the child layers into a single cache, rendering them as a single raster layer with a single cache. All the child layers within the rasterized group layer must also be rasterized and any child layers that were not rasterized before will become rasterized. In this way, the group layer will be drawn similar to how it is drawn in ArcMap.

Product Availability

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

Specified by:
isMapConsolidatedChild in interface IGlobeLayerProperties2
Specified by:
isMapConsolidatedChild in interface IGlobeLayerProperties4
Returns:
The bConsolidated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextureDownsamplingFactor

public void setTextureDownsamplingFactor(double pFactor)
                                  throws IOException,
                                         AutomationException
The texture down-sampling factor.

Product Availability

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

Specified by:
setTextureDownsamplingFactor in interface IGlobeLayerProperties2
Specified by:
setTextureDownsamplingFactor in interface IGlobeLayerProperties4
Parameters:
pFactor - The pFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextureDownsamplingFactor

public double getTextureDownsamplingFactor()
                                    throws IOException,
                                           AutomationException
The texture down-sampling factor.

Description

Texture downscaling is applied as a layer property and is only applicable to multipatch layers. Setting texture downscaling for a layer will reduce the in-memory requirements to render it, freeing up resources for other tasks such as navigation. The amount of downscaling that can be applied to a texture without greatly reducing the quality of the display will vary from texture to texture.

For downsampling textures the range of values is from 1 (Minimum downsampling) TO 10 (Maximum downsampling).

Product Availability

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

Specified by:
getTextureDownsamplingFactor in interface IGlobeLayerProperties2
Specified by:
getTextureDownsamplingFactor in interface IGlobeLayerProperties4
Returns:
The pFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextureCompressionType

public void setTextureCompressionType(int pType)
                               throws IOException,
                                      AutomationException
The current texture compression type.

Product Availability

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

Specified by:
setTextureCompressionType in interface IGlobeLayerProperties2
Specified by:
setTextureCompressionType in interface IGlobeLayerProperties4
Parameters:
pType - A com.esri.arcgis.analyst3d.esriTextureFormatType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextureCompressionType

public int getTextureCompressionType()
                              throws IOException,
                                     AutomationException
The current texture compression type.

Description

Used to apply DXT compression to material textures. This conserves memory usage and improves interactive performance. There is a minor degradation in the visual quality of textures. Valid values are esriTextureFormatType.esriTextureDXT (to apply DXT compression) and esriTextureFormatType.esriTextureJPEG.

Product Availability

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

Specified by:
getTextureCompressionType in interface IGlobeLayerProperties2
Specified by:
getTextureCompressionType in interface IGlobeLayerProperties4
Returns:
A com.esri.arcgis.analyst3d.esriTextureFormatType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStrictOnDemandMode

public void setStrictOnDemandMode(boolean strictOnDemandMode)
                           throws IOException,
                                  AutomationException
Indicates if the tile generation is done strictly on demand.

Description

Setting this boolean property to True will force the layer to generate the level of detail relevant for the view. This means that coarser or intermediate levels of detail will not be generated for the view. As you navigate around in the view, new level of details will be generated based on the view. The levels of details generated are written to the cache.

For rasterized feature layers, rasterized group layers and ArcIMS layers, this boolean property is set to True by default.

Product Availability

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

Specified by:
setStrictOnDemandMode in interface IGlobeLayerProperties2
Specified by:
setStrictOnDemandMode in interface IGlobeLayerProperties4
Parameters:
strictOnDemandMode - The strictOnDemandMode (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStrictOnDemandMode

public boolean isStrictOnDemandMode()
                             throws IOException,
                                    AutomationException
Indicates if the tile generation is done strictly on demand.

Description

Setting this boolean property to True will force the layer to generate the level of detail relevant for the view. This means that coarser or intermediate levels of detail will not be generated for the view. As you navigate around in the view, new level of details will be generated based on the view. The levels of details generated are written to the cache.

For rasterized feature layers, rasterized group layers and ArcIMS layers, this boolean property is set to True by default.

Product Availability

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

Specified by:
isStrictOnDemandMode in interface IGlobeLayerProperties2
Specified by:
isStrictOnDemandMode in interface IGlobeLayerProperties4
Returns:
The strictOnDemandMode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheID

public String getCacheID()
                  throws IOException,
                         AutomationException
Unique layer cache ID.

Description

Disk caching creates a set of temporary files, or cache, for each layer in the ArcGlobe document. The name of a layer's disk cache is a concatenation of its display name and global unique identifier (GUID).

This method returns the GUID portion of the layer's disk cache name.

Product Availability

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

Specified by:
getCacheID in interface IGlobeLayerProperties2
Specified by:
getCacheID in interface IGlobeLayerProperties4
Returns:
The pCacheID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseCache

public boolean isUseCache()
                   throws IOException,
                          AutomationException
Indicates if the layer will use a disk data cache. This property cannot be changed once the layer is initialized.

Product Availability

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

Specified by:
isUseCache in interface IGlobeLayerProperties2
Specified by:
isUseCache in interface IGlobeLayerProperties4
Returns:
The pbUseCache
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseCache

public void setUseCache(boolean pbUseCache)
                 throws IOException,
                        AutomationException
Indicates if the layer will use a disk data cache. This property cannot be changed once the layer is initialized.

Product Availability

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

Specified by:
setUseCache in interface IGlobeLayerProperties2
Specified by:
setUseCache in interface IGlobeLayerProperties4
Parameters:
pbUseCache - The pbUseCache (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxCacheSizeLimitMB

public void setMaxCacheSizeLimitMB(int pLimit)
                            throws IOException,
                                   AutomationException
Maximum cache size [MB] as a hint to cache maintenance utilities. If zero, no suggested limit.

Product Availability

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

Specified by:
setMaxCacheSizeLimitMB in interface IGlobeLayerProperties2
Specified by:
setMaxCacheSizeLimitMB in interface IGlobeLayerProperties4
Parameters:
pLimit - The pLimit (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxCacheSizeLimitMB

public int getMaxCacheSizeLimitMB()
                           throws IOException,
                                  AutomationException
Maximum cache size [MB] as a hint to cache maintenance utilities. If zero, no suggested limit.

Product Availability

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

Specified by:
getMaxCacheSizeLimitMB in interface IGlobeLayerProperties2
Specified by:
getMaxCacheSizeLimitMB in interface IGlobeLayerProperties4
Returns:
The pLimit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNewCacheName

public void setNewCacheName(String cacheName,
                            boolean rhs2)
                     throws IOException,
                            AutomationException
The path to the layer cache, with the option to avoid overwriting.

Product Availability

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

Specified by:
setNewCacheName in interface IGlobeLayerProperties2
Specified by:
setNewCacheName in interface IGlobeLayerProperties4
Parameters:
cacheName - The cacheName (in)
rhs2 - The rhs2 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

estimateMinimumCellSize

public void estimateMinimumCellSize(double[] minCellsize)
                             throws IOException,
                                    AutomationException
Suggests the minimum cell size for rasterization.

Product Availability

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

Specified by:
estimateMinimumCellSize in interface IGlobeLayerProperties2
Specified by:
estimateMinimumCellSize in interface IGlobeLayerProperties4
Parameters:
minCellsize - The minCellsize (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextureDisplayType

public void setTextureDisplayType(int pType)
                           throws IOException,
                                  AutomationException
The current texture display type.

Product Availability

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

Specified by:
setTextureDisplayType in interface IGlobeLayerProperties2
Specified by:
setTextureDisplayType in interface IGlobeLayerProperties4
Parameters:
pType - A com.esri.arcgis.analyst3d.esriTextureFormatType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextureDisplayType

public int getTextureDisplayType()
                          throws IOException,
                                 AutomationException
The current texture display type.

Description

Used to enable or disable material textures. Valid values are esriTextureFormatType.esriTextureNone (to disable) and esriTextureFormatType.esriTextureJPEG (to enable).

Product Availability

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

Specified by:
getTextureDisplayType in interface IGlobeLayerProperties2
Specified by:
getTextureDisplayType in interface IGlobeLayerProperties4
Returns:
A com.esri.arcgis.analyst3d.esriTextureFormatType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPartialLODRange

public void setPartialLODRange(int fromLod,
                               int toLod)
                        throws IOException,
                               AutomationException
Sets LOD range of partial cache generation.

Product Availability

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

Specified by:
setPartialLODRange in interface IGlobeLayerProperties2
Specified by:
setPartialLODRange in interface IGlobeLayerProperties4
Parameters:
fromLod - The fromLod (in)
toLod - The toLod (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPartialLODRange

public void getPartialLODRange(int[] fromLod,
                               int[] toLod)
                        throws IOException,
                               AutomationException
Returns LOD range of partial cache generation.

Description

Disk caching creates a temporary file, or cache, for each layer in ArcGlobe that helps you display and navigate your data efficiently. A disk cache stores the data and information that allows ArcGlobe to better manage your environment by controlling levels of detail. The status of a cache can be on demand, partial (containing some details of the layer), or full (containing all the details the layer has to offer).

This property returns the current range of the level of detail for the layer - FromLOD (minimum level of detail) to ToLOD (maximum level of detail).

Product Availability

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

Specified by:
getPartialLODRange in interface IGlobeLayerProperties2
Specified by:
getPartialLODRange in interface IGlobeLayerProperties4
Parameters:
fromLod - The fromLod (out: use single element array)
toLod - The toLod (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

invalidatePartialLODRange

public void invalidatePartialLODRange()
                               throws IOException,
                                      AutomationException
Invalidates LOD range of partial cache generation.

Product Availability

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

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

isCacheIsDangling

public boolean isCacheIsDangling()
                          throws IOException,
                                 AutomationException
Reports if the cache will be lost if the document is not saved.

Description

When exiting an ArcGlobe document, on-demand caches for layers that have not been saved to a layer file or ArcGlobe document are automatically deleted.
Partial or full caches are not automatically deleted when exiting an ArcGlobe document, regardless of whether the layer was saved to a layer file or ArcGlobe document or not. However, you should still save a layer file or ArcGlobe document for these layers so you can preserve a link to the cache.

This property will return True unless a layer file or the ArcGlobe document is saved.

Product Availability

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

Specified by:
isCacheIsDangling in interface IGlobeLayerProperties2
Specified by:
isCacheIsDangling in interface IGlobeLayerProperties4
Returns:
The bDangling
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCacheCompressionType

public void setCacheCompressionType(int pType)
                             throws IOException,
                                    AutomationException
The cache compression type.

Product Availability

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

Specified by:
setCacheCompressionType in interface IGlobeLayerProperties2
Specified by:
setCacheCompressionType in interface IGlobeLayerProperties4
Parameters:
pType - A com.esri.arcgis.analyst3d.esriTextureFormatType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheCompressionType

public int getCacheCompressionType()
                            throws IOException,
                                   AutomationException
The cache compression type.

Description

Applicable to rasters and rasterized feature data. Valid values are esriTextureFormatType.esriTextureJPEG and esriTextureFormatType.esriTextureDXT.

Product Availability

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

Specified by:
getCacheCompressionType in interface IGlobeLayerProperties2
Specified by:
getCacheCompressionType in interface IGlobeLayerProperties4
Returns:
A com.esri.arcgis.analyst3d.esriTextureFormatType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumCellSizeDegrees

public double getMinimumCellSizeDegrees()
                                 throws IOException,
                                        AutomationException
Minimum cell size for rasters, in degrees.

Product Availability

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

Specified by:
getMinimumCellSizeDegrees in interface IGlobeLayerProperties2
Specified by:
getMinimumCellSizeDegrees in interface IGlobeLayerProperties4
Returns:
The pMinCellSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumCellSizeDegrees

public void setMinimumCellSizeDegrees(double pMinCellSize)
                               throws IOException,
                                      AutomationException
Minimum cell size for rasters, in degrees.

Product Availability

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

Specified by:
setMinimumCellSizeDegrees in interface IGlobeLayerProperties2
Specified by:
setMinimumCellSizeDegrees in interface IGlobeLayerProperties4
Parameters:
pMinCellSize - The pMinCellSize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsLayerClone

public void setIsLayerClone(boolean bIsClone)
                     throws IOException,
                            AutomationException
Indicates if the layer is a clone of the original in Globe.

Product Availability

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

Specified by:
setIsLayerClone in interface IGlobeLayerProperties2
Specified by:
setIsLayerClone in interface IGlobeLayerProperties4
Parameters:
bIsClone - The bIsClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLayerClone

public boolean isLayerClone()
                     throws IOException,
                            AutomationException
Indicates if the layer is a clone of the original in Globe.

Product Availability

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

Specified by:
isLayerClone in interface IGlobeLayerProperties2
Specified by:
isLayerClone in interface IGlobeLayerProperties4
Returns:
The bIsClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsInvisibleWhenNavigating

public void setIsInvisibleWhenNavigating(boolean bInvisibleWhenNavigating)
                                  throws IOException,
                                         AutomationException
Indicates if the layer is visible while interactive navigation.

Product Availability

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

Specified by:
setIsInvisibleWhenNavigating in interface IGlobeLayerProperties2
Specified by:
setIsInvisibleWhenNavigating in interface IGlobeLayerProperties4
Parameters:
bInvisibleWhenNavigating - The bInvisibleWhenNavigating (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInvisibleWhenNavigating

public boolean isInvisibleWhenNavigating()
                                  throws IOException,
                                         AutomationException
Indicates if the layer is visible while interactive navigation.

Description

Some layers in the ArcGlobe document may be very expensive to render, reducing the responsiveness of interactive navigation through the 3D view. When this option is set to True, the layer will not display while navigating, thereby freeing up resources to improve the interactive navigation experience. When navigation halts, the layer will be displayed again.

The view is said to be navigating when the Globe Camera is moving continuously. For example, using the Fly Tool will set the ‘while navigating’ state to true and cause layer drawing to be suspended appropriately. When the Fly Tool halts, the ‘while navigating’ state is set to false and layer will draw. An example of a navigation technique which does not set the ‘while navigating’ state to true is the mouse-wheel zoom in. This functionality uses discrete steps to zoom in and is therefore not a continuous navigation event.

This option may not be preferred when outputting animation files, as the animation framework will set the ‘while navigating’ status to true and the resulting video will not include display of this layer.

Product Availability

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

Specified by:
isInvisibleWhenNavigating in interface IGlobeLayerProperties2
Specified by:
isInvisibleWhenNavigating in interface IGlobeLayerProperties4
Returns:
The bInvisibleWhenNavigating
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsFetchingSuspendedWhenNavigating

public void setIsFetchingSuspendedWhenNavigating(boolean bFetchingDisabledWhenNavigating)
                                          throws IOException,
                                                 AutomationException
Indicates if the layer is visible while interactive navigation.

Product Availability

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

Specified by:
setIsFetchingSuspendedWhenNavigating in interface IGlobeLayerProperties2
Specified by:
setIsFetchingSuspendedWhenNavigating in interface IGlobeLayerProperties4
Parameters:
bFetchingDisabledWhenNavigating - The bFetchingDisabledWhenNavigating (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFetchingSuspendedWhenNavigating

public boolean isFetchingSuspendedWhenNavigating()
                                          throws IOException,
                                                 AutomationException
Indicates if the layer is visible while interactive navigation.

Product Availability

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

Specified by:
isFetchingSuspendedWhenNavigating in interface IGlobeLayerProperties2
Specified by:
isFetchingSuspendedWhenNavigating in interface IGlobeLayerProperties4
Returns:
The bFetchingDisabledWhenNavigating
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsRasterCatalogCacheConsolidated

public void setIsRasterCatalogCacheConsolidated(boolean bConsolidated)
                                         throws IOException,
                                                AutomationException
Indicates if a raster catalog has a consolidated cache.

Product Availability

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

Specified by:
setIsRasterCatalogCacheConsolidated in interface IGlobeLayerProperties4
Parameters:
bConsolidated - The bConsolidated (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRasterCatalogCacheConsolidated

public boolean isRasterCatalogCacheConsolidated()
                                         throws IOException,
                                                AutomationException
Indicates if a raster catalog has a consolidated cache.

Product Availability

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

Specified by:
isRasterCatalogCacheConsolidated in interface IGlobeLayerProperties4
Returns:
The bConsolidated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAlphaThreshold

public void setAlphaThreshold(double threshold)
                       throws IOException,
                              AutomationException
Alpha threshold for transparency.

Product Availability

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

Specified by:
setAlphaThreshold in interface IGlobeLayerProperties4
Parameters:
threshold - The threshold (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlphaThreshold

public double getAlphaThreshold()
                         throws IOException,
                                AutomationException
Alpha threshold for transparency.

Product Availability

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

Specified by:
getAlphaThreshold in interface IGlobeLayerProperties4
Returns:
The threshold
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterizerUsesOpenGL

public void setRasterizerUsesOpenGL(boolean bUsesOpenGL)
                             throws IOException,
                                    AutomationException
Indicates if a raster catalog has a consolidated cache.

Product Availability

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

Specified by:
setRasterizerUsesOpenGL in interface IGlobeLayerProperties4
Parameters:
bUsesOpenGL - The bUsesOpenGL (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRasterizerUsesOpenGL

public boolean isRasterizerUsesOpenGL()
                               throws IOException,
                                      AutomationException
Indicates if a raster catalog has a consolidated cache.

Product Availability

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

Specified by:
isRasterizerUsesOpenGL in interface IGlobeLayerProperties4
Returns:
The bUsesOpenGL
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public String getRelativeBase()
                       throws IOException,
                              AutomationException
Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRelativeBase in interface IDataLayerExtension
Returns:
The basePath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(String basePath)
                     throws IOException,
                            AutomationException
Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRelativeBase in interface IDataLayerExtension
Parameters:
basePath - The basePath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws IOException,
                       AutomationException
Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
connect in interface IDataLayerExtension
Parameters:
pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The succeeded
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException