|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.globecore.GlobeAdvancedOptions
public class GlobeAdvancedOptions
The globe advanced options object.
The GlobeAdvancedOptions coclass provides access to the globe data processing and Management options.
| Constructor Summary | |
|---|---|
GlobeAdvancedOptions()
Constructs a GlobeAdvancedOptions using ArcGIS Engine. |
|
GlobeAdvancedOptions(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GlobeAdvancedOptions theGlobeAdvancedOptions = (GlobeAdvancedOptions) obj; |
|
| Method Summary | |
|---|---|
boolean |
equals(Object o)
Compare this object with another |
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 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. |
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 |
restoreClipPlaneDefaults()
Restore the Default Clipping Plane Settings. |
void |
restoreLODDefaults()
Restore the Default LOD Settings. |
void |
setCachePath(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 |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public GlobeAdvancedOptions()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public GlobeAdvancedOptions(Object obj)
throws IOException
GlobeAdvancedOptions theGlobeAdvancedOptions = (GlobeAdvancedOptions) obj;
obj to GlobeAdvancedOptions.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void getTileMemory(int type,
int[] pLimitMb,
float[] pCurrentMb)
throws IOException,
AutomationException
getTileMemory in interface IGlobeAdvancedOptions2type - A com.esri.arcgis.globecore.esriGlobeTileMemoryType constant (in)pLimitMb - The pLimitMb (out: use single element array)pCurrentMb - The pCurrentMb (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTileMemory(int type,
int limitMb)
throws IOException,
AutomationException
setTileMemory in interface IGlobeAdvancedOptions2type - A com.esri.arcgis.globecore.esriGlobeTileMemoryType constant (in)limitMb - The limitMb (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getVirtualViewportSize(int[] pWidth,
int[] pHeight)
throws IOException,
AutomationException
getVirtualViewportSize in interface IGlobeAdvancedOptions2pWidth - The pWidth (out: use single element array)pHeight - The pHeight (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setVirtualViewportSize(int width,
int height)
throws IOException,
AutomationException
setVirtualViewportSize in interface IGlobeAdvancedOptions2width - The width (in)height - The height (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getLevelOfDetailBias(int type)
throws IOException,
AutomationException
getLevelOfDetailBias in interface IGlobeAdvancedOptions2type - A com.esri.arcgis.globecore.esriLODType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLevelOfDetailBias(int type,
double delta)
throws IOException,
AutomationException
setLevelOfDetailBias in interface IGlobeAdvancedOptions2type - A com.esri.arcgis.globecore.esriLODType constant (in)delta - The delta (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isLossyCompressionSupported(int type)
throws IOException,
AutomationException
isLossyCompressionSupported in interface IGlobeAdvancedOptionstype - A com.esri.arcgis.globecore.esriGlobeDataType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getDefaultCompression(int type,
boolean[] pbLossyCompression,
short[] pQuality)
throws IOException,
AutomationException
getDefaultCompression in interface IGlobeAdvancedOptionstype - A com.esri.arcgis.globecore.esriGlobeDataType constant (in)pbLossyCompression - The pbLossyCompression (out: use single element array)pQuality - The pQuality (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultCompression(int type,
boolean bLossyCompression,
short quality)
throws IOException,
AutomationException
setDefaultCompression in interface IGlobeAdvancedOptionstype - A com.esri.arcgis.globecore.esriGlobeDataType constant (in)bLossyCompression - The bLossyCompression (in)quality - The quality (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDefaultUse16ColorBits()
throws IOException,
AutomationException
isDefaultUse16ColorBits in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultUse16ColorBits(boolean pbUse16Bits)
throws IOException,
AutomationException
setDefaultUse16ColorBits in interface IGlobeAdvancedOptionspbUse16Bits - The pbUse16Bits (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDefaultUse16ElevBits()
throws IOException,
AutomationException
isDefaultUse16ElevBits in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultUse16ElevBits(boolean pbUse16Bits)
throws IOException,
AutomationException
setDefaultUse16ElevBits in interface IGlobeAdvancedOptionspbUse16Bits - The pbUse16Bits (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCachePath()
throws IOException,
AutomationException
getCachePath in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCachePath(String pCachePath)
throws IOException,
AutomationException
setCachePath in interface IGlobeAdvancedOptionspCachePath - The pCachePath (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getUseCache(boolean[] pbUseDiskCache,
double[] pSizeInMb)
throws IOException,
AutomationException
getUseCache in interface IGlobeAdvancedOptionspbUseDiskCache - The pbUseDiskCache (out: use single element array)pSizeInMb - The pSizeInMb (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseCache(boolean bUseDiskCache,
double sizeInMb)
throws IOException,
AutomationException
setUseCache in interface IGlobeAdvancedOptionsbUseDiskCache - The bUseDiskCache (in)sizeInMb - The sizeInMb (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getTileMemorySize()
throws IOException,
AutomationException
getTileMemorySize in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTileMemorySize(int pSizeInMb)
throws IOException,
AutomationException
setTileMemorySize in interface IGlobeAdvancedOptionspSizeInMb - The pSizeInMb (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isManualLOD()
throws IOException,
AutomationException
isManualLOD in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setManualLOD(boolean pbManual)
throws IOException,
AutomationException
setManualLOD in interface IGlobeAdvancedOptionspbManual - The pbManual (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getTargetFrameRate()
throws IOException,
AutomationException
getTargetFrameRate in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTargetFrameRate(double targetFrameRate)
throws IOException,
AutomationException
setTargetFrameRate in interface IGlobeAdvancedOptionstargetFrameRate - The targetFrameRate (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getLevelOfDetail(int type)
throws IOException,
AutomationException
getLevelOfDetail in interface IGlobeAdvancedOptionstype - A com.esri.arcgis.globecore.esriLODType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLevelOfDetail(int type,
double levelOfDetail)
throws IOException,
AutomationException
setLevelOfDetail in interface IGlobeAdvancedOptionstype - A com.esri.arcgis.globecore.esriLODType constant (in)levelOfDetail - The levelOfDetail (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeToRegistry()
throws IOException,
AutomationException
writeToRegistry in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getClipNear()
throws IOException,
AutomationException
The near clipping plane cuts away any parts of the 3D display that are closer to the camera than the plane. The location of this clipping plane can be adjusted using the IGlobeAdvancedOptions.ClipNear value.
The numeric value used in ClipNear is interpreted as a factor of the Globe’s radius. If ClipNear is set to 0.1 (the default), then the near clipping plane at full extent is approximately (0.1 * 6376 km) = 637.6 km. As you zoom in, a precision gradient is applied, which adjusts the near clipping plane distance down to a value appropriate for your distance from the data.
You can set the ClipNear value to any valid double, though large values will start clipping a lot of data in the foreground, exhibiting behavior such as a hole in the globe or features that you can see through.
getClipNear in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setClipNear(double pValue)
throws IOException,
AutomationException
The near clipping plane cuts away any parts of the 3D display that are closer to the camera than the plane. The location of this clipping plane can be adjusted using the IGlobeAdvancedOptions.ClipNear value.
The numeric value used in ClipNear is interpreted as a factor of the Globe’s radius. If ClipNear is set to 0.1 (the default), then the near clipping plane at full extent is approximately (0.1 * 6376 km) = 637.6 km. As you zoom in, a precision gradient is applied, which adjusts the near clipping plane distance down to a value appropriate for your distance from the data.
You can set the ClipNear value to any valid double, though large values will start clipping a lot of data in the foreground, exhibiting behavior such as a hole in the globe or features that you can see through.
The minimum value set by the slider bar in the View Settings dialog in ArcGlobe is 0.0001220703125 (2-13) and the maximum is 2 (21).
setClipNear in interface IGlobeAdvancedOptionspValue - The pValue (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getClipFarFactor()
throws IOException,
AutomationException
getClipFarFactor in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setClipFarFactor(double pValue)
throws IOException,
AutomationException
The far clipping plane cuts away any parts of the 3D display that are further from the camera than the plane. The location of this clipping plane can be adjusted using the IGlobeAdvancedOptions.ClipFarFactor value. The value used does not represent a distance but rather a scaling factor that is applied to the ArcGlobe calculated value.
A ClipFarFactor of 1 (the default) accepts ArcGlobe’s calculated value. A ClipFarFactor of 2 will move the far clipping plane to twice the ArcGlobe calculated distance.
You can set the ClipFarFactor value to any valid double, though values less than 1 will pull the clipping plane in closer to the camera and start clipping a lot of data in the distance, creating such effects as an end of the planet before reaching the horizon.
Note that the value calculated by ArcGlobe for the Far clipping plane depends on the ClipNear value. If the ClipNear value is small, it might also cause undesired clipping in the background because of the Far Clipping Plane moving automatically closer.
The minimum value set by the slider bar in the View Settings dialog in ArcGlobe is 1 (20) and the maximum is 32 (25).
setClipFarFactor in interface IGlobeAdvancedOptionspValue - The pValue (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void restoreClipPlaneDefaults()
throws IOException,
AutomationException
restoreClipPlaneDefaults in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void restoreLODDefaults()
throws IOException,
AutomationException
restoreLODDefaults in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setVectorTileSize(int psize)
throws IOException,
AutomationException
setVectorTileSize in interface IGlobeAdvancedOptionspsize - The psize (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getVectorTileSize()
throws IOException,
AutomationException
getVectorTileSize in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUpdateCacheMonthlyPrompt(boolean pPrompt)
throws IOException,
AutomationException
setUpdateCacheMonthlyPrompt in interface IGlobeAdvancedOptionspPrompt - The pPrompt (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUpdateCacheMonthlyPrompt()
throws IOException,
AutomationException
isUpdateCacheMonthlyPrompt in interface IGlobeAdvancedOptionsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||