CentralBodyGraphics | DME Component Libraries for Java 2024 r3

java.lang.Object
- agi.foundation.graphics.CentralBodyGraphics

All Implemented Interfaces:

IDisposable, AutoCloseable
```
public final class CentralBodyGraphics
extends Object
implements IDisposable
```
The graphical properties associated with a particular CentralBody. Changing the CentralBodyGraphics will affect how the associated CentralBody is rendered in a Scene. For instance, to show or hide the CentralBody, use the Show property. CentralBodyGraphics also contains the Terrain and Imagery for the associated CentralBody.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`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 altitude, in meters, that all `Terrain` and `Imagery` will be offset from the surface of the `CentralBody` in the `Scene`.
`GlobeImageOverlay`	`getBaseOverlay()` Gets the base `GlobeImageOverlay` associated with the `CentralBody` in the `Scene`.
`Color`	`getColor()` Gets the `Color` of the `CentralBody` in the `Scene`.
`ImageCollection`	`getImagery()` Gets the collection of `imagery` associated with the `CentralBody` in the `Scene`.
`KmlGraphics`	`getKml()` Gets the `KmlGraphics` associated with the `CentralBody` in the `Scene`.
`GlobeImageOverlay`	`getNightOverlay()` Gets the night `GlobeImageOverlay` associated with the `CentralBody` in the `Scene`.
`double`	`getShininess()` Gets the shininess of the `CentralBody` in the `Scene`.
`boolean`	`getShow()` Gets whether the `CentralBody` is shown or hidden in the `Scene`.
`boolean`	`getShowImagery()` Gets whether the `Imagery` for `CentralBody` in the `Scene` is shown or hidden.
`boolean`	`getShowLabel()` Gets whether a label with the name of the `CentralBody` should be rendered in the `Scene` when the `Camera` is at certain distance away from the `CentralBody`.
`Color`	`getSpecularColor()` Gets the specular `Color` of the `CentralBody` in the `Scene`.
`GlobeImageOverlay`	`getSpecularOverlay()` Gets the specular `GlobeImageOverlay` associated with the `CentralBody` in the `Scene`.
`TerrainCollection`	`getTerrain()` Gets the collection of `TerrainOverlay` associated with the `CentralBody` in the `Scene`.
`void`	`setAltitudeOffset(double dOffset)` Sets the altitude, in meters, that all `Terrain` and `Imagery` will be offset from the surface of the `CentralBody` in the `Scene`.
`void`	`setBaseOverlay(GlobeImageOverlay value)` Sets the base `GlobeImageOverlay` associated with the `CentralBody` in the `Scene`.
`void`	`setColor(Color value)` Sets the `Color` of the `CentralBody` in the `Scene`.
`void`	`setNightOverlay(GlobeImageOverlay value)` Sets the night `GlobeImageOverlay` associated with the `CentralBody` in the `Scene`.
`void`	`setShininess(double value)` Sets the shininess of the `CentralBody` in the `Scene`.
`void`	`setShow(boolean value)` Sets whether the `CentralBody` is shown or hidden in the `Scene`.
`void`	`setShowImagery(boolean value)` Sets whether the `Imagery` for `CentralBody` in the `Scene` is shown or hidden.
`void`	`setShowLabel(boolean value)` Sets whether a label with the name of the `CentralBody` should be rendered in the `Scene` when the `Camera` is at certain distance away from the `CentralBody`.
`void`	`setSpecularColor(Color value)` Sets the specular `Color` of the `CentralBody` in the `Scene`.
`void`	`setSpecularOverlay(GlobeImageOverlay value)` Sets the specular `GlobeImageOverlay` associated with the `CentralBody` in the `Scene`.

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

- 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
```
public final void dispose()
```
    Description copied from interface: IDisposable
    
    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
    
    Specified by:
    
    dispose in interface IDisposable
  - dispose
```
protected void dispose(boolean disposing)
```
  - getColor
```
public Color getColor()
```
    Gets the Color of the CentralBody in the Scene.
  - setColor
```
public void setColor(Color value)
```
    Sets the Color of the CentralBody in the Scene.
  - getSpecularColor
```
public Color getSpecularColor()
```
    Gets the specular Color of the CentralBody in the Scene. The specular color is associated with the SpecularOverlay.
  - setSpecularColor
```
public void setSpecularColor(Color value)
```
    Sets the specular Color of the CentralBody in the Scene. The specular color is associated with the SpecularOverlay.
  - getShininess
```
public double getShininess()
```
    Gets the shininess of the CentralBody in the Scene. The shininess affects the size and brightness of specular reflection associated with the SpecularOverlay.
  - setShininess
```
public void setShininess(double value)
```
    Sets the shininess of the CentralBody in the Scene. The shininess affects the size and brightness of specular reflection associated with the SpecularOverlay.
  - getShowImagery
```
public boolean getShowImagery()
```
    Gets whether the Imagery for CentralBody in the Scene is shown or hidden.
  - setShowImagery
```
public void setShowImagery(boolean value)
```
    Sets whether the Imagery for CentralBody in the Scene is shown or hidden.
  - getShow
```
public boolean getShow()
```
    Gets whether the CentralBody is shown or hidden in the Scene. This only affects the CentralBody itself, not the primitives that are associated with it.
  - setShow
```
public void setShow(boolean value)
```
    Sets whether the CentralBody is shown or hidden in the Scene. This only affects the CentralBody itself, not the primitives that are associated with it.
  - getShowLabel
```
public boolean getShowLabel()
```
    Gets whether a label with the name of the CentralBody should be rendered in the Scene when the Camera is at certain distance away from the CentralBody.
  - setShowLabel
```
public void setShowLabel(boolean value)
```
    Sets whether a label with the name of the CentralBody should be rendered in the Scene when the Camera is at certain distance away from the CentralBody.
  - getAltitudeOffset
```
public double getAltitudeOffset()
```
    Gets the altitude, in meters, that all Terrain and Imagery will be offset from the surface of the CentralBody in the Scene.
  - setAltitudeOffset
```
public void setAltitudeOffset(double dOffset)
```
    Sets the altitude, in meters, that all Terrain and Imagery will be offset from the surface of the CentralBody in the Scene.
  - getBaseOverlay
```
public GlobeImageOverlay getBaseOverlay()
```
    Gets the base GlobeImageOverlay associated with the CentralBody in the Scene. The BaseOverlay is always rendered before any other Imagery. By default, the Earth, Sun, and Moon CentralBodies will have a default BaseOverlay image is loaded by Insight3D when the Scene is created.
    
    See Also:
    
    Imagery Overlay topic
  - setBaseOverlay
```
public void setBaseOverlay(GlobeImageOverlay value)
```
    Sets the base GlobeImageOverlay associated with the CentralBody in the Scene. The BaseOverlay is always rendered before any other Imagery. By default, the Earth, Sun, and Moon CentralBodies will have a default BaseOverlay image is loaded by Insight3D when the Scene is created.
    
    See Also:
    
    Imagery Overlay topic
  - getNightOverlay
```
public GlobeImageOverlay getNightOverlay()
```
    Gets the night GlobeImageOverlay associated with the CentralBody in the Scene. The NightOverlay is displayed only on parts of the CentralBody that are not in sun light. The intensity of the NightOverlay for all scenes can be adjusted with the scene's Lighting.NightLightsIntensity (get) property.
    
    See Also:
    
    Lighting.NightLightsIntensity (get), Imagery Overlay topic
  - setNightOverlay
```
public void setNightOverlay(GlobeImageOverlay value)
```
    Sets the night GlobeImageOverlay associated with the CentralBody in the Scene. The NightOverlay is displayed only on parts of the CentralBody that are not in sun light. The intensity of the NightOverlay for all scenes can be adjusted with the scene's Lighting.NightLightsIntensity (get) property.
    
    See Also:
    
    Lighting.NightLightsIntensity (get), Imagery Overlay topic
  - getSpecularOverlay
```
public GlobeImageOverlay getSpecularOverlay()
```
    Gets the specular GlobeImageOverlay associated with the CentralBody in the Scene. The SpecularOverlay is displayed only in the specular highlight of the CentralBody.
    
    See Also:
    
    Imagery Overlay topic
  - setSpecularOverlay
```
public void setSpecularOverlay(GlobeImageOverlay value)
```
    Sets the specular GlobeImageOverlay associated with the CentralBody in the Scene. The SpecularOverlay is displayed only in the specular highlight of the CentralBody.
    
    See Also:
    
    Imagery Overlay topic
  - getTerrain
```
public TerrainCollection getTerrain()
```
    Gets the collection of TerrainOverlay associated with the CentralBody in the Scene.
    
    See Also:
    
    Terrain Overlay topic
  - getImagery
```
public ImageCollection getImagery()
```
    Gets the collection of imagery associated with the CentralBody in the Scene.
    
    See Also:
    
    Imagery Overlay topic
  - getKml
```
public final KmlGraphics getKml()
```
    Gets the KmlGraphics associated with the CentralBody in the Scene.

Class CentralBodyGraphics

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Method Detail

finalize

dispose

dispose

getColor

setColor

getSpecularColor

setSpecularColor

getShininess

setShininess

getShowImagery

setShowImagery

getShow

setShow

getShowLabel

setShowLabel

getAltitudeOffset

setAltitudeOffset

getBaseOverlay

setBaseOverlay

getNightOverlay

setNightOverlay

getSpecularOverlay

setSpecularOverlay

getTerrain

getImagery

getKml