barsuift.simLife.environment
Interface Sun

All Superinterfaces:

Persistent<SunState>, Publisher

public interface Sun
extends Publisher, Persistent<SunState>

Class representing the sun.

Field Summary

static java.math.BigDecimal

ENERGY_DENSITY This is the energy provided by a 100% brightness sun on 1 m²

Method Summary

java.math.BigDecimal	getBrightness()
java.math.BigDecimal	getRiseAngle() Rise angle, in percent.
Sun3D	getSun3D()
java.math.BigDecimal	getZenithAngle() Zenith angle, in percent.
void	setBrightness(java.math.BigDecimal brightness)
void	setRiseAngle(java.math.BigDecimal riseAngle)
void	setZenithAngle(java.math.BigDecimal zenithAngle)

Methods inherited from interface barsuift.simLife.message.Publisher

addSubscriber, clearChanged, countSubscribers, deleteSubscriber, deleteSubscribers, hasChanged, notifySubscribers, notifySubscribers, setChanged

Methods inherited from interface barsuift.simLife.Persistent

getState, synchronize

Field Detail

ENERGY_DENSITY

static final java.math.BigDecimal ENERGY_DENSITY

This is the energy provided by a 100% brightness sun on 1 m²

Method Detail

getSun3D

Sun3D getSun3D()

getBrightness

java.math.BigDecimal getBrightness()

setBrightness

void setBrightness(java.math.BigDecimal brightness)
                   throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getRiseAngle

java.math.BigDecimal getRiseAngle()

Rise angle, in percent.

• 0 means sun is full east, lighting only along the X axis
• 50 means sun is at its zenith position (neither east nor west). no X direction
• 100 means sun is full west, lighting only along the reverted X axis

setRiseAngle

void setRiseAngle(java.math.BigDecimal riseAngle)

getZenithAngle

java.math.BigDecimal getZenithAngle()

Zenith angle, in percent.

• 0 means sun is always at the horizon
• 50 means sun is at 45° (Pi/4)
• 100 means sun is at its zenith position. no Z direction

setZenithAngle

void setZenithAngle(java.math.BigDecimal zenithAngle)