StkTerrainServerTerrainOverlay

java.lang.Object
- agi.foundation.graphics.advanced.GlobeOverlay
- - agi.foundation.graphics.TerrainOverlay
  - - agi.foundation.graphics.advanced.StkTerrainServerTerrainOverlay

All Implemented Interfaces:

IDisposable, AutoCloseable
```
public final class StkTerrainServerTerrainOverlay
extends TerrainOverlay
implements IDisposable
```
A TerrainOverlay that loads terrain terrain data from an STK Terrain Server, or any server that provides the STK Terrain Server Public REST API. This can be a server on the internet, your local network, or your local machine.

Constructor Summary

Constructors
Constructor and Description
`StkTerrainServerTerrainOverlay()` Initializes a new instance with the default values, which will connect to an AGI server for terrain data.
`StkTerrainServerTerrainOverlay(String baseUri, String tilesetName)` Initializes a new instance with the provided values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`dispose(boolean disposing)`
`protected void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`double`	`getAltitudeOffset()` Gets the value from which to offset the terrain height.
`double`	`getAltitudeScale()` Gets the value from which to scale the terrain height.
`CentralBody`	`getCentralBody()` Gets the `CentralBody` that the `GlobeOverlay` is displayed on.
`DisplayCondition`	`getDisplayCondition()` Gets the `DisplayCondition` that controls whether or not the `GlobeOverlay` is displayed.
`CartographicExtent`	`getExtent()` Gets the `CartographicExtent` that represents the area covered by the `GlobeOverlay`.
`boolean`	`getIsValid()` Gets whether or not the overlay is valid.
`GlobeOverlayRole`	`getRole()` Gets the `GlobeOverlayRole` of the `GlobeOverlay`.
`Object`	`getTag()` Gets custom data associated with this globe overlay.
`URI`	`getUri()` Gets the `URI` specifying the location of the `GlobeOverlay`.
`void`	`setAltitudeOffset(double value)` Sets the value from which to offset the terrain height.
`void`	`setAltitudeScale(double value)` Sets the value from which to scale the terrain height.
`void`	`setDisplayCondition(DisplayCondition value)` Sets the `DisplayCondition` that controls whether or not the `GlobeOverlay` is displayed.
`void`	`setTag(Object value)` Sets custom data associated with this globe overlay.

Methods inherited from class agi.foundation.graphics.TerrainOverlay
getSupported

Methods inherited from class agi.foundation.graphics.advanced.GlobeOverlay
dispose, setExtent

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable
close, dispose

- Constructor Detail
  - StkTerrainServerTerrainOverlay
```
public StkTerrainServerTerrainOverlay()
```
    Initializes a new instance with the default values, which will connect to an AGI server for terrain data.
    Note that an internet connection is required to use this constructor successfully.
  - StkTerrainServerTerrainOverlay
```
public StkTerrainServerTerrainOverlay(String baseUri,
                                      String tilesetName)
```
    Initializes a new instance with the provided values.
    
    Parameters:
    
    baseUri - The uri of the terrain server.
    
    tilesetName - The name of the tileset to use.
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: java.lang.Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
    The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
    The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
    The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
    After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
    The finalize method is never invoked more than once by a Java virtual machine for any given object.
    Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - the Exception raised by this method
    
    See Also:
    
    WeakReference, PhantomReference
  - dispose
```
protected void dispose(boolean disposing)
```
    Overrides:
    
    dispose in class TerrainOverlay
  - getDisplayCondition
```
public DisplayCondition getDisplayCondition()
```
    Description copied from class: GlobeOverlay
    
    Gets the DisplayCondition that controls whether or not the GlobeOverlay is displayed.
    
    Overrides:
    
    getDisplayCondition in class GlobeOverlay
  - setDisplayCondition
```
public void setDisplayCondition(DisplayCondition value)
```
    Description copied from class: GlobeOverlay
    
    Sets the DisplayCondition that controls whether or not the GlobeOverlay is displayed.
    
    Overrides:
    
    setDisplayCondition in class GlobeOverlay
  - getCentralBody
```
public CentralBody getCentralBody()
```
    Description copied from class: GlobeOverlay
    
    Gets the CentralBody that the GlobeOverlay is displayed on. It will return null if the GlobeOverlay hasn't been added to a CentralBody.
    
    Overrides:
    
    getCentralBody in class GlobeOverlay
  - getExtent
```
public CartographicExtent getExtent()
```
    Description copied from class: GlobeOverlay
    
    Gets the CartographicExtent that represents the area covered by the GlobeOverlay.
    
    Overrides:
    
    getExtent in class GlobeOverlay
  - getRole
```
public GlobeOverlayRole getRole()
```
    Description copied from class: GlobeOverlay
    
    Gets the GlobeOverlayRole of the GlobeOverlay.
    
    Overrides:
    
    getRole in class GlobeOverlay
  - getUri
```
public URI getUri()
```
    Description copied from class: GlobeOverlay
    
    Gets the URI specifying the location of the GlobeOverlay.
    
    Overrides:
    
    getUri in class GlobeOverlay
  - getIsValid
```
public boolean getIsValid()
```
    Description copied from class: GlobeOverlay
    
    Gets whether or not the overlay is valid. It can be invalid because of a missing file, corrupt file, unlicensed file, or a file on the incorrect CentralBody.
    
    Overrides:
    
    getIsValid in class GlobeOverlay
  - getTag
```
public Object getTag()
```
    Description copied from class: GlobeOverlay
    
    Gets custom data associated with this globe overlay.
    
    Overrides:
    
    getTag in class GlobeOverlay
  - setTag
```
public void setTag(Object value)
```
    Description copied from class: GlobeOverlay
    
    Sets custom data associated with this globe overlay.
    
    Overrides:
    
    setTag in class GlobeOverlay
  - getAltitudeOffset
```
public double getAltitudeOffset()
```
    Description copied from class: TerrainOverlay
    
    Gets the value from which to offset the terrain height.
    
    Overrides:
    
    getAltitudeOffset in class TerrainOverlay
  - setAltitudeOffset
```
public void setAltitudeOffset(double value)
```
    Description copied from class: TerrainOverlay
    
    Sets the value from which to offset the terrain height.
    
    Overrides:
    
    setAltitudeOffset in class TerrainOverlay
  - getAltitudeScale
```
public double getAltitudeScale()
```
    Description copied from class: TerrainOverlay
    
    Gets the value from which to scale the terrain height.
    
    Overrides:
    
    getAltitudeScale in class TerrainOverlay
  - setAltitudeScale
```
public void setAltitudeScale(double value)
```
    Description copied from class: TerrainOverlay
    
    Sets the value from which to scale the terrain height.
    
    Overrides:
    
    setAltitudeScale in class TerrainOverlay

Class StkTerrainServerTerrainOverlay

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.graphics.TerrainOverlay

Methods inherited from class agi.foundation.graphics.advanced.GlobeOverlay

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Constructor Detail

StkTerrainServerTerrainOverlay

Method Detail

finalize

dispose

getDisplayCondition

setDisplayCondition

getCentralBody

getExtent

getRole

getUri

getIsValid

getTag

setTag

getAltitudeOffset

setAltitudeOffset

getAltitudeScale

setAltitudeScale