com.esri.arcgis.globecore
Class GlobeAdvancedOptions

java.lang.Object
  com.esri.arcgis.globecore.GlobeAdvancedOptions

All Implemented Interfaces:

IGlobeAdvancedOptions, IGlobeAdvancedOptions2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GlobeAdvancedOptions
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeAdvancedOptions2

COM Class 'GlobeAdvancedOptions'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGlobeCore.olb'

Description 'The globe advanced options object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.globecore.IGlobeAdvancedOptions2

IID, IIDa1407e3c_9c23_433e_8245_2785541c7863, xxDummy

Fields inherited from interface com.esri.arcgis.globecore.IGlobeAdvancedOptions

IIDa8132c1e_00f2_49a3_bbaa_d0d951895686

Constructor Summary

GlobeAdvancedOptions()
Constructs a GlobeAdvancedOptions using ArcGIS Engine.

GlobeAdvancedOptions(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeAdvancedOptions theGlobeAdvancedOptions = (GlobeAdvancedOptions) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCachePath() The path to the globe data cache in disk.
double	getClipFarFactor() The Far Plane Clipping Factor.
double	getClipNear() The value for where the near clipping plane is.
static java.lang.String	getClsid() getClsid.
void	getDefaultCompression(int type, boolean[] pbLossyCompression, short[] pQuality) Gets default lossy compression option for a data type, and its quality from 1 to 100.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getLevelOfDetail(int type) The level of detail value.
double	getLevelOfDetailBias(int type) The level of detail bias.
double	getTargetFrameRate() The target frame rate -- for automatic control of level of detail.
void	getTileMemory(int type, int[] pLimitMb, float[] pCurrentMb) Gets the tile memory limit and current usage for a specific internal data type, in Megabytes.
int	getTileMemorySize() The memory used for tile data.
void	getUseCache(boolean[] pbUseDiskCache, double[] pSizeInMb) Gets disk cache option and cache size.
int	getVectorTileSize() The maximum size of a vector tile (< 2 power 16).
void	getVirtualViewportSize(int[] pWidth, int[] pHeight) Gets the maximum interval viewport size used for Level of Detail calculation.
int	hashCode() the hashcode for this object
boolean	isDefaultUse16ColorBits() Indicates whether to perform radiometric compression to 16 color bits.
boolean	isDefaultUse16ElevBits() Indicates whether to perform elevation range compression to 16 bits.
boolean	isLossyCompressionSupported(int type) Indicates if lossy data compression is supported.
boolean	isManualLOD() Indicates if the level of detail is under manual control.
boolean	isUpdateCacheMonthlyPrompt() Indicates whether to update the cache monthly.
void	release() Release a GlobeAdvancedOptions.
void	restoreClipPlaneDefaults() Restore the Default Clipping Plane Settings.
void	restoreLODDefaults() Restore the Default LOD Settings.
void	setCachePath(java.lang.String pCachePath) The path to the globe data cache in disk.
void	setClipFarFactor(double pValue) The Far Plane Clipping Factor.
void	setClipNear(double pValue) The value for where the near clipping plane is.
void	setDefaultCompression(int type, boolean bLossyCompression, short quality) Sets default lossy compression option for a data type, and its quality from 1 to 100.
void	setDefaultUse16ColorBits(boolean pbUse16Bits) Indicates whether to perform radiometric compression to 16 color bits.
void	setDefaultUse16ElevBits(boolean pbUse16Bits) Indicates whether to perform elevation range compression to 16 bits.
void	setLevelOfDetail(int type, double levelOfDetail) The level of detail value.
void	setLevelOfDetailBias(int type, double delta) The level of detail bias.
void	setManualLOD(boolean pbManual) Indicates if the level of detail is under manual control.
void	setTargetFrameRate(double targetFrameRate) The target frame rate -- for automatic control of level of detail.
void	setTileMemory(int type, int limitMb) Sets the tile memory limit for a specific internal data type, in Megabytes.
void	setTileMemorySize(int pSizeInMb) The memory used for tile data.
void	setUpdateCacheMonthlyPrompt(boolean pPrompt) Indicates whether to update the cache monthly.
void	setUseCache(boolean bUseDiskCache, double sizeInMb) Sets disk cache option and cache size.
void	setVectorTileSize(int psize) The maximum size of a vector tile (< 2 power 16).
void	setVirtualViewportSize(int width, int height) Sets the maximum interval viewport size used for Level of Detail calculation..
void	writeToRegistry() Write the options in the system's registry.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GlobeAdvancedOptions

public GlobeAdvancedOptions()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a GlobeAdvancedOptions using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GlobeAdvancedOptions

public GlobeAdvancedOptions(java.lang.Object obj)
                     throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeAdvancedOptions theGlobeAdvancedOptions = (GlobeAdvancedOptions) obj;

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

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()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GlobeAdvancedOptions.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getTileMemory

public void getTileMemory(int type,
                          int[] pLimitMb,
                          float[] pCurrentMb)
                   throws java.io.IOException,
                          AutomationException

Gets the tile memory limit and current usage for a specific internal data type, in Megabytes.

Specified by:

getTileMemory in interface IGlobeAdvancedOptions2

Parameters:

type - A com.esri.arcgis.globecore.esriGlobeTileMemoryType constant (in)

pLimitMb - The pLimitMb (out: use single element array)

pCurrentMb - The pCurrentMb (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTileMemory

public void setTileMemory(int type,
                          int limitMb)
                   throws java.io.IOException,
                          AutomationException

Sets the tile memory limit for a specific internal data type, in Megabytes.

Specified by:

setTileMemory in interface IGlobeAdvancedOptions2

Parameters:

type - A com.esri.arcgis.globecore.esriGlobeTileMemoryType constant (in)

limitMb - The limitMb (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVirtualViewportSize

public void getVirtualViewportSize(int[] pWidth,
                                   int[] pHeight)
                            throws java.io.IOException,
                                   AutomationException

Gets the maximum interval viewport size used for Level of Detail calculation.

Specified by:

getVirtualViewportSize in interface IGlobeAdvancedOptions2

Parameters:

pWidth - The pWidth (out: use single element array)

pHeight - The pHeight (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVirtualViewportSize

public void setVirtualViewportSize(int width,
                                   int height)
                            throws java.io.IOException,
                                   AutomationException

Sets the maximum interval viewport size used for Level of Detail calculation..

Specified by:

setVirtualViewportSize in interface IGlobeAdvancedOptions2

Parameters:

width - The width (in)

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLevelOfDetailBias

public double getLevelOfDetailBias(int type)
                            throws java.io.IOException,
                                   AutomationException

The level of detail bias.

Specified by:

getLevelOfDetailBias in interface IGlobeAdvancedOptions2

Parameters:

type - A com.esri.arcgis.globecore.esriLODType constant (in)

Returns:

The delta

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLevelOfDetailBias

public void setLevelOfDetailBias(int type,
                                 double delta)
                          throws java.io.IOException,
                                 AutomationException

The level of detail bias.

Specified by:

setLevelOfDetailBias in interface IGlobeAdvancedOptions2

Parameters:

type - A com.esri.arcgis.globecore.esriLODType constant (in)

delta - The delta (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLossyCompressionSupported

public boolean isLossyCompressionSupported(int type)
                                    throws java.io.IOException,
                                           AutomationException

Indicates if lossy data compression is supported.

Specified by:

isLossyCompressionSupported in interface IGlobeAdvancedOptions

Parameters:

type - A com.esri.arcgis.globecore.esriGlobeDataType constant (in)

Returns:

The pbLossySupported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultCompression

public void getDefaultCompression(int type,
                                  boolean[] pbLossyCompression,
                                  short[] pQuality)
                           throws java.io.IOException,
                                  AutomationException

Gets default lossy compression option for a data type, and its quality from 1 to 100.

Specified by:

getDefaultCompression in interface IGlobeAdvancedOptions

Parameters:

type - A com.esri.arcgis.globecore.esriGlobeDataType constant (in)

pbLossyCompression - The pbLossyCompression (out: use single element array)

pQuality - The pQuality (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultCompression

public void setDefaultCompression(int type,
                                  boolean bLossyCompression,
                                  short quality)
                           throws java.io.IOException,
                                  AutomationException

Sets default lossy compression option for a data type, and its quality from 1 to 100.

Specified by:

setDefaultCompression in interface IGlobeAdvancedOptions

Parameters:

type - A com.esri.arcgis.globecore.esriGlobeDataType constant (in)

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.

isDefaultUse16ColorBits

public boolean isDefaultUse16ColorBits()
                                throws java.io.IOException,
                                       AutomationException

Indicates whether to perform radiometric compression to 16 color bits.

Specified by:

isDefaultUse16ColorBits in interface IGlobeAdvancedOptions

Returns:

The pbUse16Bits

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultUse16ColorBits

public void setDefaultUse16ColorBits(boolean pbUse16Bits)
                              throws java.io.IOException,
                                     AutomationException

Indicates whether to perform radiometric compression to 16 color bits.

Specified by:

setDefaultUse16ColorBits in interface IGlobeAdvancedOptions

Parameters:

pbUse16Bits - The pbUse16Bits (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDefaultUse16ElevBits

public boolean isDefaultUse16ElevBits()
                               throws java.io.IOException,
                                      AutomationException

Indicates whether to perform elevation range compression to 16 bits.

Specified by:

isDefaultUse16ElevBits in interface IGlobeAdvancedOptions

Returns:

The pbUse16Bits

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultUse16ElevBits

public void setDefaultUse16ElevBits(boolean pbUse16Bits)
                             throws java.io.IOException,
                                    AutomationException

Indicates whether to perform elevation range compression to 16 bits.

Specified by:

setDefaultUse16ElevBits in interface IGlobeAdvancedOptions

Parameters:

pbUse16Bits - The pbUse16Bits (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCachePath

public java.lang.String getCachePath()
                              throws java.io.IOException,
                                     AutomationException

The path to the globe data cache in disk.

Specified by:

getCachePath in interface IGlobeAdvancedOptions

Returns:

The pCachePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCachePath

public void setCachePath(java.lang.String pCachePath)
                  throws java.io.IOException,
                         AutomationException

The path to the globe data cache in disk.

Specified by:

setCachePath in interface IGlobeAdvancedOptions

Parameters:

pCachePath - The pCachePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUseCache

public void getUseCache(boolean[] pbUseDiskCache,
                        double[] pSizeInMb)
                 throws java.io.IOException,
                        AutomationException

Gets disk cache option and cache size.

Specified by:

getUseCache in interface IGlobeAdvancedOptions

Parameters:

pbUseDiskCache - The pbUseDiskCache (out: use single element array)

pSizeInMb - The pSizeInMb (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseCache

public void setUseCache(boolean bUseDiskCache,
                        double sizeInMb)
                 throws java.io.IOException,
                        AutomationException

Sets disk cache option and cache size.

Specified by:

setUseCache in interface IGlobeAdvancedOptions

Parameters:

bUseDiskCache - The bUseDiskCache (in)

sizeInMb - The sizeInMb (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTileMemorySize

public int getTileMemorySize()
                      throws java.io.IOException,
                             AutomationException

The memory used for tile data.

Specified by:

getTileMemorySize in interface IGlobeAdvancedOptions

Returns:

The pSizeInMb

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTileMemorySize

public void setTileMemorySize(int pSizeInMb)
                       throws java.io.IOException,
                              AutomationException

The memory used for tile data.

Specified by:

setTileMemorySize in interface IGlobeAdvancedOptions

Parameters:

pSizeInMb - The pSizeInMb (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isManualLOD

public boolean isManualLOD()
                    throws java.io.IOException,
                           AutomationException

Indicates if the level of detail is under manual control.

Specified by:

isManualLOD in interface IGlobeAdvancedOptions

Returns:

The pbManual

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setManualLOD

public void setManualLOD(boolean pbManual)
                  throws java.io.IOException,
                         AutomationException

Indicates if the level of detail is under manual control.

Specified by:

setManualLOD in interface IGlobeAdvancedOptions

Parameters:

pbManual - The pbManual (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTargetFrameRate

public double getTargetFrameRate()
                          throws java.io.IOException,
                                 AutomationException

The target frame rate -- for automatic control of level of detail.

Specified by:

getTargetFrameRate in interface IGlobeAdvancedOptions

Returns:

The targetFrameRate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTargetFrameRate

public void setTargetFrameRate(double targetFrameRate)
                        throws java.io.IOException,
                               AutomationException

The target frame rate -- for automatic control of level of detail.

Specified by:

setTargetFrameRate in interface IGlobeAdvancedOptions

Parameters:

targetFrameRate - The targetFrameRate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLevelOfDetail

public double getLevelOfDetail(int type)
                        throws java.io.IOException,
                               AutomationException

The level of detail value.

Specified by:

getLevelOfDetail in interface IGlobeAdvancedOptions

Parameters:

type - A com.esri.arcgis.globecore.esriLODType constant (in)

Returns:

The levelOfDetail

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLevelOfDetail

public void setLevelOfDetail(int type,
                             double levelOfDetail)
                      throws java.io.IOException,
                             AutomationException

The level of detail value.

Specified by:

setLevelOfDetail in interface IGlobeAdvancedOptions

Parameters:

type - A com.esri.arcgis.globecore.esriLODType constant (in)

levelOfDetail - The levelOfDetail (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeToRegistry

public void writeToRegistry()
                     throws java.io.IOException,
                            AutomationException

Write the options in the system's registry.

Specified by:

writeToRegistry in interface IGlobeAdvancedOptions

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClipNear

public double getClipNear()
                   throws java.io.IOException,
                          AutomationException

The value for where the near clipping plane is.

Specified by:

getClipNear in interface IGlobeAdvancedOptions

Returns:

The pValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClipNear

public void setClipNear(double pValue)
                 throws java.io.IOException,
                        AutomationException

The value for where the near clipping plane is.

Specified by:

setClipNear in interface IGlobeAdvancedOptions

Parameters:

pValue - The pValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClipFarFactor

public double getClipFarFactor()
                        throws java.io.IOException,
                               AutomationException

The Far Plane Clipping Factor.

Specified by:

getClipFarFactor in interface IGlobeAdvancedOptions

Returns:

The pValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClipFarFactor

public void setClipFarFactor(double pValue)
                      throws java.io.IOException,
                             AutomationException

The Far Plane Clipping Factor.

Specified by:

setClipFarFactor in interface IGlobeAdvancedOptions

Parameters:

pValue - The pValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

restoreClipPlaneDefaults

public void restoreClipPlaneDefaults()
                              throws java.io.IOException,
                                     AutomationException

Restore the Default Clipping Plane Settings.

Specified by:

restoreClipPlaneDefaults in interface IGlobeAdvancedOptions

Throws:

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

AutomationException - If the ArcObject component throws an exception.

restoreLODDefaults

public void restoreLODDefaults()
                        throws java.io.IOException,
                               AutomationException

Restore the Default LOD Settings.

Specified by:

restoreLODDefaults in interface IGlobeAdvancedOptions

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVectorTileSize

public void setVectorTileSize(int psize)
                       throws java.io.IOException,
                              AutomationException

The maximum size of a vector tile (< 2 power 16).

Specified by:

setVectorTileSize in interface IGlobeAdvancedOptions

Parameters:

psize - The psize (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

The maximum size of a vector tile (< 2 power 16).

Specified by:

getVectorTileSize in interface IGlobeAdvancedOptions

Returns:

The psize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpdateCacheMonthlyPrompt

public void setUpdateCacheMonthlyPrompt(boolean pPrompt)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether to update the cache monthly.

Specified by:

setUpdateCacheMonthlyPrompt in interface IGlobeAdvancedOptions

Parameters:

pPrompt - The pPrompt (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUpdateCacheMonthlyPrompt

public boolean isUpdateCacheMonthlyPrompt()
                                   throws java.io.IOException,
                                          AutomationException

Indicates whether to update the cache monthly.

Specified by:

isUpdateCacheMonthlyPrompt in interface IGlobeAdvancedOptions

Returns:

The pPrompt

Throws:

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

AutomationException - If the ArcObject component throws an exception.