Module com.marginallyclever.ro3

Package com.marginallyclever.ro3.node.nodes.environment

Class Environment

java.lang.Object

com.marginallyclever.ro3.node.Node

com.marginallyclever.ro3.node.nodes.environment.Environment

public class Environment
extends Node

Environment controls external factors like the sun, the skybox, etc.

TODO use the OpenGL cube map texture?

Field Summary

Fields

Modifier and Type	Field	Description
Color	ambientColor
static final double	SUN_DISTANCE
Color	sunlightColor
final javax.vecmath.Vector3d	sunlightSource
final javax.vecmath.Vector3d	sunlightSourceNormalized
double	sunlightStrength

Fields inherited from class com.marginallyclever.ro3.node.Node

ICON

Constructor Summary

Constructors

Constructor	Description
Environment()
Environment(String name)

Method Summary

Modifier and Type	Method	Description
void	fromJSON(org.json.JSONObject from)	Deserialize this node and its children from a JSON object and its children.
Color	getAmbientColor()
void	getComponents(List<JPanel> list)	Build a Swing Component that represents this Node.
double	getDeclination()
ColorDouble	getEnvironmentColor(Ray ray)	Locate the Environment in the scene.
Icon	getIcon()	Set a custom icon for this node.
ColorDouble	getSkyColor(Ray ray)	sky or sun color, depending on angle of incidence
Mesh	getSkyMesh()
TextureWithMetadata	getSkyTexture()
Color	getSunlightColor()
javax.vecmath.Vector3d	getSunlightSource()
double	getSunlightStrength()
double	getTimeOfDay()
boolean	isSkyShapeIsSphere()
void	setAmbientColor(Color color)
void	setDeclination(double declination)
void	setSkyShapeIsSphere(boolean skyShapeIsSphere)
void	setSkyTexture(TextureWithMetadata skyTextureSource)
void	setSunlightColor(Color color)
void	setSunlightStrength(double strength)
void	setTimeOfDay(double timeOfDay)	0..360 (scale by 24/360 to get hours)
org.json.JSONObject	toJSON()	Serialize this node and its children to a JSON object and its children.

Methods inherited from class com.marginallyclever.ro3.node.Node

addAttachListener, addChild, addChild, addDetachListener, addReadyListener, addRenameListener, findByPath, findChild, findChild, findFirstChild, findFirstSibling, findNodeByID, findParent, findParent, getAbsolutePath, getChildren, getName, getParent, getRootNode, getUniqueID, hasChild, hasParent, isNameUsedBySibling, removeAttachListener, removeChild, removeDetachListener, removeReadyListener, removeRenameListener, setName, update, witnessProtection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

sunlightSource

public final javax.vecmath.Vector3d sunlightSource

sunlightSourceNormalized

public final javax.vecmath.Vector3d sunlightSourceNormalized

SUN_DISTANCE

public static final double SUN_DISTANCE

See Also:

• Constant Field Values

sunlightColor

public Color sunlightColor

sunlightStrength

public double sunlightStrength

ambientColor

public Color ambientColor

Constructor Details

Environment

public Environment()

Environment

public Environment(String name)

Method Details

toJSON

public org.json.JSONObject toJSON()

Description copied from class: Node

Serialize this node and its children to a JSON object and its children. Classes that override this method should call super.toJSON() first, then add to the object returned.

Overrides:

toJSON in class Node

Returns:

the JSON object.

fromJSON

public void fromJSON(org.json.JSONObject from)

Description copied from class: Node

Deserialize this node and its children from a JSON object and its children. Classes that override this method should call super.fromJSON(). When they do it will trigger the creation of child nodes. The child nodes will then call their own fromJSON() methods.

Overrides:

fromJSON in class Node

Parameters:

from - the JSON object to read from.

getSunlightColor

public Color getSunlightColor()

setSunlightColor

public void setSunlightColor(Color color)

getSunlightStrength

public double getSunlightStrength()

setSunlightStrength

public void setSunlightStrength(double strength)

getAmbientColor

public Color getAmbientColor()

setAmbientColor

public void setAmbientColor(Color color)

getSunlightSource

public javax.vecmath.Vector3d getSunlightSource()

getDeclination

public double getDeclination()

setDeclination

public void setDeclination(double declination)

getTimeOfDay

public double getTimeOfDay()

Returns:

0..360 (scale by 24/360 to get hours)

setTimeOfDay

public void setTimeOfDay(double timeOfDay)

0..360 (scale by 24/360 to get hours)

Parameters:

timeOfDay - 0..360

getComponents

public void getComponents(List<JPanel> list)

Description copied from class: Node

Build a Swing Component that represents this Node.

Overrides:

getComponents in class Node

Parameters:

list - the list to add components to.

getIcon

public Icon getIcon()

Description copied from class: Node

Set a custom icon for this node.

Overrides:

getIcon in class Node

Returns:

the icon, or null if none.

getSkyTexture

public TextureWithMetadata getSkyTexture()

setSkyTexture

public void setSkyTexture(TextureWithMetadata skyTextureSource)

isSkyShapeIsSphere

public boolean isSkyShapeIsSphere()

setSkyShapeIsSphere

public void setSkyShapeIsSphere(boolean skyShapeIsSphere)

getSkyMesh

public Mesh getSkyMesh()

getSkyColor

public ColorDouble getSkyColor(Ray ray)

sky or sun color, depending on angle of incidence

Parameters:

ray - the ray to check

Returns:

the color of the sky

getEnvironmentColor

public ColorDouble getEnvironmentColor(Ray ray)

Locate the Environment in the scene. If there is a texture assigned, look up the UV color. If there is no texture, return the sky/sun color.

Parameters:

ray - the ray to check

Returns:

the color of the environment