Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.globecore
Class GlobeLayerProperties

java.lang.Object
  extended bycom.esri.arcgis.globecore.GlobeLayerProperties
All Implemented Interfaces:
IDataLayerExtension, IGlobeLayerProperties, IGlobeLayerProperties2, IPersist, IPersistStream, java.io.Serializable
public class GlobeLayerProperties
extends java.lang.Object
implements IGlobeLayerProperties, IGlobeLayerProperties2, IDataLayerExtension, IPersistStream, IPersist

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(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
 
Method Summary
 void addIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
           
 void applyDisplayProperties(ILayer pLayer)
          Applies the display properties of the layer.
 boolean connect(IName pOptRepairName)
          Connects the layer to its data source.
 boolean equals(java.lang.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.
 IDataLayerExtension getAsIDataLayerExtension()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGlobeLayerProperties getAsIGlobeLayerProperties()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IGlobeLayerProperties2 getAsIGlobeLayerProperties2()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IPersist getAsIPersist()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IPersistStream getAsIPersistStream()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 int getBaseImageDrawingPriority()
          Indicates the drawing priority for images on the globe.
 int getCacheCompressionType()
          The cache compression type.
 java.lang.String getCacheID()
          Unique layer cache ID.
 java.lang.String getCacheName()
          The path to the layer cache.
 int getCacheRemovalOption()
          The cache removal option.
 void getClassID(GUID[] pClassID)
          Supported Platforms
static java.lang.String 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.
 java.lang.String getRelativeBase()
          Base path used when storing relative path names.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          Supported Platforms
 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()
          Supported Platforms
 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 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)
          Supported Platforms
 void putLossyCompressionOption(boolean bLossyCompression, short quality)
          Puts the lossy compression option and compression quality.
 void removeIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
           
 void save(IStream pstm, int fClearDirty)
          Supported Platforms
 void setBaseImageDrawingPriority(int pPriority)
          Indicates the drawing priority for images on the globe.
 void setCacheCompressionType(int pType)
          The cache compression type.
 void setCacheName(java.lang.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 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(java.lang.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 setRelativeBase(java.lang.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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GlobeLayerProperties

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

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GlobeLayerProperties

public GlobeLayerProperties(java.lang.Object obj)
                     throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
GlobeLayerProperties theGlobeLayerProperties = (GlobeLayerProperties) obj;

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

getClsid

public static java.lang.String getClsid()

getAsIGlobeLayerProperties

public IGlobeLayerProperties getAsIGlobeLayerProperties()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGlobeLayerProperties2

public IGlobeLayerProperties2 getAsIGlobeLayerProperties2()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDataLayerExtension

public IDataLayerExtension getAsIDataLayerExtension()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

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

hashCode

public int hashCode()
the hashcode for this object

addIFeatureLayerSelectionEventsListener

public void addIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
                                             throws java.io.IOException
Throws:
java.io.IOException

removeIFeatureLayerSelectionEventsListener

public void removeIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
                                                throws java.io.IOException
Throws:
java.io.IOException

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IGlobeLayerProperties
The data type.

Supported Platforms

Windows, Solaris, Linux

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

setType

public void setType(int pType)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IGlobeLayerProperties
The data type.

Supported Platforms

Windows, Solaris, Linux

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

validateType

public void validateType()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IGlobeLayerProperties
Validates the data type.

Supported Platforms

Windows, Solaris, Linux

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

initCacheName

public void initCacheName(IGlobe pGlobe,
                          ILayer pLayer,
                          boolean bOverwrite)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IGlobeLayerProperties
Initializes the cache name.

Supported Platforms

Windows, Solaris, Linux

Specified by:
initCacheName in interface IGlobeLayerProperties
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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getHeightProperties

public IGlobeHeightProperties getHeightProperties()
                                           throws java.io.IOException,
                                                  AutomationException
Description copied from interface: IGlobeLayerProperties
The height properties.

Supported Platforms

Windows, Solaris, Linux

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

setHeightPropertiesByRef

public void setHeightPropertiesByRef(IGlobeHeightProperties ppProps)
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IGlobeLayerProperties
The height properties.

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

getCacheName

public java.lang.String getCacheName()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IGlobeLayerProperties
The path to the layer cache.

Supported Platforms

Windows, Solaris, Linux

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

setCacheName

public void setCacheName(java.lang.String pCacheName)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IGlobeLayerProperties
The path to the layer cache.

Supported Platforms

Windows, Solaris, Linux

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

isCacheNameValid

public boolean isCacheNameValid()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the path to the layer cache is valid.

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

setIsCacheNameValid

public void setIsCacheNameValid(boolean validCacheName)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the path to the layer cache is valid.

Supported Platforms

Windows, Solaris, Linux

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

getGlobeDisplay

public IGlobeDisplay getGlobeDisplay()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IGlobeLayerProperties
The globe display.

Supported Platforms

Windows, Solaris, Linux

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

setGlobeDisplayByRef

public void setGlobeDisplayByRef(IGlobeDisplay ppDisplay)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties
The globe display.

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

getIMSConnection

public IIMSGlobeConnection getIMSConnection()
                                     throws java.io.IOException,
                                            AutomationException
Description copied from interface: IGlobeLayerProperties
The IMS connection, if it exists.

Supported Platforms

Windows, Solaris, Linux

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

setIMSConnectionByRef

public void setIMSConnectionByRef(IIMSGlobeConnection ppConnection)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IGlobeLayerProperties
The IMS connection, if it exists.

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

getCacheRemovalOption

public int getCacheRemovalOption()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties
The cache removal option.

Supported Platforms

Windows, Solaris, Linux

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

setCacheRemovalOption

public void setCacheRemovalOption(int pOption)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IGlobeLayerProperties
The cache removal option.

Supported Platforms

Windows, Solaris, Linux

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

isUse16ColorBits

public boolean isUse16ColorBits()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates whether to use 16 bits for color.

Supported Platforms

Windows, Solaris, Linux

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

setUse16ColorBits

public void setUse16ColorBits(boolean pbUse16Bits)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates whether to use 16 bits for color.

Supported Platforms

Windows, Solaris, Linux

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

isUse16ElevationBits

public boolean isUse16ElevationBits()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates whether to use 16 bits for elevation.

Supported Platforms

Windows, Solaris, Linux

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

setUse16ElevationBits

public void setUse16ElevationBits(boolean pbUse16Bits)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates whether to use 16 bits for elevation.

Supported Platforms

Windows, Solaris, Linux

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

getLossyCompressionOption

public void getLossyCompressionOption(boolean[] pbLossyCompression,
                                      short[] pQuality)
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGlobeLayerProperties
Gets the lossy compression option and compression quality.

Supported Platforms

Windows, Solaris, Linux

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

putLossyCompressionOption

public void putLossyCompressionOption(boolean bLossyCompression,
                                      short quality)
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGlobeLayerProperties
Puts the lossy compression option and compression quality.

Supported Platforms

Windows, Solaris, Linux

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

isFullCacheOption

public boolean isFullCacheOption()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the layer should be fully cached.

Supported Platforms

Windows, Solaris, Linux

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

setFullCacheOption

public void setFullCacheOption(boolean pbUseFullCache)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the layer should be fully cached.

Supported Platforms

Windows, Solaris, Linux

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

isFullyCached

public boolean isFullyCached()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the layer is fully cached.

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

setIsFullyCached

public void setIsFullyCached(boolean pbFullyCached)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the layer is fully cached.

Supported Platforms

Windows, Solaris, Linux

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

setInvalidateCache

public void setInvalidateCache(boolean pbInvalidate)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if changes in the properties have made the cache invalid (must be refreshed).

Supported Platforms

Windows, Solaris, Linux

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

isInvalidateCache

public boolean isInvalidateCache()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if changes in the properties have made the cache invalid (must be refreshed).

Supported Platforms

Windows, Solaris, Linux

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

isDisconnected

public boolean isDisconnected()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the layer is not associated with a data source.

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

getExtent

public IEnvelope getExtent(ILayer pLayer)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IGlobeLayerProperties
Calculate the extent of the layer, including elevation.

Supported Platforms

Windows, Solaris, Linux

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

isScale3DSymbols

public boolean isScale3DSymbols()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the the 3D symbols will be scaled with the distance.

Supported Platforms

Windows, Solaris, Linux

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

setScale3DSymbols

public void setScale3DSymbols(boolean pbScaleSyms)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the the 3D symbols will be scaled with the distance.

Supported Platforms

Windows, Solaris, Linux

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

getMinimumDistance

public double getMinimumDistance()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties
The minimum distance at which the layer is visible.

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

setMinimumDistance

public void setMinimumDistance(double pDistance)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IGlobeLayerProperties
The minimum distance at which the layer is visible.

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

getMaximumDistance

public double getMaximumDistance()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties
The maximum distance at which the layer is visible.

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

setMaximumDistance

public void setMaximumDistance(double pDistance)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IGlobeLayerProperties
The maximum distance at which the layer is visible.

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

isPerTileVisibility

public boolean isPerTileVisibility()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the visibility threshold is applied per tile.

Supported Platforms

Windows, Solaris, Linux

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

setPerTileVisibility

public void setPerTileVisibility(boolean pbPerTileVisibility)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the visibility threshold is applied per tile.

Supported Platforms

Windows, Solaris, Linux

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

getBaseImageDrawingPriority

public int getBaseImageDrawingPriority()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates the drawing priority for images on the globe.

Supported Platforms

Windows, Solaris, Linux

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

setBaseImageDrawingPriority

public void setBaseImageDrawingPriority(int pPriority)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates the drawing priority for images on the globe.

Supported Platforms

Windows, Solaris, Linux

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

getFloatingSeeThroughOrder

public int getFloatingSeeThroughOrder()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates the see-through order for a floating layer.

Supported Platforms

Windows, Solaris, Linux

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

setFloatingSeeThroughOrder

public void setFloatingSeeThroughOrder(int pOrder)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates the see-through order for a floating layer.

Supported Platforms

Windows, Solaris, Linux

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

getImageSamplingMode

public int getImageSamplingMode()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IGlobeLayerProperties
Image sampling mode for display.

Supported Platforms

Windows, Solaris, Linux

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

setImageSamplingMode

public void setImageSamplingMode(int pMode)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties
Image sampling mode for display.

Supported Platforms

Windows, Solaris, Linux

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

getMinimumCellSize

public double getMinimumCellSize()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties
Minimum cell size for rasters, in meters.

Supported Platforms

Windows, Solaris, Linux

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

setMinimumCellSize

public void setMinimumCellSize(double pMinCellSize)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IGlobeLayerProperties
Minimum cell size for rasters, in meters.

Supported Platforms

Windows, Solaris, Linux

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

getVectorTileSize

public int getVectorTileSize()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IGlobeLayerProperties
Maximum vector tile size.

Supported Platforms

Windows, Solaris, Linux

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

setVectorTileSize

public void setVectorTileSize(int psize)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IGlobeLayerProperties
Maximum vector tile size.

Supported Platforms

Windows, Solaris, Linux

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

setIsDynamicallyRasterized

public void setIsDynamicallyRasterized(boolean dynamicallyRasterized)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the feature data is to be rasterized.

Supported Platforms

Windows, Solaris, Linux

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. 

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

isDynamicallyRasterized

public boolean isDynamicallyRasterized()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the feature data is to be rasterized.

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

setSymbologyScalingFactor

public void setSymbologyScalingFactor(double metersPerPoint)
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGlobeLayerProperties
The scaling factor of meters-per-point to be applied on symbol sizes during rasterization.

Supported Platforms

Windows, Solaris, Linux

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

getSymbologyScalingFactor

public double getSymbologyScalingFactor()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IGlobeLayerProperties
The scaling factor of meters-per-point to be applied on symbol sizes during rasterization.

Supported Platforms

Windows, Solaris, Linux

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

setIsExtruded

public void setIsExtruded(boolean extruded)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the feature data is to be extruded.

Supported Platforms

Windows, Solaris, Linux

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

isExtruded

public boolean isExtruded()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the feature data is to be extruded.

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

applyDisplayProperties

public void applyDisplayProperties(ILayer pLayer)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IGlobeLayerProperties
Applies the display properties of the layer.

Supported Platforms

Windows, Solaris, Linux

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

getMasterLayer

public ILayer getMasterLayer()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IGlobeLayerProperties
The layer that defines properties for an elevation layer. Null if the layer is its own master.

Supported Platforms

Windows, Solaris, Linux

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

getMaxFeatureLevelOfDetail

public int getMaxFeatureLevelOfDetail()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGlobeLayerProperties
Level of Detail (0-31) for feature layers.

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

setMaxFeatureLevelOfDetail

public void setMaxFeatureLevelOfDetail(int pLevel)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IGlobeLayerProperties
Level of Detail (0-31) for feature layers.

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

isConsolidatedChild

public boolean isConsolidatedChild()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the cache is consolidated into the parent's.

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

setIsConsolidatedParent

public void setIsConsolidatedParent(boolean bConsolidated)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the group layer cache consolidates some of the children.

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

isConsolidatedParent

public boolean isConsolidatedParent()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IGlobeLayerProperties
Indicates if the group layer cache consolidates some of the children.

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

getImageCatalogCrossoverLevel

public int getImageCatalogCrossoverLevel()
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IGlobeLayerProperties
Crossover Level of Detail (0-31) for image catalog layers.

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

setImageCatalogCrossoverLevel

public void setImageCatalogCrossoverLevel(int pLevel)
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: IGlobeLayerProperties
Crossover Level of Detail (0-31) for image catalog layers.

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

estimateFeatureLODRange

public void estimateFeatureLODRange(int[] minLOD,
                                    int[] defaultLOD,
                                    int[] maxLOD,
                                    int[] pMinMinLOD,
                                    int[] pMaxMaxLOD)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IGlobeLayerProperties
Suggests LOD range values for the layer.

Specified by:
estimateFeatureLODRange in interface IGlobeLayerProperties
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterTileSize

public int getRasterTileSize()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IGlobeLayerProperties
Rasterized vector tile size.

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

getMinLOD

public int getMinLOD()
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IGlobeLayerProperties
Minimum LOD allowed.

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

setMinLOD

public void setMinLOD(int lod)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IGlobeLayerProperties
Minimum LOD allowed.

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

getMaxLOD

public int getMaxLOD()
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IGlobeLayerProperties
Maximum LOD allowed.

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

setMaxLOD

public void setMaxLOD(int lod)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IGlobeLayerProperties
Maximum LOD allowed.

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

estimateThresholdDistances

public void estimateThresholdDistances(double[] minVisibleDistance,
                                       double[] maxVisibleDistance)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IGlobeLayerProperties
Suggests visibility distance range for the layer.

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

estimateSymbologyScalingFactor

public void estimateSymbologyScalingFactor(double[] metersPerPoint)
                                    throws java.io.IOException,
                                           AutomationException
Description copied from interface: IGlobeLayerProperties
Suggests the scaling factor of meters-per-point to be applied on symbol sizes during rasterization.

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

setIsMapConsolidatedParent

public void setIsMapConsolidatedParent(boolean bConsolidated)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IGlobeLayerProperties2
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.

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

isMapConsolidatedParent

public boolean isMapConsolidatedParent()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the group layer cache consolidates the children through map rendering.

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

isMapConsolidatedChild

public boolean isMapConsolidatedChild()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the group layer cache consolidates the child through map rendering.

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

setTextureDownsamplingFactor

public void setTextureDownsamplingFactor(double pFactor)
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IGlobeLayerProperties2
The texture down-sampling factor.

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

getTextureDownsamplingFactor

public double getTextureDownsamplingFactor()
                                    throws java.io.IOException,
                                           AutomationException
Description copied from interface: IGlobeLayerProperties2
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).

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

setTextureCompressionType

public void setTextureCompressionType(int pType)
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGlobeLayerProperties2
The current texture compression type.

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

getTextureCompressionType

public int getTextureCompressionType()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IGlobeLayerProperties2
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.

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

setStrictOnDemandMode

public void setStrictOnDemandMode(boolean strictOnDemandMode)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IGlobeLayerProperties2
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.

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

isStrictOnDemandMode

public boolean isStrictOnDemandMode()
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IGlobeLayerProperties2
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.

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

getCacheID

public java.lang.String getCacheID()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IGlobeLayerProperties2
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.

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

isUseCache

public boolean isUseCache()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the layer will use a disk data cache. This property cannot be changed once the layer is initialized.

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

setUseCache

public void setUseCache(boolean pbUseCache)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the layer will use a disk data cache. This property cannot be changed once the layer is initialized.

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

setMaxCacheSizeLimitMB

public void setMaxCacheSizeLimitMB(int pLimit)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IGlobeLayerProperties2
Maximum cache size [MB] as a hint to cache maintenance utilities. If zero, no suggested limit.

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

getMaxCacheSizeLimitMB

public int getMaxCacheSizeLimitMB()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IGlobeLayerProperties2
Maximum cache size [MB] as a hint to cache maintenance utilities. If zero, no suggested limit.

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

setNewCacheName

public void setNewCacheName(java.lang.String cacheName,
                            boolean rhs2)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IGlobeLayerProperties2
The path to the layer cache, with the option to avoid overwriting.

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

estimateMinimumCellSize

public void estimateMinimumCellSize(double[] minCellsize)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IGlobeLayerProperties2
Suggests the minimum cell size for rasterization.

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

setTextureDisplayType

public void setTextureDisplayType(int pType)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IGlobeLayerProperties2
The current texture display type.

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

getTextureDisplayType

public int getTextureDisplayType()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties2
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).

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

setPartialLODRange

public void setPartialLODRange(int fromLod,
                               int toLod)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IGlobeLayerProperties2
Sets LOD range of partial cache generation.

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

getPartialLODRange

public void getPartialLODRange(int[] fromLod,
                               int[] toLod)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IGlobeLayerProperties2
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).

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

invalidatePartialLODRange

public void invalidatePartialLODRange()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGlobeLayerProperties2
Invalidates LOD range of partial cache generation.

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

isCacheIsDangling

public boolean isCacheIsDangling()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IGlobeLayerProperties2
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.

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

setCacheCompressionType

public void setCacheCompressionType(int pType)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IGlobeLayerProperties2
The cache compression type.

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

getCacheCompressionType

public int getCacheCompressionType()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IGlobeLayerProperties2
The cache compression type.

Description

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

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

getMinimumCellSizeDegrees

public double getMinimumCellSizeDegrees()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IGlobeLayerProperties2
Minimum cell size for rasters, in degrees.

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

setMinimumCellSizeDegrees

public void setMinimumCellSizeDegrees(double pMinCellSize)
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IGlobeLayerProperties2
Minimum cell size for rasters, in degrees.

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

setIsLayerClone

public void setIsLayerClone(boolean bIsClone)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the layer is a clone of the original in Globe.

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

isLayerClone

public boolean isLayerClone()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the layer is a clone of the original in Globe.

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

setIsInvisibleWhenNavigating

public void setIsInvisibleWhenNavigating(boolean bInvisibleWhenNavigating)
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the layer is visible while interactive navigation.

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

isInvisibleWhenNavigating

public boolean isInvisibleWhenNavigating()
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the layer is visible while interactive navigation.

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

setIsFetchingSuspendedWhenNavigating

public void setIsFetchingSuspendedWhenNavigating(boolean bFetchingDisabledWhenNavigating)
                                          throws java.io.IOException,
                                                 AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the layer is visible while interactive navigation.

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

isFetchingSuspendedWhenNavigating

public boolean isFetchingSuspendedWhenNavigating()
                                          throws java.io.IOException,
                                                 AutomationException
Description copied from interface: IGlobeLayerProperties2
Indicates if the layer is visible while interactive navigation.

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

getRelativeBase

public java.lang.String getRelativeBase()
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IDataLayerExtension
Base path used when storing relative path names.

Supported Platforms

Windows, Solaris, Linux

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

setRelativeBase

public void setRelativeBase(java.lang.String basePath)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IDataLayerExtension
Base path used when storing relative path names.

Supported Platforms

Windows, Solaris, Linux

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

connect

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD