Atmosphere

java.lang.Object
- com.mousebird.maply.Atmosphere

```
public class Atmosphere
extends java.lang.Object
```
Sets up the objects and shaders to implement an atmosphere.
This object sets up a shader implementation of the simple atmosphere from GPU Gems 2 http://http.developer.nvidia.com/GPUGems2/gpugems2_chapter16.html

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`fragmentShaderAtmosTri`
`static java.lang.String`	`fragmentShaderGroundTri`
`static java.lang.String`	`k_blendColor`
`static java.lang.String`	`k_ESun`
`static java.lang.String`	`k_fCameraHeight`
`static java.lang.String`	`k_fCameraHeight2`
`static java.lang.String`	`k_fExposure`
`static java.lang.String`	`k_fInnerRadius`
`static java.lang.String`	`k_fInnerRadius2`
`static java.lang.String`	`k_fOuterRadius`
`static java.lang.String`	`k_fOuterRadius2`
`static java.lang.String`	`k_fSamples`
`static java.lang.String`	`k_fScale`
`static java.lang.String`	`k_fScaleDepth`
`static java.lang.String`	`k_fScaleOverScaleDepth`
`static java.lang.String`	`k_g`
`static java.lang.String`	`k_g2`
`static java.lang.String`	`k_Km`
`static java.lang.String`	`k_Km4PI`
`static java.lang.String`	`k_KmESun`
`static java.lang.String`	`k_Kr`
`static java.lang.String`	`k_Kr4PI`
`static java.lang.String`	`k_KrESun`
`static java.lang.String`	`k_nSamples`
`static java.lang.String`	`k_v3CameraPos`
`static java.lang.String`	`k_v3InvWavelength`
`static java.lang.String`	`k_v3LightPos`
`static java.lang.String`	`kAtmosphereGroundShader`
`static java.lang.String`	`kAtmosphereShader`
`static int`	`kMaplyAtmosphereDrawPriorityDefault`
`static java.lang.String`	`vertexShaderAtmosTri`
`static java.lang.String`	`vertexShaderGroundTri`

Constructor Summary

Constructors
Constructor and Description
`Atmosphere(GlobeController inViewC, RenderControllerInterface.ThreadMode mode)` Set up the atmospheric shaders and the default parameters for rendering.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`geteSun()` Brightness of the sun (20.0 by default)
`float`	`getExposure()` Exposure constant in fragment shader.
`float`	`getG()` Constant used in the fragment shader.
`Shader`	`getGroundShader()` The ground shader we set up.
`float`	`getKm()` Mie scattering constant (0.0010 by default)
`float`	`getKr()`
`int`	`getNumSamples()` Number of samples for the ray through the atmosphere (3 by default)
`float`	`getOuterRadius()` Outer radius of the atmosphere (1.05 by default).
`float[]`	`getWaveLength()` Wavelengths of the light (RGB).
`float`	`getWavelengthForComponent(short component)` Wavelengths of the light (RGB).
`void`	`removeFromController()` Remove any objects from the globe controller and shut down the atmosphere.
`void`	`seteSun(float eSun)` Brightness of the sun (20.0 by default)
`void`	`setExposure(float exposure)` Exposure constant in fragment shader.
`void`	`setG(float g)` Constant used in the fragment shader.
`void`	`setKm(float km)` Mie scattering constant (0.0010 by default)
`void`	`setKr(float kr)` Rayleigh scattering constant (0.0025 by default)
`void`	`setLockToCamera(boolean newVal)` If set, we'll lock the sun to the camera position.
`void`	`setNumSamples(int numSamples)` Number of samples for the ray through the atmosphere (3 by default)
`void`	`setOuterRadius(float outerRadius)` Outer radius of the atmosphere (1.05 by default).
`void`	`setSunPosition(Point3d sunDir)` Set the sun's position relative to the earth.
`Shader`	`setupShader()` Return the shader for use by the atmosphere.
`void`	`setWaveLength(float[] waveLength)` Wavelengths of the light (RGB).
`void`	`setWaveLength(float redWavelength, float greenWavelength, float blueWavelength)` Wavelengths of the light (RGB).

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

- Field Detail
  - k_v3CameraPos
```
public static final java.lang.String k_v3CameraPos
```
    See Also:
    
    Constant Field Values
  - k_v3LightPos
```
public static final java.lang.String k_v3LightPos
```
    See Also:
    
    Constant Field Values
  - k_fCameraHeight
```
public static final java.lang.String k_fCameraHeight
```
    See Also:
    
    Constant Field Values
  - k_fCameraHeight2
```
public static final java.lang.String k_fCameraHeight2
```
    See Also:
    
    Constant Field Values
  - k_fInnerRadius
```
public static final java.lang.String k_fInnerRadius
```
    See Also:
    
    Constant Field Values
  - k_fInnerRadius2
```
public static final java.lang.String k_fInnerRadius2
```
    See Also:
    
    Constant Field Values
  - k_fOuterRadius
```
public static final java.lang.String k_fOuterRadius
```
    See Also:
    
    Constant Field Values
  - k_fOuterRadius2
```
public static final java.lang.String k_fOuterRadius2
```
    See Also:
    
    Constant Field Values
  - k_fScale
```
public static final java.lang.String k_fScale
```
    See Also:
    
    Constant Field Values
  - k_fScaleDepth
```
public static final java.lang.String k_fScaleDepth
```
    See Also:
    
    Constant Field Values
  - k_fScaleOverScaleDepth
```
public static final java.lang.String k_fScaleOverScaleDepth
```
    See Also:
    
    Constant Field Values
  - k_Kr
```
public static final java.lang.String k_Kr
```
    See Also:
    
    Constant Field Values
  - k_Kr4PI
```
public static final java.lang.String k_Kr4PI
```
    See Also:
    
    Constant Field Values
  - k_Km
```
public static final java.lang.String k_Km
```
    See Also:
    
    Constant Field Values
  - k_Km4PI
```
public static final java.lang.String k_Km4PI
```
    See Also:
    
    Constant Field Values
  - k_ESun
```
public static final java.lang.String k_ESun
```
    See Also:
    
    Constant Field Values
  - k_KmESun
```
public static final java.lang.String k_KmESun
```
    See Also:
    
    Constant Field Values
  - k_KrESun
```
public static final java.lang.String k_KrESun
```
    See Also:
    
    Constant Field Values
  - k_v3InvWavelength
```
public static final java.lang.String k_v3InvWavelength
```
    See Also:
    
    Constant Field Values
  - k_fSamples
```
public static final java.lang.String k_fSamples
```
    See Also:
    
    Constant Field Values
  - k_nSamples
```
public static final java.lang.String k_nSamples
```
    See Also:
    
    Constant Field Values
  - k_g
```
public static final java.lang.String k_g
```
    See Also:
    
    Constant Field Values
  - k_g2
```
public static final java.lang.String k_g2
```
    See Also:
    
    Constant Field Values
  - k_fExposure
```
public static final java.lang.String k_fExposure
```
    See Also:
    
    Constant Field Values
  - k_blendColor
```
public static final java.lang.String k_blendColor
```
    See Also:
    
    Constant Field Values
  - vertexShaderAtmosTri
```
public static final java.lang.String vertexShaderAtmosTri
```
    See Also:
    
    Constant Field Values
  - fragmentShaderAtmosTri
```
public static final java.lang.String fragmentShaderAtmosTri
```
    See Also:
    
    Constant Field Values
  - kAtmosphereShader
```
public static final java.lang.String kAtmosphereShader
```
    See Also:
    
    Constant Field Values
  - vertexShaderGroundTri
```
public static final java.lang.String vertexShaderGroundTri
```
    See Also:
    
    Constant Field Values
  - fragmentShaderGroundTri
```
public static final java.lang.String fragmentShaderGroundTri
```
    See Also:
    
    Constant Field Values
  - kAtmosphereGroundShader
```
public static final java.lang.String kAtmosphereGroundShader
```
    See Also:
    
    Constant Field Values
  - kMaplyAtmosphereDrawPriorityDefault
```
public static final int kMaplyAtmosphereDrawPriorityDefault
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Atmosphere
```
public Atmosphere(GlobeController inViewC,
                  RenderControllerInterface.ThreadMode mode)
```
    Set up the atmospheric shaders and the default parameters for rendering.
    
    Parameters:
    
    inViewC - The globe controller to create objects in.
    
    mode - Whether or not to work on this thread on put the work in the background.
- Method Detail
  - getKr
```
public float getKr()
```
  - setKr
```
public void setKr(float kr)
```
    Rayleigh scattering constant (0.0025 by default)
  - getKm
```
public float getKm()
```
    Mie scattering constant (0.0010 by default)
  - setKm
```
public void setKm(float km)
```
    Mie scattering constant (0.0010 by default)
  - geteSun
```
public float geteSun()
```
    Brightness of the sun (20.0 by default)
  - seteSun
```
public void seteSun(float eSun)
```
    Brightness of the sun (20.0 by default)
  - getNumSamples
```
public int getNumSamples()
```
    Number of samples for the ray through the atmosphere (3 by default)
  - setNumSamples
```
public void setNumSamples(int numSamples)
```
    Number of samples for the ray through the atmosphere (3 by default)
  - getOuterRadius
```
public float getOuterRadius()
```
    Outer radius of the atmosphere (1.05 by default). Earth is radius 1.0.
  - setOuterRadius
```
public void setOuterRadius(float outerRadius)
```
    Outer radius of the atmosphere (1.05 by default). Earth is radius 1.0.
  - getG
```
public float getG()
```
    Constant used in the fragment shader. Default is -0.95.
  - setG
```
public void setG(float g)
```
    Constant used in the fragment shader. Default is -0.95.
  - getExposure
```
public float getExposure()
```
    Exposure constant in fragment shader. Default is 2.0.
  - setExposure
```
public void setExposure(float exposure)
```
    Exposure constant in fragment shader. Default is 2.0.
  - getGroundShader
```
public Shader getGroundShader()
```
    The ground shader we set up. You need to apply it yourself.
  - setLockToCamera
```
public void setLockToCamera(boolean newVal)
```
    If set, we'll lock the sun to the camera position. This means the globe will always be lit from the front.
  - setWaveLength
```
public void setWaveLength(float[] waveLength)
```
    Wavelengths of the light (RGB). Three floats, defaults are: 0.650, 0.570, 0.475
  - setWaveLength
```
public void setWaveLength(float redWavelength,
                          float greenWavelength,
                          float blueWavelength)
```
    Wavelengths of the light (RGB). Three floats, defaults are: 0.650, 0.570, 0.475
  - getWaveLength
```
public float[] getWaveLength()
```
    Wavelengths of the light (RGB). Three floats, defaults are: 0.650, 0.570, 0.475
  - getWavelengthForComponent
```
public float getWavelengthForComponent(short component)
```
    Wavelengths of the light (RGB). Three floats, defaults are: 0.650, 0.570, 0.475
  - setSunPosition
```
public void setSunPosition(Point3d sunDir)
```
    Set the sun's position relative to the earth. This is what comes out of MaplySun.
  - setupShader
```
public Shader setupShader()
```
    Return the shader for use by the atmosphere.
    
    Returns:
  - removeFromController
```
public void removeFromController()
```
    Remove any objects from the globe controller and shut down the atmosphere.

Class Atmosphere

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

k_v3CameraPos

k_v3LightPos

k_fCameraHeight

k_fCameraHeight2

k_fInnerRadius

k_fInnerRadius2

k_fOuterRadius

k_fOuterRadius2

k_fScale

k_fScaleDepth

k_fScaleOverScaleDepth

k_Kr

k_Kr4PI

k_Km

k_Km4PI

k_ESun

k_KmESun

k_KrESun

k_v3InvWavelength

k_fSamples

k_nSamples

k_g

k_g2

k_fExposure

k_blendColor

vertexShaderAtmosTri

fragmentShaderAtmosTri

kAtmosphereShader

vertexShaderGroundTri

fragmentShaderGroundTri

kAtmosphereGroundShader

kMaplyAtmosphereDrawPriorityDefault

Constructor Detail

Atmosphere

Method Detail

getKr

setKr

getKm

setKm

geteSun

seteSun

getNumSamples

setNumSamples

getOuterRadius

setOuterRadius

getG

setG

getExposure

setExposure

getGroundShader

setLockToCamera

setWaveLength

setWaveLength

getWaveLength

getWavelengthForComponent

setSunPosition

setupShader

removeFromController