Sky (org.dayflower.pathtracer API)

java.lang.Object
- org.dayflower.pathtracer.scene.Sky

```
public final class Sky
extends java.lang.Object
```
This Sky class implements the Perez Sun and Sky Model.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors
Constructor and Description

Sky()
Constructs a new Sky instance.

Constructors
Constructor and Description
`Sky()` Constructs a new `Sky` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float[]`	`getColHistogram()` Returns the column histogram.
`float[]`	`getImageHistogram()` Returns the image histogram.
`int`	`getImageHistogramHeight()` Returns the image histogram height.
`int`	`getImageHistogramWidth()` Returns the image histogram width.
`float`	`getJacobian()` Returns the Jacobian.
`OrthoNormalBasis33F`	`getOrthoNormalBasis()` Returns the current `OrthoNormalBasis33F`.
`double[]`	`getPerezRelativeLuminance()` Returns the Perez relative luminance.
`double[]`	`getPerezX()` Returns the Perez X.
`double[]`	`getPerezY()` Returns the Perez Y.
`int`	`getSamples()` Returns the sample count.
`Color`	`getSunColor()` Returns a `Color` with the color of the sun.
`Vector3F`	`getSunDirection()` Returns a `Vector3F` with the sun direction in local-space.
`Vector3F`	`getSunDirectionWorld()` Returns a `Vector3F` with the sun direction in world-space.
`Point3F`	`getSunOrigin()` Returns a `Point3F` with the sun origin.
`float`	`getTheta()` Returns the Theta angle.
`float`	`getTurbidity()` Returns the turbidity.
`double`	`getZenithRelativeLuminance()` Returns the Zenith relative luminance.
`double`	`getZenithX()` Returns the Zenith X.
`double`	`getZenithY()` Returns the Zenith Y.
`void`	`set()` Sets the sun and sky parameters.
`void`	`set(Vector3F sunDirectionWorld)` Sets the sun and sky parameters.
`void`	`set(Vector3F sunDirectionWorld, float turbidity)` Sets the sun and sky parameters.
`void`	`setSunDirectionWorldX(float x)` Sets the X-coordinate of the sun direction in world-space and updates the parameters.
`void`	`setSunDirectionWorldY(float y)` Sets the Y-coordinate of the sun direction in world-space and updates the parameters.
`void`	`setSunDirectionWorldZ(float z)` Sets the Z-coordinate of the sun direction in world-space and updates the parameters.
`void`	`setTurbidity(float turbidity)` Sets the turbidity and updates the parameters.

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

- Constructor Detail
  - Sky
```
public Sky()
```
    Constructs a new Sky instance.
- Method Detail
  - getSunColor
```
public Color getSunColor()
```
    Returns a Color with the color of the sun.
    
    Returns:
    
    a Color with the color of the sun
  - getOrthoNormalBasis
```
public OrthoNormalBasis33F getOrthoNormalBasis()
```
    Returns the current OrthoNormalBasis33F.
    
    Returns:
    
    the current OrthoNormalBasis33F
  - getSunOrigin
```
public Point3F getSunOrigin()
```
    Returns a Point3F with the sun origin.
    
    Returns:
    
    a Point3F with the sun origin
  - getSunDirection
```
public Vector3F getSunDirection()
```
    Returns a Vector3F with the sun direction in local-space.
    
    Returns:
    
    a Vector3F with the sun direction in local-space
  - getSunDirectionWorld
```
public Vector3F getSunDirectionWorld()
```
    Returns a Vector3F with the sun direction in world-space.
    
    Returns:
    
    a Vector3F with the sun direction in world-space
  - getZenithRelativeLuminance
```
public double getZenithRelativeLuminance()
```
    Returns the Zenith relative luminance.
    
    Returns:
    
    the Zenith relative luminance
  - getZenithX
```
public double getZenithX()
```
    Returns the Zenith X.
    
    Returns:
    
    the Zenith X
  - getZenithY
```
public double getZenithY()
```
    Returns the Zenith Y.
    
    Returns:
    
    the Zenith Y
  - getPerezRelativeLuminance
```
public double[] getPerezRelativeLuminance()
```
    Returns the Perez relative luminance.
    
    Returns:
    
    the Perez relative luminance
  - getPerezX
```
public double[] getPerezX()
```
    Returns the Perez X.
    
    Returns:
    
    the Perez X
  - getPerezY
```
public double[] getPerezY()
```
    Returns the Perez Y.
    
    Returns:
    
    the Perez Y
  - getJacobian
```
public float getJacobian()
```
    Returns the Jacobian.
    
    Returns:
    
    the Jacobian
  - getTheta
```
public float getTheta()
```
    Returns the Theta angle.
    
    Returns:
    
    the Theta angle
  - getTurbidity
```
public float getTurbidity()
```
    Returns the turbidity.
    
    Returns:
    
    the turbidity
  - getColHistogram
```
public float[] getColHistogram()
```
    Returns the column histogram.
    
    Returns:
    
    the column histogram
  - getImageHistogram
```
public float[] getImageHistogram()
```
    Returns the image histogram.
    
    Returns:
    
    the image histogram
  - getImageHistogramHeight
```
public int getImageHistogramHeight()
```
    Returns the image histogram height.
    
    Returns:
    
    the image histogram height
  - getImageHistogramWidth
```
public int getImageHistogramWidth()
```
    Returns the image histogram width.
    
    Returns:
    
    the image histogram width
  - getSamples
```
public int getSamples()
```
    Returns the sample count.
    
    Returns:
    
    the sample count
  - set
```
public void set()
```
    Sets the sun and sky parameters.
    Calling this method is equivalent to set(new Vector3F(1.0F, 1.0F, 1.0F)).
  - set
```
public void set(Vector3F sunDirectionWorld)
```
    Sets the sun and sky parameters.
    Calling this method is equivalent to set(sunDirectionWorld, 2.0F).
    If sunDirectionWorld is null, a NullPointerException will be thrown.
    
    Parameters:
    
    sunDirectionWorld - the sun direction in world-space
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, sunDirectionWorld is null
  - set
```
public void set(Vector3F sunDirectionWorld,
                float turbidity)
```
    Sets the sun and sky parameters.
    If sunDirectionWorld is null, a NullPointerException will be thrown.
    
    Parameters:
    
    sunDirectionWorld - the sun direction in world-space
    
    turbidity - the turbidity
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, sunDirectionWorld is null
  - setSunDirectionWorldX
```
public void setSunDirectionWorldX(float x)
```
    Sets the X-coordinate of the sun direction in world-space and updates the parameters.
    
    Parameters:
    
    x - the new X-coordinate
  - setSunDirectionWorldY
```
public void setSunDirectionWorldY(float y)
```
    Sets the Y-coordinate of the sun direction in world-space and updates the parameters.
    
    Parameters:
    
    y - the new Y-coordinate
  - setSunDirectionWorldZ
```
public void setSunDirectionWorldZ(float z)
```
    Sets the Z-coordinate of the sun direction in world-space and updates the parameters.
    
    Parameters:
    
    z - the new Z-coordinate
  - setTurbidity
```
public void setTurbidity(float turbidity)
```
    Sets the turbidity and updates the parameters.
    
    Parameters:
    
    turbidity - the new turbidity

Class Sky

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Sky

Method Detail

getSunColor

getOrthoNormalBasis

getSunOrigin

getSunDirection

getSunDirectionWorld

getZenithRelativeLuminance

getZenithX

getZenithY

getPerezRelativeLuminance

getPerezX

getPerezY

getJacobian

getTheta

getTurbidity

getColHistogram

getImageHistogram

getImageHistogramHeight

getImageHistogramWidth

getSamples

set

set

set

setSunDirectionWorldX

setSunDirectionWorldY

setSunDirectionWorldZ

setTurbidity